Endpoints

Status Endpoint

Check the processing status of a conversion job.

Overview

The Status endpoint allows you to check the current status of a conversion job. Use this endpoint to monitor job progress and determine when the job has completed (i.e. reached a terminal state of success or failed).

Endpoint Details

URL: GET /api/v1/status/{job_id}
Content-Type: application/json

Request Parameters

Headers

Header	Type	Required	Description
`X-Client-Id`	string	Yes	Client ID from the API keys
`X-Client-Secret`	string	Yes	Client secret from the API keys

Path Parameters

Parameter	Type	Required	Description
`job_id`	string	Yes	Unique identifier for the job

Request Examples

curl -X GET "https://platform.curiflow.com/api/v1/status/job-uuid-12345" 
  -H "X-Client-Id: your-client-id" 
  -H "X-Client-Secret: your-client-secret"

const jobId = 'job-uuid-12345';
const response = await fetch(`https://platform.curiflow.com/api/v1/status/${jobId}`, {
	method: 'GET',
	headers: {
		'X-Client-Id': 'your-client-id',
		'X-Client-Secret': 'your-client-secret'
	}
});

const result = await response.json();

import requests

job_id = "job-uuid-12345"
url = f"https://platform.curiflow.com/api/v1/status/{job_id}"
headers = {
    "X-Client-Id": "your-client-id",
    "X-Client-Secret": "your-client-secret"
}

response = requests.get(url, headers=headers)
result = response.json()

Response Format

Success Response (200 OK)

{
	"status": "success",
	"job_id": "job-uuid-12345"
}

Response Fields

Field	Type	Description
`status`	string	Current processing status
`job_id`	string	Unique identifier for the conversion job

Status Values

Status	Description
`pending`	Job is queued and waiting to be picked up
`success`	Job has been processed successfully
`failed`	Job failed during processing

Status and Error Codes

HTTP Code	Message
`200`	Status retrieved successfully
`400`	Job ID is required
`401`	X-Client-Id and X-Client-Secret are not valid
`404`	Job with ID `{job_id}` was not found
`404`	Unauthorized access
`429`	Too many requests. For more details, visit the page Rate Limits
`500`	Internal error, Please try again later.
`504`	API gateway timeout

Job Data Expiry

The status endpoint returns data only for jobs within their retention window. Job data is available for retrieval for 7 days by default, though this period may vary based on your organization’s settings. Once this window passes, the job data is no longer retained, so a 404 may indicate that the job data has expired rather than that the job ID never existed.

Best Practices

Polling Strategy: Implement reasonable polling intervals (e.g., every 30 seconds)
Timeout Handling: Set appropriate timeouts for long-running jobs
Security: Keep your client credentials secure

Next Steps

Based on the status response:

If success: Retrieve results via the Results endpoint
If failed: Investigate the error or retry the conversion
If pending: Continue polling until the job completes (i.e. reaches success or failed)