API Reference
Every endpoint of the Axelered API, grouped by resource.
🌐 Base URL
https://api.axelered.com/v1Every request except /health carries an API Key in the Authorization header. A global API Key or the Root Key
belongs to no Workspace, so it also names one in the X-Workspace-Id header on every Workspace route, see
Authentication.
Authorization: Bearer ax_...
X-Workspace-Id: 018f8e024b2a7c3d9e1f0a2b3c4d5e6f📦 Responses
A successful response is an envelope with status: "ok" and the result in data. Errors use the same envelope with
status: "error" and a code to branch on, see Errors.
{
"status": "ok",
"data": { "id": "018f8e024b2a7c3d9e1f0a2b3c4d5e6f" }
}Lists are paginated with a cursor: pass limit (1 to 100, default 50) and the cursor of the previous page. data
holds the items and the cursor of the next page, null on the last one.
The OpenAPI schema of this reference is available for download: openapi.json.
📚 Endpoints
Documents
Upload files to the Workspace, then read, rename, download or delete them.
| Method | Path | Description |
|---|---|---|
POST | /documents | Upload Document |
DELETE | /documents/{document_id} | Delete Document |
GET | /documents | List Documents |
GET | /documents/{document_id}/original | Download Document |
GET | /documents/{document_id} | Read Document |
PATCH | /documents/{document_id} | Update Document |
Parsings
Turn a Document into a Parsed Document of Pages and Blocks.
| Method | Path | Description |
|---|---|---|
POST | /parsings | Submit Parsing |
DELETE | /parsings/{job_id} | Delete Parsing |
GET | /parsings | List Parsings |
GET | /parsings/{job_id}/output | Read Parsing Output |
GET | /parsings/{job_id} | Read Parsing |
Summarizations
Summarize a Document with a language model.
| Method | Path | Description |
|---|---|---|
POST | /summarizations | Submit Summarization |
DELETE | /summarizations/{job_id} | Delete Summarization |
GET | /summarizations | List Summarizations |
GET | /summarizations/{job_id} | Read Summarization |
Classifications
Assign a Document one of the Categories you define.
| Method | Path | Description |
|---|---|---|
POST | /classifications | Submit Classification |
DELETE | /classifications/{job_id} | Delete Classification |
GET | /classifications | List Classifications |
GET | /classifications/{job_id} | Read Classification |
Extractions
Extract the fields of an Output Schema from a Document as JSON.
| Method | Path | Description |
|---|---|---|
POST | /extractions | Submit Extraction |
DELETE | /extractions/{job_id} | Delete Extraction |
GET | /extractions | List Extractions |
GET | /extractions/{job_id} | Read Extraction |
Workspace
Read and update the Workspace of the request.
| Method | Path | Description |
|---|---|---|
GET | /workspace | Read Current Workspace |
PATCH | /workspace | Update Current Workspace |
API Keys
Issue and revoke the API Keys and Ephemeral Tokens of the Workspace.
| Method | Path | Description |
|---|---|---|
POST | /keys | Create API Key |
DELETE | /keys/{key_id} | Delete API Key |
GET | /keys | List API Keys |
System
Check that the service is up.
| Method | Path | Description |
|---|---|---|
GET | /health | Health Check |
Admin
Manage every Workspace and the global API Keys. Requires a global API Key or the Root Key.
| Method | Path | Description |
|---|---|---|
POST | /admin/workspaces | Create Workspace |
POST | /admin/keys | Create Global API Key |
DELETE | /admin/workspaces/{workspace_id} | Delete Workspace |
DELETE | /admin/keys/{key_id} | Delete Global API Key |
GET | /admin/workspaces | List Workspaces |
GET | /admin/keys | List Global API Keys |
GET | /admin/workspaces/{workspace_id} | Read Workspace |
PUT | /admin/workspaces/{workspace_id}/undelete | Undelete Workspace |
PATCH | /admin/workspaces/{workspace_id} | Update Workspace |