Media Metadata¶

Pricing¶

25 credits per request

Fixed cost regardless of media file size.

This endpoint extracts detailed metadata from media files (video, audio, image) including format, duration, codec information, resolution, and bitrates.

Endpoint¶

POST https://api.revidapi.com/paid/media/metadata

Authentication¶

This endpoint requires API authentication. See Authentication for details.

Request¶

{
  "media_url": "https://example.com/media.mp4",
  "webhook_url": "https://example.com/webhook",  // Optional
  "id": "custom-id"  // Optional
}

Parameter	Type	Required	Description
media_url	string	Yes	URL of the media file to analyze
webhook_url	string	No	URL to receive the processing result
id	string	No	Custom identifier for tracking the request

Response¶

Success (200 OK)

{
  "code": 200,
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "id": "custom-id",
  "response": {
    "filesize": 15679283,
    "filesize_mb": 14.95,
    "duration": 87.46,
    "duration_formatted": "00:01:27.46",
    "format": "mp4,mov,m4a,3gp,3g2,mj2",
    "overall_bitrate": 1438692,
    "overall_bitrate_mbps": 1.44,
    "has_video": true,
    "video_codec": "h264",
    "video_codec_long": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
    "width": 1920,
    "height": 1080,
    "resolution": "1920x1080",
    "fps": 30.0,
    "video_bitrate": 1300000,
    "video_bitrate_mbps": 1.3,
    "pixel_format": "yuv420p",
    "has_audio": true,
    "audio_codec": "aac",
    "audio_codec_long": "AAC (Advanced Audio Coding)",
    "audio_channels": 2,
    "audio_sample_rate": 48000,
    "audio_sample_rate_khz": 48.0,
    "audio_bitrate": 128000,
    "audio_bitrate_kbps": 128
  },
  "message": "success",
  "run_time": 0.542,
  "queue_time": 0,
  "total_time": 0.542,
  "pid": 12345,
  "queue_id": 67890,
  "queue_length": 0,
  "build_number": "123"
}

For audio-only files, video-related fields will not be included. Similarly, for video files without audio, audio-related fields will not be included.

Queued (202 Accepted)

{
  "code": 202,
  "id": "custom-id",
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "message": "processing",
  "pid": 12345,
  "queue_id": 67890,
  "max_queue_length": "unlimited",
  "queue_length": 0,
  "build_number": "123"
}

Error (4xx/5xx)

{
  "code": 500,
  "id": "custom-id",
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Error extracting metadata: [error details]",
  "pid": 12345,
  "queue_id": 67890,
  "queue_length": 0,
  "build_number": "123"
}

Example¶

Request¶

curl -X POST https://api.example.com/v1/media/metadata \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_api_key" \
  -d '{
    "media_url": "https://example.com/sample-video.mp4",
    "webhook_url": "https://your-server.com/webhook"
  }'

Response¶

{
  "code": 200,
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "response": {
    "filesize": 15679283,
    "filesize_mb": 14.95,
    "duration": 87.46,
    "duration_formatted": "00:01:27.46",
    "format": "mp4",
    "overall_bitrate": 1438692,
    "overall_bitrate_mbps": 1.44,
    "has_video": true,
    "video_codec": "h264",
    "width": 1920,
    "height": 1080,
    "resolution": "1920x1080",
    "fps": 30.0,
    "video_bitrate": 1300000,
    "video_bitrate_mbps": 1.3,
    "has_audio": true,
    "audio_codec": "aac",
    "audio_channels": 2,
    "audio_sample_rate": 48000,
    "audio_bitrate": 128000,
    "audio_bitrate_kbps": 128
  },
  "message": "success",
  "run_time": 0.542,
  "total_time": 0.542
}

Get Job Status¶

After submitting a job, you can check its status using the job_id returned in the response.

Endpoint¶

URL Path: https://api.revidapi.com/paid/get/job/status
HTTP Method: POST

Request¶

Headers¶

x-api-key (required): API key for authentication.
Content-Type: application/json

Body Parameters¶

{
  "job_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
}

Example Request¶

curl -X POST \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"job_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"}' \
  https://api.revidapi.com/paid/get/job/status

Response¶

Success Response¶

{
  "endpoint": "/v1/toolkit/job/status",
  "code": 200,
  "id": null,
  "job_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
  "response": {
    "job_status": "done",
    "job_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
    "queue_id": 140368864456064,
    "process_id": 123456,
    "response": {
      "endpoint": "/v1/media/metadata",
      "code": 200,
      "id": "custom-id",
      "job_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
      "response": {
        "filesize": 15679283,
        "duration": 87.46,
        "format": "mp4"
      },
      "message": "success",
      "pid": 123456,
      "queue_id": 140368864456064,
      "run_time": 0.542,
      "queue_time": 0.0,
      "total_time": 0.542,
      "queue_length": 0,
      "build_number": "123"
    }
  },
  "message": "success",
  "pid": 123456,
  "queue_id": 140368864456064,
  "run_time": 0.001,
  "queue_time": 0.0,
  "total_time": 0.001,
  "queue_length": 0,
  "build_number": "1.0.0"
}

Error Responses¶

404 Not Found: If no job is found with the provided job_id:

{
  "error": "Job not found",
  "job_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"
}

500 Internal Server Error: If an unexpected error occurs:

{
  "error": "Failed to retrieve job status: <error_message>",
  "code": 500
}

```