Documents

Signal that a direct upload has finished

post/documents/{document_id}/complete

Request

  • Base URL: https://api.aginera.ai/partner/v1
  • URL: https://api.aginera.ai/partner/v1/documents/{document_id}/complete
  • 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)

Path parameters

document_idstring required
Example:doc_4kR9sT2vWx7yZa1bCd3eFg

Response

OK

idstring required
project_idstring required
filenamestring required
kind'drawing' | 'specification' | 'schedule' required
status'awaiting_upload' | 'ingesting' | 'ready' | 'failed' required
external_refstring nullable required
page_countinteger nullable required
size_bytesinteger nullable required
metadataobject required
created_atstring date-time required
ready_atstring date-time nullable required
retain_untilstring date-time nullable required

Example response

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

Changes

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