Coconut

Coconut is a cloud video and audio encoding/transcoding service. The Coconut API v2 lets developers submit a single asynchronous job that transcodes source media into multiple formats, packages adaptive HLS/MPEG-DASH streams, and generates thumbnails and GIF animations, delivering results to cloud storage and reporting progress through webhooks.

3 APIs 0 Features

VideoAudioEncodingTranscodingMedia

APIs

Coconut Jobs API

Create an asynchronous encoding job with a single request - specify an input source, storage destination, output formats (MP4, WebM, HLS, MPEG-DASH, thumbnails, GIF), and a webh...

Coconut Metadata API

Retrieve technical metadata (codec, stream, and format details) for the input source and output files of a completed job, for all keys or a specific output key.

Coconut Webhooks API

Configured per job via the notification object, Coconut POSTs JSON event payloads (input.transferred, output.completed, output.failed, job.completed, job.failed) to a caller-sup...

Collections

Coconut API

OPEN

Pricing Plans

Coconut Plans Pricing

2 plans

PLANS

Rate Limits

Coconut Rate Limits

3 limits

RATE LIMITS

FinOps

Coconut Finops

FINOPS

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Coconut API
  version: '2'
request:
  auth:
    type: basic
    username: '{{apiKey}}'
    password: ''
items:
- info:
    name: Jobs
    type: folder
  items:
  - info:
      name: Create a job
      type: http
    http:
      method: POST
      url: https://api.coconut.co/v2/jobs
      body:
        type: json
        data: "{\n  \"input\": {\n    \"url\": \"https://example.com/source.mp4\"\n  },\n  \"storage\": {\n    \"service\"\
          : \"s3\",\n    \"region\": \"us-east-1\",\n    \"bucket\": \"my-bucket\",\n    \"credentials\": {\n      \"access_key_id\"\
          : \"{{awsAccessKeyId}}\",\n      \"secret_access_key\": \"{{awsSecretAccessKey}}\"\n    }\n  },\n  \"outputs\":\
          \ {\n    \"mp4:720p\": { \"path\": \"/transcoded/video_720p.mp4\" },\n    \"jpg:300x\": { \"path\": \"/thumbs/thumb_#num#.jpg\"\
          , \"number\": 5 }\n  },\n  \"notification\": {\n    \"type\": \"http\",\n    \"url\": \"https://example.com/webhook\"\
          ,\n    \"events\": true,\n    \"metadata\": true\n  },\n  \"settings\": {\n    \"ultrafast\": false\n  }\n}"
    docs: Submit a new asynchronous encoding job defining input, storage, outputs, notification, and settings.
  - info:
      name: Retrieve a job
      type: http
    http:
      method: GET
      url: https://api.coconut.co/v2/jobs/:jobId
    docs: Retrieve a single job by id including status, progress, input status, and output URLs.
- info:
    name: Metadata
    type: folder
  items:
  - info:
      name: Retrieve all metadata for a job
      type: http
    http:
      method: GET
      url: https://api.coconut.co/v2/metadata/jobs/:jobId
    docs: Retrieve streams and format metadata for the input source and all outputs of a job.
  - info:
      name: Retrieve metadata for a specific key
      type: http
    http:
      method: GET
      url: https://api.coconut.co/v2/metadata/jobs/:jobId/:key
    docs: Retrieve metadata for a single source or output key (for example mp4:720p).