Get Multimedia

This endpoint allows you to retrieve detailed information about a specific multimedia item by its ID. The response includes all metadata, configuration settings, and related resources.

🔹 Endpoint Details

GET /api/v1/multimedia/{multimediaId}

🔒 Authentication

Header	Required	Description
Content-Type	Yes	Must be application/json
Authorization	Yes	Format: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

📝 Path Parameters

Parameter	Type	Required	Description
multimediaId	string (UUID)	Yes	Unique identifier of the multimedia

🧩 Request Example

curl -X GET "https://openapi.onlive.site/api/v1/multimedia/7a1c8d4b-3f2e-5697-9a8b-106c4d8e7f9a" \
-H "Content-Type: application/json" \
-H "Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature"

📤 Response Format

Success Response (200 OK)

{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "app": {
    "type": "string",
    "source": {
      "url": "string",
      "security": "string"
    },
    "resource": "string",
    "args": "string"
  },
  "url": "string",
  "format": "string",
  "description": "string",
  "size": 0,
  "duration": 0,
  "status": "string",
  "environment": {},
  "coverVideo": {
    "id": "string",
    "url": "string",
    "size": 0,
    "format": "string",
    "duration": 0
  },
  "options": {
    "usePixelStreaming": true,
    "timeout": 0,
    "showBooking": true,
    "showRegister": true
  }
}

❌ Error Responses

404 Not Found

{
  "statusCode": 404,
  "message": "There is no multimedia with the specified ID"
}

403 Forbidden

{
  "statusCode": 403,
  "message": "Insufficient permissions to access this multimedia content"
}

📘 Notes

• The multimedia content is fetched from the organization associated with your credentials
• For large multimedia files, only metadata is returned (not the actual binary content)
• Status values can be "ready", "need_action", or "error"
• If multimedia content is not found or deleted, a 404 error is returned
• Access permissions are validated before returning content details

💡 Best Practices

1. Performance Optimization

   • Cache multimedia metadata for frequently accessed items
   • Request only when content details have changed
   • Use multimedia IDs in your application for reference

2. Error Handling

   • Implement proper error handling for 404 responses
   • Check status values before attempting to use content
   • Handle transition states appropriately

3. Content Integration

   • Use the returned URL for embedding content in applications
   • Check format compatibility before displaying content
   • Respect content environment settings for proper rendering