API Documentation

Appearance

GET /applications/ ​

Description ​

Retrieve information about your applications. You can list all applications of your account, or fetch a single application by its id (which is identical to its client_id).

Authentication ​

  • Required: Yes
  • Method: Bearer token
  • Scope: mediahub_read

Request Headers ​

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

Parameters ​

Query Parameters ​

Common Parameters (for both GET /applications/ and GET /applications/ID) ​

  • format: string (Optional)
    Values: json, xml
    Overrides the Accept header if provided.
  • human: boolean (Optional)
    Values: true, false
    Causes the response to be in a structured, more human-readable form.
  • show_null: boolean (Optional)
    Values: true, false
    If set to "true", the response will contain keys that are not set to a value.

Parameters for Fetching Multiple Applications (GET /applications/) ​

  • default_only: boolean (Optional)
    Values: true, false
    If true, only the default (internal) application of your account is returned instead of all your custom applications.
  • start: int (Optional)
    Offset for paging. Default value: 0.
  • limit: int (Optional)
    Number of items per page. Default value: 1000 (max: 5000).
  • sort: string (Optional)
    Values: Any valid key name
    Sorts the output along the given key name. For example, use created_at to sort the results by the creation date.
  • direction: int (Optional)
    Values: 1, -1
    Sort records in ascending (1) or descending (-1) order. Default value: 1.

Parameters for Fetching a Single Application (GET /applications/{id}) ​

  • id: string (Required, path)
    The application id (identical to its client_id). For example: 6ae0971a404343165f14396d.

Example Request for Listing Multiple Applications ​

bash
curl -X GET "https://api.xvid.com/v1/applications/?human=true" \
  -H "Authorization: Bearer AUTH_TOKEN"

Example Response for Listing Multiple Applications ​

Success (200 OK) ​

json
{
  "applications": [
    {
      "app_name": "My Signing Script",
      "scopes": [
        "mediahub_read"
      ],
      "product": "mediahub",
      "client_id": "6ae0971a404343165f14396d",
      "client_secret": "************************************************************",
      "user": {
        "id": "51304d3467b4c3205acd9397",
        "href": "https://api.xvid.com/v1/users/51304d3467b4c3205acd9397"
      },
      "created_at": 1793103642639,
      "updated_at": 1793103642639,
      "id": "6ae0971a404343165f14396d",
      "href": "https://api.xvid.com/v1/applications/6ae0971a404343165f14396d"
    },
    {
      "app_name": "My Website",
      "scopes": [
        "mediahub_read",
        "mediahub_write"
      ],
      "product": "mediahub",
      "client_id": "5b1f4c8ae4b0dac9133b27fe",
      "client_secret": "************************************************************",
      "user": {
        "id": "51304d3467b4c3205acd9397",
        "href": "https://api.xvid.com/v1/users/51304d3467b4c3205acd9397"
      },
      "created_at": 1793000000000,
      "updated_at": 1793000000000,
      "id": "5b1f4c8ae4b0dac9133b27fe",
      "href": "https://api.xvid.com/v1/applications/5b1f4c8ae4b0dac9133b27fe"
    }
  ],
  "total": 2,
  "start": 0,
  "limit": 1000,
  "first": {
    "href": "https://api.xvid.com/v1/applications/?start=0&limit=1000&human=true"
  },
  "last": {
    "href": "https://api.xvid.com/v1/applications/?start=0&limit=1000&human=true"
  }
}

Example Request for Fetching a Specific Application ​

bash
curl -X GET "https://api.xvid.com/v1/applications/6ae0971a404343165f14396d?human=true" \
  -H "Authorization: Bearer AUTH_TOKEN"

Example Response for Fetching a Specific Application ​

Success (200 OK) ​

json
{
  "application": {
    "app_name": "My Signing Script",
    "scopes": [
      "mediahub_read"
    ],
    "product": "mediahub",
    "client_id": "6ae0971a404343165f14396d",
    "client_secret": "************************************************************",
    "user": {
      "id": "51304d3467b4c3205acd9397",
      "href": "https://api.xvid.com/v1/users/51304d3467b4c3205acd9397"
    },
    "created_at": 1793103642639,
    "updated_at": 1793103642639,
    "id": "6ae0971a404343165f14396d",
    "href": "https://api.xvid.com/v1/applications/6ae0971a404343165f14396d"
  }
}

Response Fields ​

  • app_name: string — The name of the application.
  • scopes: array — The API scopes granted to the application (e.g. mediahub_read, mediahub_write, autograph).
  • product: string — The product the application belongs to (default: mediahub).
  • client_id: string — The application's client ID, identical to its id.
  • client_secret: string — The application's client secret. Only returned on create; on subsequent reads it may be masked or present depending on show_null.
  • user.id: string — The ID of the account that owns the application.
  • created_at: date — The date/time the application was created (epoch millis).
  • updated_at: date — The date/time the application was last updated (epoch millis).
  • id: string — The application's ID (identical to client_id).
  • href: string — The canonical link to the application.

Error Responses ​

400 Bad Request ​

json
{
  "error": {
    "error_code": "0x0220002",
    "error_message": "Scopes requested are not allowed"
  }
}

403 Forbidden ​

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

404 Not Found ​

json
{
  "error": {
    "error_code": "0x0220001",
    "error_message": "Application does not exist"
  }
}

500 Internal Server Error ​

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