Get a collection's fields¶
GET /document-intelligence/v1/collections/{collection_id}/fields
The extraction schema for a collection: every field it pulls out of a document, with its type and settings. This is the schema; for the values extracted from one document, use GET /collections/{id}/documents/{document_id}/fields.
Parameters¶
| Name | In | Required | Notes |
|---|---|---|---|
collection_id |
path | yes | - |
Example¶
curl -X GET "https://api.futuresmart.ai/document-intelligence/v1/collections/{collection_id}/fields" \
-H "Authorization: Bearer $FS_API_KEY"
Responses¶
200
| Field | Type | Required | Notes |
|---|---|---|---|
fields |
array of FieldOut | yes | - |
Every failure, a malformed request included, comes back in the shared envelope with a stable code to branch on. See Errors.