Jobs API
The Jobs API allows you to create and monitor processing jobs for your uploaded video files.
Create a job
Create a new processing job for a video file.
curl -X POST https://api.move.ai/v1/jobs \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"file_id": "file_123456789",
"model": "s1",
"rig_id": "rig_default"
}'
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
file_id | String | Yes | ID of the uploaded video file |
model | String | Yes | AI model to use (s1, m1, s2, m2) |
rig_id | String | No | Character rig configuration |
Response
{
"id": "job_123456789",
"file_id": "file_123456789",
"status": "queued",
"model": "s1",
"created_at": "2023-01-01T00:00:00Z",
"estimated_duration": 300
}
Get job status
Check the status of a processing job.
curl -X GET https://api.move.ai/v1/jobs/job_123456789 \
-H "Authorization: Bearer YOUR_API_KEY"
Response
{
"id": "job_123456789",
"file_id": "file_123456789",
"status": "processing",
"progress": 75,
"model": "s1",
"created_at": "2023-01-01T00:00:00Z",
"completed_at": null,
"take_id": null
}
List jobs
Get a list of all your processing jobs.
curl -X GET https://api.move.ai/v1/jobs \
-H "Authorization: Bearer YOUR_API_KEY"
Query Parameters
| Parameter | Type | Description |
|---|---|---|
limit | Integer | Number of jobs to return (default: 20, max: 100) |
offset | Integer | Number of jobs to skip |
status | String | Filter by job status |
Response
{
"jobs": [
{
"id": "job_123456789",
"file_id": "file_123456789",
"status": "completed",
"model": "s1",
"created_at": "2023-01-01T00:00:00Z",
"take_id": "take_123456789"
}
],
"total": 1,
"limit": 20,
"offset": 0
}
Cancel a job
Cancel a processing job (only works if job is still queued or processing).
curl -X DELETE https://api.move.ai/v1/jobs/job_123456789 \
-H "Authorization: Bearer YOUR_API_KEY"
Response
{
"success": true,
"message": "Job cancelled successfully"
}
Job statuses
| Status | Description |
|---|---|
queued | Job is waiting to be processed |
processing | Job is currently being processed |
completed | Job completed successfully |
failed | Job failed to complete |
cancelled | Job was cancelled |