API reference

Interactive OpenAPI reference for the Takeoff & Estimation REST API, generated from the live contract.

The reference below is loaded from the API itself, so it always matches the deployed contract. Use Authorize with an access token to try calls against your sandbox.

OpenAPI JSONYAMLOpen full-screen

Conventions at a glance

  • IDs are opaque and prefixed: prj_, doc_, tko_, itm_, rte_, sch_, exp_.
  • Pagination: ?limit= (max 200) and cursor; responses carry next_cursor and has_more.
  • Idempotency: send Idempotency-Key on creates; replays within 24 hours return the original response with Idempotent-Replayed: true.
  • Errors: application/problem+json with a stable code (invalid_request, insufficient_credits, rate_limited, …).
  • Rate limits: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset on every response; Retry-After on 429.