API Reference
Programmatic access to XMOX transcription and AI analysis.
Enterprise plan required · Get API key →
Overview
The XMOX REST API lets you upload audio files, poll for transcription status, retrieve full transcripts, ask natural-language questions about audio content, and delete jobs — all programmatically.
API access requires an active Enterprise subscription. Create and manage API keys from your API Keys page.
Base URL
Base URL
https://xmox.ai/api/external/v1
Authentication
Pass your API key in the X-API-Key header on every request. Keys are shown only once when created — store them in a secrets manager or environment variable.
Request
X-API-Key: xm_your_api_key_here
Response (401 — missing or invalid key)
{
"success": false,
"error": "Invalid or missing API key."
}
Response (403 — plan not Enterprise)
{
"success": false,
"error": "API access requires an Enterprise subscription."
}
Endpoints
POST
/process
Upload an audio or video file to start a transcription job. Returns a <code>job_id</code> immediately; poll the status endpoint to check when it finishes.
Upload an audio or video file to start a transcription job. Returns a job_id immediately; poll the status endpoint to check when it finishes.
Headers
| Header | Value | |
|---|---|---|
| X-API-Key | string | requiredrequired |
| Content-Type | multipart/form-data | requiredrequired |
Body (JSON) (multipart)
| Field | Type | Description |
|---|---|---|
| file | binary | Audio or video file (MP3, WAV, M4A, FLAC, OGG, OPUS, MP4, MOV, WEBM, MKV). Max 500 MB. required |
Request
curl -X POST https://xmox.ai/api/external/v1/process \
-H "X-API-Key: xm_your_key" \
-F "file=@meeting.mp3"
Response (202 Accepted)
{
"success": true,
"job_id": 4821,
"status": "processing"
}
Warning: Undefined array key "status_codes" in /var/www/html/docs/index.php on line 833
Deprecated: htmlspecialchars(): Passing null to parameter #1 ($string) of type string is deprecated in /var/www/html/docs/index.php on line 833
- 202Job created; use
job_idto poll for completion. - 400Missing or empty file.
- 402Monthly quota reached.
- 401Invalid API key.
- 403Not on Enterprise plan.
GET
/jobs/{job_id}
Retrieve the current status and metadata of a transcription job.
Retrieve the current status and metadata of a transcription job.
Path parameter
| Parameter | Type | Description |
|---|---|---|
| job_id | integer | ID returned by POST /process. required |
Request
curl https://xmox.ai/api/external/v1/jobs/4821 \
-H "X-API-Key: xm_your_key"
Response (200)
{
"success": true,
"job": {
"job_id": 4821,
"status": "completed", /* processing | completed | failed */
"filename": "meeting.mp3",
"duration_s": 3642,
"created_at": "2026-07-27T09:14:22Z"
}
}
Warning: Undefined array key "status_codes" in /var/www/html/docs/index.php on line 880
Deprecated: htmlspecialchars(): Passing null to parameter #1 ($string) of type string is deprecated in /var/www/html/docs/index.php on line 880
- 200Job found. Check
job.status: processing — transcription in progress, completed — transcript ready, failed — see error field. - 404Job not found or belongs to a different account.
GET
/jobs/{job_id}/transcript
Retrieve the full transcript text of a completed job.
Retrieve the full transcript text of a completed job.
Path parameter
| Parameter | Type | Description |
|---|---|---|
| job_id | integer | ID of a completed job. required |
Request
curl https://xmox.ai/api/external/v1/jobs/4821/transcript \
-H "X-API-Key: xm_your_key"
Response (200)
{
"success": true,
"job_id": 4821,
"transcript": "Good morning everyone. Today we'll be reviewing..."
}
Warning: Undefined array key "status_codes" in /var/www/html/docs/index.php on line 919
Deprecated: htmlspecialchars(): Passing null to parameter #1 ($string) of type string is deprecated in /var/www/html/docs/index.php on line 919
- 200Transcript text returned in
transcriptfield. - 400Job is not yet completed or has no transcript.
- 404Job not found.
POST
/jobs/{job_id}/question
Ask a natural-language question about a completed job. The AI reads the transcript and returns a concise answer.
Ask a natural-language question about a completed job. The AI reads the transcript and returns a concise answer.
Body (JSON)
| Field | Type | Description |
|---|---|---|
| question | string | Natural-language question about the audio content. required |
Request
curl -X POST https://xmox.ai/api/external/v1/jobs/4821/question \
-H "X-API-Key: xm_your_key" \
-H "Content-Type: application/json" \
-d '{"question": "What action items were agreed upon?"}'
Response (200)
{
"success": true,
"job_id": 4821,
"answer": "Three action items were agreed upon: (1) Alice will send the revised proposal by Friday..."
}
Warning: Undefined array key "status_codes" in /var/www/html/docs/index.php on line 961
Deprecated: htmlspecialchars(): Passing null to parameter #1 ($string) of type string is deprecated in /var/www/html/docs/index.php on line 961
- 200AI answer returned in
answerfield. - 400Missing
questionfield, or job not yet completed. - 404Job not found.
DELETE
/jobs/{job_id}
Permanently delete a job and its associated audio file and transcript.
Permanently delete a job and its associated audio file and transcript.
Path parameter
| Parameter | Type | Description |
|---|---|---|
| job_id | integer | ID of the job to delete. required |
Request
curl -X DELETE https://xmox.ai/api/external/v1/jobs/4821 \
-H "X-API-Key: xm_your_key"
Response (200)
{
"success": true,
"message": "Job deleted."
}
Warning: Undefined array key "status_codes" in /var/www/html/docs/index.php on line 1000
Deprecated: htmlspecialchars(): Passing null to parameter #1 ($string) of type string is deprecated in /var/www/html/docs/index.php on line 1000
- 200Job and all associated data deleted.
- 404Job not found.
Error Codes
All error responses share the same shape. The HTTP status code indicates the class of error; the error field contains a human-readable message.
Response shape
{
"success": false,
"error": "Human-readable description of what went wrong."
}
| HTTP Status | Meaning |
|---|---|
| 400 | Bad request — missing required field or invalid value. |
| 401 | Unauthorized — API key missing, invalid, or revoked. |
| 402 | Quota error (402): returned when you have reached the monthly file or minute limit for your plan. |
| 403 | Forbidden — account does not have an active Enterprise plan. |
| 404 | Not found — the job does not exist or belongs to a different account. |
| 500 | Server error — unexpected failure; retry with exponential back-off. |