Documents

Add a drawing document (from a URL, or prepare a direct upload)

source.type = "url": Aginera fetches the file (HTTPS, ≤ 50 MB) and returns 202 with status "ingesting". source.type = "upload": returns 201 with a 15-minute upload URL; PUT the bytes, then call /documents/{id}/complete. Supported: PDF, DWG, DXF, PNG, JPEG.

post/documents

Request

  • Base URL: https://api.aginera.ai/partner/v1
  • URL: https://api.aginera.ai/partner/v1/documents
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.aginera.ai/oauth/authorize, token URL https://auth.aginera.ai/oauth/token; client credentials, token URL https://login.microsoftonline.com/65f567a9-6e6a-4f81-863c-aea4ece1f8eb/oauth2/v2.0/token, scopes: documents:write)

Headers

Idempotency-Keystring

Replays within 24 hours return the original response.

Request body

project_idstring required
filenamestring required
kind'drawing' | 'specification' | 'schedule'
discipline_hint'electrical' | 'mechanical' | 'plumbing' | 'fire_protection' | 'process' | 'structural' | 'multi_discipline'
external_refstring

Your own identifier for this resource; unique per tenant.

metadataMetadata

Example request

{
  "project_id": "prj_4kR9sT2vWx7yZa1bCd3eFg"
}

Response

OK

OR

Example response

{
  "document": {
    "id": "doc_4kR9sT2vWx7yZa1bCd3eFg",
    "project_id": "prj_4kR9sT2vWx7yZa1bCd3eFg"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.