Create a metadata expansion job
Queue metadata extraction for a batch of documents; each document is processed independently.
AuthorizationBearer <token>OpenAI-Organization?|Organization Id from OpenAi compatible endpoint. Required to organization access or project access (with OpenAI-Project header) when logged as User or Admin User.
OpenAI-Project?|Project Id from OpenAi compatible endpoint. Required to project access for organization api key or User / Admin User access with OpenAI-Organization
application/json- body
Request body for creating a metadata expansion job.
document_ids*array<>File IDs of the documents to process.
1 <= items <= 1000fields*array<>Metadata fields to extract from each document. Descriptions are limited to 500 characters.
1 <= items <= 50image_processing_mode?ImageProcessingModeHow images are handled when a document needs fallback conversion. Applies to every document in the job.
"ignore""ignore""description"Successful Response
application/json- response
A metadata expansion job — extracts the requested fields from each of its documents.
id*stringThe job identifier, which can be referenced in the API endpoints.
^[0-9a-fA-F]{24}$project_id*stringThe project identifier this job belongs to.
^[0-9a-fA-F]{24}$status*MetadataExpansionJobStatusAggregate status across all documents in the job. 'completed' covers partial failures too — check each document's own status for details; 'failed' is only set when every document in the job failed; 'cancelled' is a terminal state set by the caller and is never resumed.
"pending""processing""completed""failed""paused""cancelled"fields*array<>Metadata fields requested for this job.
documents*array<>Per-document status and extracted metadata.
describe_images?booleanWhether image descriptions were requested at job creation; applies to every document in the job.
falsecreated_at?integerThe Unix timestamp (in seconds) for when the job was created.
finished_at?|The Unix timestamp (in seconds) for when every document reached a terminal state.
curl -X POST 'https://deepfellow-server-host/v1/metadata/expand' \ -H 'Content-Type: application/json' \ -d '{ "document_ids": [ "5eb7cf5a86d9755df3a6c593" ], "fields": [ { "name": "string" } ]}'{ "id": "5eb7cf5a86d9755df3a6c593", "project_id": "5eb7cf5a86d9755df3a6c593", "status": "pending", "fields": [ { "name": "string", "description": "string" } ], "documents": [ { "document_id": "5eb7cf5a86d9755df3a6c593", "status": "pending", "extracted": { "property1": "string", "property2": "string" }, "error": "string", "attempts": 0 } ], "describe_images": false, "created_at": 0, "finished_at": 0}We use cookies on our website. We use them to ensure proper functioning of the site and, if you agree, for purposes such as analytics, marketing, and targeting ads.