Skip to main content

Upload Status

Check the status of asynchronous uploads initiated with async_upload=true.

Endpoint​

GET /api/uploadposts/status?request_id=yourrequestid

Headers​

NameValueDescription
AuthorizationApikey your-api-key-hereYour API key for authentication

Query Parameters​

NameTypeRequiredDescription
request_idStringYesThe request identifier returned by the upload endpoints when async_upload=true.

Behavior​

  • When you submit an upload request with async_upload=true, the API returns immediately with a request_id.
  • Use this request_id with this endpoint to retrieve aggregated progress and results.
  • The status field may be one of:
    • pending: The request has been accepted but no platform results recorded yet.
    • in_progress: Some platform results recorded but not all (or total unknown).
    • completed: All known work is finished (based on inferred total or recorded items).

Example Request​

curl \
  -H 'Authorization: Apikey your-api-key-here' \
  "https://api.upload-post.com/api/uploadposts/status?request_id=<REQUEST_ID>"

Example Response​

{
  "request_id": "7b2c2f5e-1234-4a6f-9f1d-a1b2c3d4e5f6",
  "status": "in_progress",
  "completed": 1,
  "total": 2,
  "results": [
    {
      "platform": "x",
      "success": true,
      "message": "Queued",
      "upload_timestamp": "2025-01-01T12:34:56Z"
    }
  ],
  "last_update": "2025-01-01T12:34:56Z"
}