Takeoffs

Start a takeoff on a document

Places a credit hold for the maximum plausible cost (estimated_credits) and queues the job. The final charge never exceeds the hold. 402 insufficient_credits if the hold cannot be placed.

post/takeoffs

Request

  • Base URL: https://api.aginera.ai/partner/v1
  • URL: https://api.aginera.ai/partner/v1/takeoffs
  • 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: takeoffs:run)

Headers

Idempotency-Keystring

Replays within 24 hours return the original response.

Request body

document_idstring required
discipline'electrical' | 'mechanical' | 'plumbing' | 'fire_protection' | 'process' | 'structural' | 'multi_discipline' required
pagesinteger[]

1-based page numbers. Omit for all pages.

scope'full' | 'pages'
external_refstring

Your own identifier for this resource; unique per tenant.

metadataMetadata

Example request

{
  "document_id": "doc_4kR9sT2vWx7yZa1bCd3eFg"
}

Response

OK

idstring required
document_idstring required
project_idstring required
discipline'electrical' | 'mechanical' | 'plumbing' | 'fire_protection' | 'process' | 'structural' | 'multi_discipline' required
status'queued' | 'processing' | 'completed' | 'failed' | 'cancelled' required
external_refstring nullable required
queue_positioninteger
origin'api' | 'web_app'

api = started through the API or an agent; web_app = a completed extraction run in the Aginera web app (read-only here; credits were billed by the app, so estimated_credits and credits_charged are 0).

pages_requestedinteger required
estimated_creditsnumber required

Maximum that will be charged; the final charge never exceeds it.

metadataobject required
created_atstring date-time required
started_atstring date-time nullable required
completed_atstring date-time nullable required

Example response

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

Changes

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