API Documentation

Appearance

GET /files/uploads/ID ​

Description ​

Query status of a specific file upload. This is used to check the status of an ongoing upload or to verify if the finishing step triggered by a PUT request has completed.

Authentication ​

  • Required: Yes
  • Method: Bearer token

Request Headers ​

  • Authorization: Bearer [AUTH_TOKEN]
  • Accept:
    • application/json (for JSON responses)
    • application/xml (for XML responses)

Parameters ​

Path Parameters ​

  • ID: string (Required)
    The unique identifier of the upload session to query.

Query Parameters ​

  • format: string (Optional)
    Values: json, xml
    Overrides the Request Accept header.
  • human: boolean (Optional)
    Values: true, false
    Causes the response to be in a structured, more human-readable form.

Example Request ​

bash
curl -X GET -H "Authorization: Bearer AUTH_TOKEN" "https://api.xvid.com/v1/files/uploads/598358fe6baa605b1e33754e?human=true"

Example Response ​

Success (200 OK) ​

json
{
  "upload": {
    "form_post_url": "https://s3-eu-west-1.amazonaws.com/prd-xmc-xvid-s3-eu-west-1/",
    "status": "COMPLETING",
    "nb_chunks": 1,
    "storage_type": "S3",
    "object_key": "uploads/test.mp4",
    "pipeline": {
      "id": "547f3eede4b025bcbff38657"
    },
    "file": {
      "id": "598358fe6baa605b1e33754e"
    },
    "id": "598358fe6baa605b1e33754e"
  }
}

Error Responses ​

400 Bad Request ​

json
{
  "error": {
    "error_code": "0x0230001",
    "error_message": "Invalid Input"
  }
}

403 Forbidden ​

json
{
  "error": {
    "error_code": "0x0000003",
    "error_message": "Invalid access token"
  }
}

404 Not Found ​

json
{
  "error": {
    "error_code": "0x0230002",
    "error_message": "Requested file does not exist"
  }
}

500 Internal Server Error ​

json
{
  "error": {
    "error_code": "0x0000001",
    "error_message": "Internal Error"
  }
}