Skip to main content

7. Check Status

Endpoint: POST /sync_status

Description: Checks the status of the video processing and provides download links if completed.

Request:

curl -X POST https://api.sync.aimi.fm/sync_status \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"execid": "unique-exec-id"}'

Response:

  • Finished:

    {
    "status": "finished",
    "url": "https://storage.googleapis.com/bucket/unique-exec-id.mp4",
    "queryurl": "https://storage.googleapis.com/bucket/unique-exec-id-results.json",
    "message": "Finished and ready for download"
    }
  • Processing:

    {
    "status": "processing",
    "url": null,
    "message": "Still processing your request, please try again in a few minutes."
    }
  • Pending:

    {
    "status": "pending",
    "url": null,
    "message": "Your plan has been submitted and is awaiting execution."
    }
  • Error:

    {
    "status": "error",
    "url": "https://storage.googleapis.com/bucket/unique-exec-id-failed.json",
    "message": "Error generating video. You can view the error report"
    }
  • Inactive:

    {
    "status": "inactive",
    "videourl": null,
    "message": "There is no active execution for id unique-exec-id."
    }