Skip to content

Reference

Every endpoint in v1. These pages are generated from the API's own OpenAPI spec, so they cannot drift from what the code accepts.

The spec itself is at https://api.futuresmart.ai/document-intelligence/openapi.json if you would rather generate a client.

This section says what each call takes and returns. It does not say what order to call them in -- an OpenAPI spec has no way to express that. For sequence, read the Quickstart and the guides.

Endpoint What it does
POST /document-intelligence/v1/collections/{collection_id}/documents Add documents
GET /document-intelligence/v1/collections/{collection_id}/documents List documents
POST /document-intelligence/v1/collections/{collection_id}/documents/files Upload document files
POST /document-intelligence/v1/collections/{collection_id}/documents/upload-urls Get upload URLs
GET /document-intelligence/v1/collections/{collection_id}/documents/{document_id}/fields Get extracted fields
DELETE /document-intelligence/v1/collections/{collection_id}/documents/{document_id} Delete a document
GET /document-intelligence/v1/collections/{collection_id}/fields Get a collection's fields
POST /document-intelligence/v1/collections/{collection_id}/fields Add fields
PATCH /document-intelligence/v1/collections/{collection_id}/fields Update or add fields
PUT /document-intelligence/v1/collections/{collection_id}/fields Replace the custom fields
DELETE /document-intelligence/v1/collections/{collection_id}/fields Remove fields
GET /document-intelligence/v1/jobs/{job_id} Get a job
POST /document-intelligence/v1/collections/{collection_id}/search Search a collection
POST /document-intelligence/v1/collections/{collection_id}/chat Ask a question