Contract Intelligence

Add a document to a vault

Upload one document into a Contract Intelligence vault as multipart form data. The document is stored, its text is extracted, and it is then scanned against the vault's columns, so its extracted fields appear in the vault View a few minutes later.

Vaults accept a narrower set of formats than the rest of GC AI: PDF, Word (.doc, .docx), and plain text (.txt). Scanned and image-based PDFs are supported through OCR. Spreadsheets, presentations, standalone images, and email files are rejected.

Requires the editor or owner role in the vault and the organization-level permission to manage vaults; a caller with the role but not the permission gets 403. A vault that has reached its document capacity or whose organization has no remaining allowance returns 409 with the same message the app shows, and stores nothing. While a vault is still in guided setup, documents are stored and scanned once setup finishes.

Requires a user-scoped API key (u:gcai_...). A vault is shared with named people, so an organization-scoped key has no identity to resolve vault access with.

post/vaults/{id}/documents

Request

Path parameters

idstring uuid required

The vault ID

Request body multipart/form-data

filestring binary required

The document to add to the vault. PDF, Word (.doc/.docx), and plain text (.txt) only.

Response

Document added to the vault

idstring uuid required

Unique file identifier for the uploaded document. Poll GET /files/{id} until status is ready.

vault_idstring uuid required

The vault the document was added to

namestring required

Original filename

sizenumber required

File size in bytes

content_typestring required

MIME type of the document

status'extracting' | 'embedding' | 'ready' | 'failed' required

Text-extraction status of the document

created_atstring required

ISO 8601 creation timestamp

Example response

{
  "content_type": "application/pdf"
}

Changes

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