Skip to main content

Media Status

This endpoint allows you to retrieve the current status and platform-specific publication details for a video or image.

Get Media Status

Retrieve the status of a specific media item by its ID.

Method: GET Endpoints:

  • Videos: GET https://xenonflare.com/api/v1/media/videos/:id
  • Images: GET https://xenonflare.com/api/v1/media/images/:id

Authentication

Include your API key in the request headers:

  • X-API-Key: Your API key
  • OR Authorization: Bearer YOUR_API_KEY

Path Parameters

  • id (required): The unique ID of the media item (returned after a successful upload).

Response Structure

{
"success": true,
"data": {
"id": "string",
"title": "string",
"status": "pending|processing|completed|failed|draft|scheduled",
"platforms": ["youtube", "instagram", "tiktok", "linkedin"],
"scheduledAt": "ISO Date",
"youtube": {
"status": "published|failed|processing|pending|idle|manual",
"videoId": "string",
"url": "string"
},
"instagram": {
"status": "published|failed|processing|pending|idle|manual",
"mediaId": "string",
"url": "string"
},
"tiktok": {
"status": "published|failed|processing|pending|idle|manual",
"videoId": "string",
"url": "string"
},
"linkedin": {
"status": "published|failed|processing|pending|idle|manual",
"urn": "string",
"url": "string"
},
"pinterest": {
"status": "published|failed|processing|pending|idle|manual",
"pinId": "string",
"url": "string"
},
"createdAt": "ISO Date",
"updatedAt": "ISO Date"
}
}

Media Statuses

The top-level status field represents the overall state of the media entry:

  • draft: The item is a draft and will not be processed automatically.
  • pending: The item is waiting to be processed/published.
  • scheduled: The item is scheduled for a future publication.
  • processing: Our servers are currently handling the assets or communicating with platform APIs.
  • completed: The item has been successfully published to all selected platforms.
  • failed: An error occurred during processing or publishing.

Platform Statuses

The status field within platform objects represents the status specifically for that platform:

  • idle: No action has been taken yet or the platform was not selected.
  • pending: Waiting to be sent to the platform.
  • processing: Currently being uploaded or processed by the platform.
  • published: Successfully live on the platform.
  • failed: Publication failed for this specific platform.
  • manual: Requires manual action on the platform or XenonFlare dashboard.

List Media History

Retrieve a paginated list of your uploaded videos or images.

Endpoints:

  • Videos: GET https://xenonflare.com/api/v1/media/videos
  • Images: GET https://xenonflare.com/api/v1/media/images

Query Parameters

ParameterTypeDefaultDescription
pagenumber1Page number for pagination.
limitnumber10Number of items per page.
statusstring-Filter by status (e.g., completed, failed).
platformstring-Filter by platform (e.g., youtube, instagram).

Response structure

{
"success": true,
"data": {
"videos": [ ... ], // or "images": [ ... ]
"pagination": {
"total": 124,
"page": 1,
"limit": 10,
"pages": 13
}
}
}

Error Responses

  • 401 Unauthorized: API key is missing or invalid.
  • 404 Not Found: No media found with the provided ID for your account.
  • 500 Server Error: Internal infrastructure error.