Takeoffs

List takeoffs

Newest first. Includes takeoffs started through the API/MCP and completed extractions the user ran in the Aginera web app (origin "web_app", read-only; their items, routes, schedules and exports are read with the same tko_ id). Filter by project_id, document_id, status; paginate with cursor. An external_ref filter matches API-created takeoffs only.

get/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:read)

Query parameters

limitinteger
cursorstring
document_idstring
Example:doc_4kR9sT2vWx7yZa1bCd3eFg
project_idstring
Example:prj_4kR9sT2vWx7yZa1bCd3eFg
status'queued' | 'processing' | 'completed' | 'failed' | 'cancelled'
external_refstring

Response

OK

next_cursorstring nullable required
has_moreboolean required

Example response

{
  "data": [
    {
      "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.