Skip to main content
GET
/
api
/
jobs
/
{id}
Retrieve a job
curl --request GET \
  --url https://convertly.sh/api/jobs/{id} \
  --header 'Authorization: Bearer <token>'
{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "jobType": "convert",
  "status": "pending",
  "totalFiles": 123,
  "completedFiles": 123,
  "failedFiles": 123,
  "progress": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "errorMessage": "<string>",
  "results": {},
  "completedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.convertly.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Dashboard-generated Convertly API key.

Path Parameters

​
id
string<uuid>
required

Response

Job detail

​
jobId
string<uuid>
required
​
jobType
enum<string>
required
Available options:
convert,
compress,
media_tool,
transfer
​
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed
​
totalFiles
integer
required
​
completedFiles
integer
required
​
failedFiles
integer
required
​
progress
integer
required
​
createdAt
string<date-time>
required
​
errorMessage
string | null
​
results
​
completedAt
string<date-time> | null