Summarizations
Submit Summarization
POST
Submit a Summarization. Pass documentId for an uploaded Document, or file to upload it in the same call. Returns 200 when the Summarization finishes within wait, 202 otherwise.
wait?WaitSeconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs.
Range
0 <= value <= 30Default
0idempotency_key?|Unique key that makes the creation at-most-once. Reusing it in the workspace returns 409.
x-workspace-id?|The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.
multipart/form-data- body
config?|The Summarization Config as JSON
documentId?|An uploaded Document
file?|A file to upload as a new Document
Successful Response
application/json- response
status?StatusDefault
"ok"data*{ "status": "ok", "data": { "id": "string", "workspaceId": "string", "createdAt": "string", "documentId": "string", "status": "idle", "credits": 0, "config": { "perimeter": "local", "parsing": { "tier": "fast", "pages": "string" }, "tier": "fast", "instructions": "string", "length": "short" }, "output": { "value": { "length": "short", "title": "string", "summary": "string" }, "truncated": false } }}