API referenceExtractions
Attach existing documents to a project
POST
/extractions/{id}/documentsLink already-uploaded public documents to the project by id and/or exact file name. Provide at least one of documentIds / documentNames. documentNames match the stored fileName (without extension); a name that resolves to zero or multiple documents is skipped and reported (partial success). Optional dataGroupIds narrows the link to a subset of the project model’s subtopics (defaults to all of them).
Requires an API key with one of these roles: admin, editor.
Authorization
bearerAuth AuthorizationBearer <token>
An API key created in Settings → API Keys.
In: header
Path Parameters
id*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/extractions/497f6eca-6276-4993-bfeb-53cbbbba6f08/documents" \ -H "Content-Type: application/json" \ -d '{ "documentIds": [ "2c049485-836c-4789-bec1-8a3d53fe6852" ] }'{ "data": { "attachedCount": 0, "results": [ { "input": "string", "kind": "id", "status": "attached", "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052" } ] }, "meta": { "requestId": "string", "timestamp": "string" }}