> ## Documentation Index > Fetch the complete documentation index at: https://docs.trycactus.com/llms.txt > Use this file to discover all available pages before exploring further. # Register a document and get a presigned upload URL > Creates a document record and returns a short-lived presigned URL. Upload the file bytes with a `PUT` to `upload.url` including `upload.headers`. The document becomes `uploaded` once the object lands; it is validated (and billed) only when submitted to an extraction or underwriting. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v1/documents openapi: 3.1.0 info: title: Cactus Partner API version: 1.0.0-draft.1 summary: Document extraction and automated underwriting for CRE. description: | # Overview The Cactus Partner API provides two products: - **Extraction** — upload commercial real estate documents (offering memoranda, rent rolls, T-12 / operating statements, and other business documents) and receive structured, validated JSON with per-field confidence. - **Underwriting** — provide a property address, asset class, and notification email (documents optional) to run a full automated underwriting; results are delivered as a hosted financial-analysis report link plus a machine-readable summary. ## Authentication Every request carries an API key: `Authorization: Bearer ck_live_...` (or `ck_sandbox_...`). Keys are issued by Cactus at kickoff, are scoped per product, and can be rotated or revoked at any time. ## Sandbox `ck_sandbox_` keys hit the same endpoints but never debit your usage pool: uploads are accepted, and jobs return deterministic fixture output within seconds. Use sandbox keys for integration development and CI. ## Asynchronous jobs Extractions and underwritings are asynchronous. Create the job (`202 Accepted`), then either poll the job resource or register a webhook endpoint to receive signed events (recommended). Typical extraction turnaround is minutes. ## Billing semantics A document is **accepted** when it passes validation (size caps, page/row counts, type resolution). Acceptance debits your usage pool at the fixed rate-card price for the document type — before processing, so pricing is deterministic. Rejected documents are never charged. Documents exceeding their type's size cap bill as multiple units of the same type; the accept response discloses `billed.units`. Files over 500 pages or 100 MB are rejected outright. ## Idempotency All `POST` endpoints accept an `Idempotency-Key` header (any unique string, e.g. a UUID). Retrying a request with the same key returns the original response instead of creating a duplicate. ## Errors Errors follow RFC 9457 (`application/problem+json`) and always include a stable machine-readable `code` and the `request_id` to quote in support requests. ## Versioning The path major version (`/v1`) changes only for breaking API changes. Extraction output schemas are versioned independently per document type (e.g. `rent_roll.v1`) and declared in every result; breaking output changes ship as a new schema version with advance notice and an overlap window. --- All field-level output schemas — `RentRollData` (`rent_roll.v1`), `T12Data` (`t12.v1`), `OfferingMemorandumData` (`offering_memorandum.v1`), and `GenericDocumentData` (`facts.v1`) — are finalized against the extraction engine's real output. contact: name: Cactus API Support email: api@trycactus.com license: name: Proprietary — Cactus API License Agreement identifier: LicenseRef-Cactus-Partner-Agreement servers: - url: https://api.trycactus.com description: Production (live and sandbox keys) security: - apiKey: [] tags: - name: Documents description: Upload and manage documents via presigned URLs. - name: Extractions description: Structured data extraction jobs and results. - name: Underwritings description: Automated underwriting runs. - name: Usage description: Usage pool balance and metered activity. - name: Webhook Endpoints description: Manage endpoints that receive signed event notifications. paths: /v1/documents: post: tags: - Documents summary: Register a document and get a presigned upload URL description: | Creates a document record and returns a short-lived presigned URL. Upload the file bytes with a `PUT` to `upload.url` including `upload.headers`. The document becomes `uploaded` once the object lands; it is validated (and billed) only when submitted to an extraction or underwriting. operationId: createDocument parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DocumentCreateRequest' responses: '201': description: Document created; upload URL issued. headers: Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/DocumentWithUpload' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/RateLimited' components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false schema: type: string maxLength: 255 description: Unique key making the request safely retryable. schemas: DocumentCreateRequest: type: object required: - filename - declared_type - byte_size properties: filename: type: string example: 125-main-st-rent-roll.xlsx declared_type: $ref: '#/components/schemas/DocumentType' byte_size: type: integer description: Exact size of the file in bytes (max 100 MB). maximum: 104857600 content_type: type: string example: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet metadata: type: object additionalProperties: type: string maxProperties: 20 description: >- Free-form partner tags, echoed back on the document and in webhook events. DocumentWithUpload: allOf: - $ref: '#/components/schemas/Document' - type: object required: - upload properties: upload: type: object required: - url - method - expires_at properties: url: type: string format: uri description: Presigned S3 URL. method: type: string const: PUT headers: type: object additionalProperties: type: string description: Headers that must accompany the upload. expires_at: type: string format: date-time DocumentType: type: string description: > Declared/resolved document type; determines the rate-card price and the output schema family. enum: - offering_memorandum - rent_roll - t12 - other_standard - other_complex Document: type: object required: - id - object - filename - declared_type - status - created_at properties: id: type: string example: doc_01J9ZJXV object: type: string const: document filename: type: string declared_type: $ref: '#/components/schemas/DocumentType' resolved_type: oneOf: - $ref: '#/components/schemas/DocumentType' - type: 'null' description: >- Type verified during acceptance; set once the document is submitted to a job. byte_size: type: integer status: $ref: '#/components/schemas/DocumentStatus' metadata: type: object additionalProperties: type: string created_at: type: string format: date-time Problem: type: object description: RFC 9457 problem details. required: - title - status - code - request_id properties: type: type: string format: uri example: https://docs.trycactus.com/errors/document_over_size_cap title: type: string example: Document exceeds the size limit status: type: integer example: 422 detail: type: string example: Files over 500 pages or 100 MB are rejected and not charged. code: type: string description: Stable machine-readable error code. example: document_over_size_cap request_id: type: string errors: type: array description: Field-level validation errors, when applicable. items: type: object properties: field: type: string code: type: string message: type: string DocumentStatus: type: string enum: - pending_upload - uploaded - deleted headers: RequestId: description: Unique request identifier; quote in support requests. schema: type: string responses: BadRequest: description: Malformed request. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' Unauthorized: description: Missing, invalid, or revoked API key. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' RateLimited: description: Rate limit exceeded. headers: Retry-After: schema: type: integer description: Seconds to wait before retrying. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' securitySchemes: apiKey: type: http scheme: bearer bearerFormat: ck_live_* or ck_sandbox_* description: Partner API key issued by Cactus. ````