{"openapi":"3.1.0","info":{"title":"Axelered IDP API","version":"2026.0.0"},"servers":[{"url":"https://api.axelered.com/v1","description":"Production server"}],"paths":{"/health":{"get":{"tags":["system"],"summary":"Health Check","description":"Verify that the server is operational and all dependencies are reachable.","operationId":"api_health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_HealthStatus_"}}}},"503":{"description":"Service Unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_HealthStatus_"}}}}}}},"/admin/workspaces":{"get":{"tags":["admin"],"summary":"List Workspaces","description":"Retrieve a paginated list of all available workspaces.","operationId":"api_list_admin_workspaces_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_CursorPage_Workspace__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["admin"],"summary":"Create Workspace","description":"Create a new workspace with the specified name and optional configuration.","operationId":"api_create_admin_workspaces_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Workspace_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/admin/workspaces/{workspace_id}":{"get":{"tags":["admin"],"summary":"Read Workspace","description":"Retrieve detailed information about a specific workspace by its unique ID.","operationId":"api_read_admin_workspaces__workspace_id__get","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Workspace_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["admin"],"summary":"Update Workspace","description":"Perform a partial update of a workspace.","operationId":"api_update_admin_workspaces__workspace_id__patch","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Workspace_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["admin"],"summary":"Delete Workspace","description":"Soft-delete a workspace. The workspace will be hidden from listings but can be undeleted.","operationId":"api_delete_admin_workspaces__workspace_id__delete","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEmptyResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/admin/workspaces/{workspace_id}/undelete":{"put":{"tags":["admin"],"summary":"Undelete Workspace","description":"Restore a previously soft-deleted workspace.","operationId":"api_undelete_admin_workspaces__workspace_id__undelete_put","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Workspace_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/admin/keys":{"get":{"tags":["admin"],"summary":"List Global API Keys","description":"List all global (server-wide) durable API keys.","operationId":"api_list_global_admin_keys_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_CursorPage_AuthToken__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["admin"],"summary":"Create Global API Key","description":"Issue a new global (server-wide) durable API key.","operationId":"api_create_global_admin_keys_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_TokenCreateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/admin/keys/{key_id}":{"delete":{"tags":["admin"],"summary":"Delete Global API Key","description":"Revoke a global API key. This action cannot be undone.","operationId":"api_delete_global_admin_keys__key_id__delete","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Key Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEmptyResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/workspace":{"get":{"tags":["workspace"],"summary":"Read Current Workspace","description":"Read the workspace of the request.","operationId":"api_read_current_workspace_get","parameters":[{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Workspace_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["workspace"],"summary":"Update Current Workspace","description":"Perform a partial update of the workspace of the request.","operationId":"api_update_current_workspace_patch","parameters":[{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Workspace_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/keys":{"get":{"tags":["auth"],"summary":"List API Keys","description":"List all durable API keys present in the workspace.","operationId":"api_list_keys_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_CursorPage_AuthToken__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["auth"],"summary":"Create API Key","description":"Issue a workspace token. Durable by default, or temporary when requested.","operationId":"api_create_keys_post","parameters":[{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/TokenCreateRequest"},{"$ref":"#/components/schemas/TokenTemporaryCreationRequest"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_TokenCreateResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/keys/{key_id}":{"delete":{"tags":["auth"],"summary":"Delete API Key","description":"Revoke a workspace token. This action cannot be undone.","operationId":"api_delete_keys__key_id__delete","parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Key Id"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEmptyResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/documents":{"post":{"tags":["documents"],"summary":"Upload Document","description":"Upload a file as a new document. The document expires 30 days after upload.","operationId":"api_create_documents_post","parameters":[{"name":"idempotency_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9_\\-]{8,255}$"},{"type":"null"}],"description":"Unique key that makes the creation at-most-once. Reusing it in the workspace returns 409.","title":"Idempotency Key"},"description":"Unique key that makes the creation at-most-once. Reusing it in the workspace returns 409."},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_api_create_documents_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Document_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["documents"],"summary":"List Documents","description":"List the documents of the workspace, newest first.","operationId":"api_list_documents_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_CursorPage_Document__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/documents/{document_id}":{"get":{"tags":["documents"],"summary":"Read Document","description":"Read the metadata of a document.","operationId":"api_read_documents__document_id__get","parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Document Id"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Document_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["documents"],"summary":"Update Document","description":"Update the name of a document. The file itself cannot change.","operationId":"api_update_documents__document_id__patch","parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Document Id"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Document_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["documents"],"summary":"Delete Document","description":"Delete a document. It is hidden immediately and removed with its files shortly after.","operationId":"api_delete_documents__document_id__delete","parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Document Id"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEmptyResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/documents/{document_id}/original":{"get":{"tags":["documents"],"summary":"Download Document","description":"Download the original file of a document.","operationId":"api_original_documents__document_id__original_get","parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Document Id"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/parsings":{"post":{"tags":["parsings"],"summary":"Submit Parsing","description":"Submit a Parsing. Pass `documentId` for an uploaded Document, or `file` to upload it in the same call. Returns 200 when the Parsing finishes within `wait`, 202 otherwise.","operationId":"api_create_parsings_post","parameters":[{"name":"wait","in":"query","required":false,"schema":{"type":"number","maximum":30,"minimum":0,"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs.","default":0,"title":"Wait"},"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs."},{"name":"idempotency_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9_\\-]{8,255}$"},{"type":"null"}],"description":"Unique key that makes the creation at-most-once. Reusing it in the workspace returns 409.","title":"Idempotency Key"},"description":"Unique key that makes the creation at-most-once. Reusing it in the workspace returns 409."},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_api_create_parsings_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Parsing_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["parsings"],"summary":"List Parsings","description":"List the Parsings of the workspace, newest first, optionally for one Document.","operationId":"api_list_parsings_get","parameters":[{"name":"documentId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Documentid"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_CursorPage_Parsing__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/parsings/{job_id}":{"get":{"tags":["parsings"],"summary":"Read Parsing","description":"Read a Parsing. With `wait`, long-poll until it finishes: 200 when done or failed, 202 while it runs.","operationId":"api_read_parsings__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"wait","in":"query","required":false,"schema":{"type":"number","maximum":30,"minimum":0,"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs.","default":0,"title":"Wait"},"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs."},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Parsing_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["parsings"],"summary":"Delete Parsing","description":"Delete a Parsing. Its Document is kept.","operationId":"api_delete_parsings__job_id__delete","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEmptyResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/parsings/{job_id}/output":{"get":{"tags":["parsings"],"summary":"Read Parsing Output","description":"The Parsed Document of a done Parsing, as markdown, text, html or json.","operationId":"api_output_parsings__job_id__output_get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"format","in":"query","required":false,"schema":{"enum":["json","markdown","text","html"],"type":"string","description":"Output format","default":"markdown","title":"Format"},"description":"Output format"},{"name":"include_images","in":"query","required":false,"schema":{"type":"boolean","description":"Embed images, or replace them with a placeholder","default":true,"title":"Include Images"},"description":"Embed images, or replace them with a placeholder"},{"name":"include_bbox","in":"query","required":false,"schema":{"type":"boolean","description":"Keep the bounding boxes of the blocks (json only)","default":true,"title":"Include Bbox"},"description":"Keep the bounding boxes of the blocks (json only)"},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/summarizations":{"post":{"tags":["summarizations"],"summary":"Submit Summarization","description":"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.","operationId":"api_create_summarizations_post","parameters":[{"name":"wait","in":"query","required":false,"schema":{"type":"number","maximum":30,"minimum":0,"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs.","default":0,"title":"Wait"},"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs."},{"name":"idempotency_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9_\\-]{8,255}$"},{"type":"null"}],"description":"Unique key that makes the creation at-most-once. Reusing it in the workspace returns 409.","title":"Idempotency Key"},"description":"Unique key that makes the creation at-most-once. Reusing it in the workspace returns 409."},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_api_create_summarizations_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Summarization_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["summarizations"],"summary":"List Summarizations","description":"List the Summarizations of the workspace, newest first, optionally for one Document.","operationId":"api_list_summarizations_get","parameters":[{"name":"documentId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Documentid"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_CursorPage_Summarization__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/summarizations/{job_id}":{"get":{"tags":["summarizations"],"summary":"Read Summarization","description":"Read a Summarization. With `wait`, long-poll until it finishes: 200 when done or failed, 202 while it runs.","operationId":"api_read_summarizations__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"wait","in":"query","required":false,"schema":{"type":"number","maximum":30,"minimum":0,"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs.","default":0,"title":"Wait"},"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs."},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Summarization_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["summarizations"],"summary":"Delete Summarization","description":"Delete a Summarization. Its Document is kept.","operationId":"api_delete_summarizations__job_id__delete","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEmptyResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/classifications":{"post":{"tags":["classifications"],"summary":"Submit Classification","description":"Submit a Classification. Pass `documentId` for an uploaded Document, or `file` to upload it in the same call. Returns 200 when the Classification finishes within `wait`, 202 otherwise.","operationId":"api_create_classifications_post","parameters":[{"name":"wait","in":"query","required":false,"schema":{"type":"number","maximum":30,"minimum":0,"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs.","default":0,"title":"Wait"},"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs."},{"name":"idempotency_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9_\\-]{8,255}$"},{"type":"null"}],"description":"Unique key that makes the creation at-most-once. Reusing it in the workspace returns 409.","title":"Idempotency Key"},"description":"Unique key that makes the creation at-most-once. Reusing it in the workspace returns 409."},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_api_create_classifications_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Classification_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["classifications"],"summary":"List Classifications","description":"List the Classifications of the workspace, newest first, optionally for one Document.","operationId":"api_list_classifications_get","parameters":[{"name":"documentId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Documentid"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_CursorPage_Classification__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/classifications/{job_id}":{"get":{"tags":["classifications"],"summary":"Read Classification","description":"Read a Classification. With `wait`, long-poll until it finishes: 200 when done or failed, 202 while it runs.","operationId":"api_read_classifications__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"wait","in":"query","required":false,"schema":{"type":"number","maximum":30,"minimum":0,"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs.","default":0,"title":"Wait"},"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs."},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Classification_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["classifications"],"summary":"Delete Classification","description":"Delete a Classification. Its Document is kept.","operationId":"api_delete_classifications__job_id__delete","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEmptyResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/extractions":{"post":{"tags":["extractions"],"summary":"Submit Extraction","description":"Submit an Extraction. Pass `documentId` for an uploaded Document, or `file` to upload it in the same call. Returns 200 when the Extraction finishes within `wait`, 202 otherwise.","operationId":"api_create_extractions_post","parameters":[{"name":"wait","in":"query","required":false,"schema":{"type":"number","maximum":30,"minimum":0,"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs.","default":0,"title":"Wait"},"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs."},{"name":"idempotency_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[A-Za-z0-9_\\-]{8,255}$"},{"type":"null"}],"description":"Unique key that makes the creation at-most-once. Reusing it in the workspace returns 409.","title":"Idempotency Key"},"description":"Unique key that makes the creation at-most-once. Reusing it in the workspace returns 409."},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_api_create_extractions_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Extraction_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["extractions"],"summary":"List Extractions","description":"List the Extractions of the workspace, newest first, optionally for one Document.","operationId":"api_list_extractions_get","parameters":[{"name":"documentId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Documentid"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_CursorPage_Extraction__"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/extractions/{job_id}":{"get":{"tags":["extractions"],"summary":"Read Extraction","description":"Read an Extraction. With `wait`, long-poll until it finishes: 200 when done or failed, 202 while it runs.","operationId":"api_read_extractions__job_id__get","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"wait","in":"query","required":false,"schema":{"type":"number","maximum":30,"minimum":0,"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs.","default":0,"title":"Wait"},"description":"Seconds to wait for the Job to finish. 200 when it is done or failed, 202 while it runs."},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResult_Extraction_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["extractions"],"summary":"Delete Extraction","description":"Delete an Extraction. Its Document is kept.","operationId":"api_delete_extractions__job_id__delete","parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Job Id"}},{"name":"x-workspace-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones.","title":"X-Workspace-Id"},"description":"The Workspace to act on. Required for the Root Key and global API Keys, optional for bound ones."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEmptyResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AuthToken":{"properties":{"id":{"type":"string","title":"Id","description":"Authentication key identifier"},"createdAt":{"type":"string","title":"Createdat"},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifiedat"},"workspaceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workspaceid","description":"Key workspace identifier"},"issuerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuerid","description":"Key issuer key"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Optional key name"},"expiredAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expiredat","description":"Optional key expiration time"},"type":{"$ref":"#/components/schemas/AuthTokenType","default":"stored"}},"additionalProperties":false,"type":"object","required":["workspaceId","issuerId"],"title":"AuthToken","description":"API Key entity. The authentication mechanism leverages AuthToken.id\nas a primary index for fast lookup and caching."},"AuthTokenType":{"type":"string","enum":["root","ephemeral","stored"],"title":"AuthTokenType"},"Body_api_create_classifications_post":{"properties":{"config":{"type":"string","contentMediaType":"application/json","contentSchema":{"$ref":"#/components/schemas/ClassificationConfig"},"title":"Config","description":"The Classification Config as JSON"},"documentId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Documentid","description":"An uploaded Document"},"file":{"anyOf":[{"type":"string","contentMediaType":"application/octet-stream"},{"type":"null"}],"title":"File","description":"A file to upload as a new Document"}},"type":"object","required":["config"],"title":"Body_api_create_classifications_post"},"Body_api_create_documents_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File","description":"The file to upload"},"name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Name","description":"Defaults to the filename"}},"type":"object","required":["file"],"title":"Body_api_create_documents_post"},"Body_api_create_extractions_post":{"properties":{"config":{"type":"string","contentMediaType":"application/json","contentSchema":{"$ref":"#/components/schemas/ExtractionConfig"},"title":"Config","description":"The Extraction Config as JSON"},"documentId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Documentid","description":"An uploaded Document"},"file":{"anyOf":[{"type":"string","contentMediaType":"application/octet-stream"},{"type":"null"}],"title":"File","description":"A file to upload as a new Document"}},"type":"object","required":["config"],"title":"Body_api_create_extractions_post"},"Body_api_create_parsings_post":{"properties":{"config":{"anyOf":[{"type":"string","contentMediaType":"application/json","contentSchema":{"$ref":"#/components/schemas/ParsingJobConfig"}},{"type":"null"}],"title":"Config","description":"The Parsing Config as JSON"},"documentId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Documentid","description":"An uploaded Document"},"file":{"anyOf":[{"type":"string","contentMediaType":"application/octet-stream"},{"type":"null"}],"title":"File","description":"A file to upload as a new Document"}},"type":"object","title":"Body_api_create_parsings_post"},"Body_api_create_summarizations_post":{"properties":{"config":{"anyOf":[{"type":"string","contentMediaType":"application/json","contentSchema":{"$ref":"#/components/schemas/SummarizationConfig"}},{"type":"null"}],"title":"Config","description":"The Summarization Config as JSON"},"documentId":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Documentid","description":"An uploaded Document"},"file":{"anyOf":[{"type":"string","contentMediaType":"application/octet-stream"},{"type":"null"}],"title":"File","description":"A file to upload as a new Document"}},"type":"object","title":"Body_api_create_summarizations_post"},"Classification":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the LLM configuration"},"workspaceId":{"type":"string","title":"Workspaceid","description":"The ID of the workspace this configuration belongs to"},"createdAt":{"type":"string","title":"Createdat"},"documentId":{"type":"string","title":"Documentid","description":"The Document this Job processes"},"status":{"$ref":"#/components/schemas/RunnableStatus","description":"queued, running, done or failed"},"credits":{"type":"integer","title":"Credits","description":"Credits charged for this Job, set when it is done"},"config":{"$ref":"#/components/schemas/ClassificationConfig","description":"The Classification Config, as submitted"},"output":{"anyOf":[{"$ref":"#/components/schemas/OperationOutput_DocumentClassifyOutput_"},{"type":"null"}],"description":"The output of a done Classification, not included in lists"}},"type":"object","required":["workspaceId","documentId","status","credits","config"],"title":"Classification"},"ClassificationConfig":{"properties":{"perimeter":{"type":"string","enum":["local","external"],"title":"Perimeter","description":"`local` keeps the data inside our infrastructure, `external` allows third-party providers","default":"external"},"parsing":{"$ref":"#/components/schemas/ParsingConfig","description":"How the Operation parses the Document"},"tier":{"type":"string","enum":["fast","accurate"],"title":"Tier","description":"`fast` runs on a cheaper language model, `accurate` on a stronger one","default":"fast"},"instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instructions","description":"Additional instructions for the model"},"categories":{"items":{"$ref":"#/components/schemas/DocumentClass"},"type":"array","minItems":1,"title":"Categories","description":"The categories to choose from"},"allowEmpty":{"type":"boolean","title":"Allowempty","description":"Whether the Classification may return no category","default":true}},"additionalProperties":false,"type":"object","required":["categories"],"title":"ClassificationConfig"},"CursorPage_AuthToken_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AuthToken"},"type":"array","title":"Items"},"limit":{"type":"integer","title":"Limit","description":"Number of items per page"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor for the next page. None if end of list."},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Total items"}},"additionalProperties":false,"type":"object","required":["items","limit","cursor","total"],"title":"CursorPage[AuthToken]"},"CursorPage_Classification_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Classification"},"type":"array","title":"Items"},"limit":{"type":"integer","title":"Limit","description":"Number of items per page"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor for the next page. None if end of list."},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Total items"}},"additionalProperties":false,"type":"object","required":["items","limit","cursor","total"],"title":"CursorPage[Classification]"},"CursorPage_Document_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Document"},"type":"array","title":"Items"},"limit":{"type":"integer","title":"Limit","description":"Number of items per page"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor for the next page. None if end of list."},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Total items"}},"additionalProperties":false,"type":"object","required":["items","limit","cursor","total"],"title":"CursorPage[Document]"},"CursorPage_Extraction_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Extraction"},"type":"array","title":"Items"},"limit":{"type":"integer","title":"Limit","description":"Number of items per page"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor for the next page. None if end of list."},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Total items"}},"additionalProperties":false,"type":"object","required":["items","limit","cursor","total"],"title":"CursorPage[Extraction]"},"CursorPage_Parsing_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Parsing"},"type":"array","title":"Items"},"limit":{"type":"integer","title":"Limit","description":"Number of items per page"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor for the next page. None if end of list."},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Total items"}},"additionalProperties":false,"type":"object","required":["items","limit","cursor","total"],"title":"CursorPage[Parsing]"},"CursorPage_Summarization_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Summarization"},"type":"array","title":"Items"},"limit":{"type":"integer","title":"Limit","description":"Number of items per page"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor for the next page. None if end of list."},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Total items"}},"additionalProperties":false,"type":"object","required":["items","limit","cursor","total"],"title":"CursorPage[Summarization]"},"CursorPage_Workspace_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Workspace"},"type":"array","title":"Items"},"limit":{"type":"integer","title":"Limit","description":"Number of items per page"},"cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor","description":"Cursor for the next page. None if end of list."},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Total items"}},"additionalProperties":false,"type":"object","required":["items","limit","cursor","total"],"title":"CursorPage[Workspace]"},"Document":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the LLM configuration"},"workspaceId":{"type":"string","title":"Workspaceid","description":"The ID of the workspace this configuration belongs to"},"createdAt":{"type":"string","title":"Createdat"},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifiedat"},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deletedat"},"name":{"type":"string","title":"Name","description":"Human-readable name, the uploaded filename by default"},"mimeType":{"$ref":"#/components/schemas/MimeType","description":"File type, detected from the content"},"size":{"type":"integer","title":"Size","description":"Size of the Original in bytes"}},"type":"object","required":["workspaceId","name","mimeType","size"],"title":"Document"},"DocumentClass":{"properties":{"name":{"type":"string","title":"Name","description":"Document class name"},"description":{"type":"string","title":"Description","description":"Description of the document class to instruct agentic selection"}},"type":"object","required":["name","description"],"title":"DocumentClass"},"DocumentClassifyOutput":{"properties":{"category":{"anyOf":[{"$ref":"#/components/schemas/DocumentClass"},{"type":"null"}],"description":"Document category"},"motivation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Motivation","description":"Category selection explanation"}},"type":"object","title":"DocumentClassifyOutput"},"DocumentSummary":{"properties":{"length":{"type":"string","enum":["short","medium","long"],"title":"Length","description":"Summary length"},"title":{"type":"string","title":"Title","description":"Title of the document"},"summary":{"type":"string","title":"Summary","description":"Summary of the document"}},"type":"object","required":["length","title","summary"],"title":"DocumentSummary","description":"Static model for document summarization"},"DocumentUpdateRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"New name of the document"}},"additionalProperties":false,"type":"object","title":"DocumentUpdateRequest"},"Extraction":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the LLM configuration"},"workspaceId":{"type":"string","title":"Workspaceid","description":"The ID of the workspace this configuration belongs to"},"createdAt":{"type":"string","title":"Createdat"},"documentId":{"type":"string","title":"Documentid","description":"The Document this Job processes"},"status":{"$ref":"#/components/schemas/RunnableStatus","description":"queued, running, done or failed"},"credits":{"type":"integer","title":"Credits","description":"Credits charged for this Job, set when it is done"},"config":{"$ref":"#/components/schemas/ExtractionConfig","description":"The Extraction Config, as submitted"},"output":{"anyOf":[{"$ref":"#/components/schemas/OperationOutput_Any_"},{"type":"null"}],"description":"The output of a done Extraction, following its Output Schema; not included in lists"}},"type":"object","required":["workspaceId","documentId","status","credits","config"],"title":"Extraction"},"ExtractionConfig":{"properties":{"perimeter":{"type":"string","enum":["local","external"],"title":"Perimeter","description":"`local` keeps the data inside our infrastructure, `external` allows third-party providers","default":"external"},"parsing":{"$ref":"#/components/schemas/ParsingConfig","description":"How the Operation parses the Document"},"tier":{"type":"string","enum":["fast","accurate"],"title":"Tier","description":"`fast` runs on a cheaper language model, `accurate` on a stronger one","default":"fast"},"instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instructions","description":"Additional instructions for the model"},"outputSchema":{"additionalProperties":true,"type":"object","title":"Outputschema","description":"JSON Schema of the fields to extract"}},"additionalProperties":false,"type":"object","required":["outputSchema"],"title":"ExtractionConfig"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthStatus":{"properties":{"healthy":{"type":"boolean","title":"Healthy","description":"Server is healthy"}},"additionalProperties":false,"type":"object","required":["healthy"],"title":"HealthStatus"},"MimeType":{"type":"string","enum":["text/plain","text/markdown","text/html","text/csv","application/pdf","application/json","application/msword","application/vnd.ms-excel","application/vnd.ms-powerpoint","application/vnd.oasis.opendocument.text","application/vnd.oasis.opendocument.spreadsheet","application/vnd.oasis.opendocument.presentation","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.presentationml.presentation","image/jpeg","image/png","image/svg+xml","image/tiff","image/webp","image/vnd.microsoft.icon","image/bmp","image/avif","image/apng","image/gif","audio/aac","audio/midi","audio/x-midi","audio/mpeg","audio/ogg","audio/wav","audio/webm","audio/3gpp","audio/3gpp2","application/zip","application/octet-stream"],"title":"MimeType"},"OperationOutput_Any_":{"properties":{"value":{"title":"Value","description":"The Operation output"},"truncated":{"type":"boolean","title":"Truncated","description":"The Document was too long and the model read only its start","default":false}},"additionalProperties":false,"type":"object","required":["value"],"title":"OperationOutput[Any]"},"OperationOutput_DocumentClassifyOutput_":{"properties":{"value":{"$ref":"#/components/schemas/DocumentClassifyOutput","description":"The Operation output"},"truncated":{"type":"boolean","title":"Truncated","description":"The Document was too long and the model read only its start","default":false}},"additionalProperties":false,"type":"object","required":["value"],"title":"OperationOutput[DocumentClassifyOutput]"},"OperationOutput_DocumentSummary_":{"properties":{"value":{"$ref":"#/components/schemas/DocumentSummary","description":"The Operation output"},"truncated":{"type":"boolean","title":"Truncated","description":"The Document was too long and the model read only its start","default":false}},"additionalProperties":false,"type":"object","required":["value"],"title":"OperationOutput[DocumentSummary]"},"Parsing":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the LLM configuration"},"workspaceId":{"type":"string","title":"Workspaceid","description":"The ID of the workspace this configuration belongs to"},"createdAt":{"type":"string","title":"Createdat"},"documentId":{"type":"string","title":"Documentid","description":"The Document this Job processes"},"status":{"$ref":"#/components/schemas/RunnableStatus","description":"queued, running, done or failed"},"credits":{"type":"integer","title":"Credits","description":"Credits charged for this Job, set when it is done"},"config":{"$ref":"#/components/schemas/ParsingJobConfig","description":"The Parsing Config, as submitted"}},"type":"object","required":["workspaceId","documentId","status","credits","config"],"title":"Parsing"},"ParsingConfig":{"properties":{"tier":{"type":"string","enum":["fast","accurate"],"title":"Tier","description":"`fast` extracts text only, `accurate` reads layout, scans and tables where the format needs it","default":"fast"},"pages":{"anyOf":[{"type":"string"},{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Pages","description":"Pages to parse, as a list of indexes or a string like \"0,2-4\". All pages when omitted"}},"additionalProperties":false,"type":"object","title":"ParsingConfig"},"ParsingJobConfig":{"properties":{"tier":{"type":"string","enum":["fast","accurate"],"title":"Tier","description":"`fast` extracts text only, `accurate` reads layout, scans and tables where the format needs it","default":"fast"},"pages":{"anyOf":[{"type":"string"},{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Pages","description":"Pages to parse, as a list of indexes or a string like \"0,2-4\". All pages when omitted"},"perimeter":{"type":"string","enum":["local","external"],"title":"Perimeter","description":"`local` keeps the data inside our infrastructure, `external` allows third-party providers","default":"external"}},"additionalProperties":false,"type":"object","title":"ParsingJobConfig","description":"Everything a client chooses for a Parsing"},"RunnableStatus":{"type":"string","enum":["idle","queued","running","done","failed"],"title":"RunnableStatus"},"SuccessEmptyResult":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"}},"type":"object","title":"SuccessEmptyResult"},"SuccessResult_Classification_":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/Classification"}},"type":"object","required":["data"],"title":"SuccessResult[Classification]"},"SuccessResult_CursorPage_AuthToken__":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/CursorPage_AuthToken_"}},"type":"object","required":["data"],"title":"SuccessResult[CursorPage[AuthToken]]"},"SuccessResult_CursorPage_Classification__":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/CursorPage_Classification_"}},"type":"object","required":["data"],"title":"SuccessResult[CursorPage[Classification]]"},"SuccessResult_CursorPage_Document__":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/CursorPage_Document_"}},"type":"object","required":["data"],"title":"SuccessResult[CursorPage[Document]]"},"SuccessResult_CursorPage_Extraction__":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/CursorPage_Extraction_"}},"type":"object","required":["data"],"title":"SuccessResult[CursorPage[Extraction]]"},"SuccessResult_CursorPage_Parsing__":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/CursorPage_Parsing_"}},"type":"object","required":["data"],"title":"SuccessResult[CursorPage[Parsing]]"},"SuccessResult_CursorPage_Summarization__":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/CursorPage_Summarization_"}},"type":"object","required":["data"],"title":"SuccessResult[CursorPage[Summarization]]"},"SuccessResult_CursorPage_Workspace__":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/CursorPage_Workspace_"}},"type":"object","required":["data"],"title":"SuccessResult[CursorPage[Workspace]]"},"SuccessResult_Document_":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/Document"}},"type":"object","required":["data"],"title":"SuccessResult[Document]"},"SuccessResult_Extraction_":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/Extraction"}},"type":"object","required":["data"],"title":"SuccessResult[Extraction]"},"SuccessResult_HealthStatus_":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/HealthStatus"}},"type":"object","required":["data"],"title":"SuccessResult[HealthStatus]"},"SuccessResult_Parsing_":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/Parsing"}},"type":"object","required":["data"],"title":"SuccessResult[Parsing]"},"SuccessResult_Summarization_":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/Summarization"}},"type":"object","required":["data"],"title":"SuccessResult[Summarization]"},"SuccessResult_TokenCreateResponse_":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/TokenCreateResponse"}},"type":"object","required":["data"],"title":"SuccessResult[TokenCreateResponse]"},"SuccessResult_Workspace_":{"properties":{"status":{"type":"string","const":"ok","title":"Status","default":"ok"},"data":{"$ref":"#/components/schemas/Workspace"}},"type":"object","required":["data"],"title":"SuccessResult[Workspace]"},"Summarization":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the LLM configuration"},"workspaceId":{"type":"string","title":"Workspaceid","description":"The ID of the workspace this configuration belongs to"},"createdAt":{"type":"string","title":"Createdat"},"documentId":{"type":"string","title":"Documentid","description":"The Document this Job processes"},"status":{"$ref":"#/components/schemas/RunnableStatus","description":"queued, running, done or failed"},"credits":{"type":"integer","title":"Credits","description":"Credits charged for this Job, set when it is done"},"config":{"$ref":"#/components/schemas/SummarizationConfig","description":"The Summarization Config, as submitted"},"output":{"anyOf":[{"$ref":"#/components/schemas/OperationOutput_DocumentSummary_"},{"type":"null"}],"description":"The output of a done Summarization, not included in lists"}},"type":"object","required":["workspaceId","documentId","status","credits","config"],"title":"Summarization"},"SummarizationConfig":{"properties":{"perimeter":{"type":"string","enum":["local","external"],"title":"Perimeter","description":"`local` keeps the data inside our infrastructure, `external` allows third-party providers","default":"external"},"parsing":{"$ref":"#/components/schemas/ParsingConfig","description":"How the Operation parses the Document"},"tier":{"type":"string","enum":["fast","accurate"],"title":"Tier","description":"`fast` runs on a cheaper language model, `accurate` on a stronger one","default":"fast"},"instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instructions","description":"Additional instructions for the model"},"length":{"type":"string","enum":["short","medium","long"],"title":"Length","description":"Summary length","default":"medium"}},"additionalProperties":false,"type":"object","title":"SummarizationConfig"},"TokenCreateRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"expiresIn":{"anyOf":[{"type":"string","format":"duration"},{"type":"null"}],"title":"Expiresin"}},"additionalProperties":false,"type":"object","title":"TokenCreateRequest","description":"Create a persistent API Key"},"TokenCreateResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Authentication key identifier"},"createdAt":{"type":"string","title":"Createdat"},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifiedat"},"workspaceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workspaceid","description":"Key workspace identifier"},"issuerId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issuerid","description":"Key issuer key"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Optional key name"},"expiredAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expiredat","description":"Optional key expiration time"},"type":{"$ref":"#/components/schemas/AuthTokenType","default":"stored"},"secret":{"type":"string","title":"Secret"}},"additionalProperties":false,"type":"object","required":["workspaceId","issuerId","secret"],"title":"TokenCreateResponse"},"TokenTemporaryCreationRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"expiresIn":{"type":"string","format":"duration","title":"Expiresin","default":"PT5M"},"temporary":{"type":"boolean","const":true,"title":"Temporary"}},"additionalProperties":false,"type":"object","required":["temporary"],"title":"TokenTemporaryCreationRequest","description":"Create a temporary API Key"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"Workspace":{"properties":{"id":{"type":"string","title":"Id","description":"identifier"},"createdAt":{"type":"string","title":"Createdat"},"modifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modifiedat"},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deletedat"},"name":{"type":"string","title":"Name","description":"Human-readable public naming of the workspace"},"credits":{"type":"integer","title":"Credits","description":"Remaining credits for this workspace","default":0},"allowExternal":{"type":"boolean","title":"Allowexternal","description":"Whether Jobs may use the `external` Perimeter (Compliance Guard). Set by Axelered, read-only","default":true}},"additionalProperties":false,"type":"object","required":["name"],"title":"Workspace"},"WorkspaceCreateRequest":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the new workspace","examples":["workspace3"]}},"additionalProperties":false,"type":"object","required":["name"],"title":"WorkspaceCreateRequest"},"WorkspaceUpdateRequest":{"properties":{"name":{"type":"string","title":"Name","description":"New name for the workspace","examples":["Updated Workspace"]}},"additionalProperties":false,"type":"object","title":"WorkspaceUpdateRequest"}}},"tags":[{"name":"documents","description":"Upload files to the Workspace, then read, rename, download or delete them.","x-displayName":"Documents"},{"name":"parsings","description":"Turn a Document into a Parsed Document of Pages and Blocks.","x-displayName":"Parsings"},{"name":"summarizations","description":"Summarize a Document with a language model.","x-displayName":"Summarizations"},{"name":"classifications","description":"Assign a Document one of the Categories you define.","x-displayName":"Classifications"},{"name":"extractions","description":"Extract the fields of an Output Schema from a Document as JSON.","x-displayName":"Extractions"},{"name":"workspace","description":"Read and update the Workspace of the request.","x-displayName":"Workspace"},{"name":"auth","description":"Issue and revoke the API Keys and Ephemeral Tokens of the Workspace.","x-displayName":"API Keys"},{"name":"system","description":"Check that the service is up.","x-displayName":"System"},{"name":"admin","description":"Manage every Workspace and the global API Keys. Requires a global API Key or the Root Key.","x-displayName":"Admin"}]}