Add fields¶
POST /document-intelligence/v1/collections/{collection_id}/fields
Add new fields to a collection's extraction schema. Refuses if a field with the same name already exists — use PATCH to update an existing field.
Parameters¶
| Name | In | Required | Notes |
|---|---|---|---|
collection_id |
path | yes | - |
Request body¶
| Field | Type | Required | Notes |
|---|---|---|---|
fields |
array of FieldIn | yes | - |
Example¶
curl -X POST "https://api.futuresmart.ai/document-intelligence/v1/collections/{collection_id}/fields" \
-H "Authorization: Bearer $FS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"fields": [
{
"name": "<name>"
}
]
}'
Responses¶
201
| 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.