Get Job Status Endpoint

GET `/api/status/{video_id}`

Check the status of a previously created video processing or analysis job. Use this endpoint to poll for job completion.

Path Parameters

Parameter	Description	Example
video_id	The ID returned from the process-video or analyze-video request	a1b2c3d4-e5f6-e7

Status Values

Status	Description
pending	Job is queued but not yet started
processing	Job is actively being processed
completed	Processing has finished successfully
failed	Processing encountered an error
not_found	No job matching the given ID exists

Response Fields

Field	Type	Description
status	string	Current job status (see values above)
progress	number	Percentage complete (0.0 to 100.0)
download_url	string	Download link for processed video (processing jobs only, when completed)
result	object	Analysis data (analysis jobs only, when completed)
error_message	string	Error details (only when status is "failed")

Example: cURL

curl -X GET "https://api.aiframe.ai/api/status/YOUR_VIDEO_ID" \
-H "X-API-Key: YOUR_API_KEY"

Response Examples

Processing Job (Completed)

{
  "status": "completed",
  "progress": 100.0,
  "download_url": "https://storage.aiframe.ai/v/processed/a1b2c3d4.mp4?token=xyz",
  "result": null,
  "error_message": null
}

Analysis Job (Completed)

{
  "status": "completed", 
  "progress": 100.0,
  "download_url": null,
  "result": {
    "transcript": "Transcript of video...",
    "summary": { ... },
    "// ... additional analytics data"
  },
  "error_message": null
}

For detailed response formats and error codes, please see the API Reference (Swagger).