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.
Request
- Base URLhttps://app.gc.ai/api/external/v1
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The vault ID
Request body multipart/form-data
Response
Document added to the vault
Example response
{
"content_type": "application/pdf"
}Changes
No recorded changes to this operation across all 1 revision of this API.