Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
78 lines (63 sloc) 5.02 KB

Add Embedded Media To Job

Add a piece of media to an existing job via a non-direct URL. A job may only have a single piece of media associated with it, attempting to add additional media will return an error code.

Use this option to link to a video hosted by providers like BrightCove, Kaltura, Youtube, or Vimeo.

HTTP Method

.. http:get:: /api/job/add_media_url

Query String Parameters — Required

Name Details
v Description The version of the API to use
Allowed Values 1
Example v=1
api_token Description The API token used for this session
Allowed Values Hex String
Example api_token=7ca5dc5c7cce449fb0fff719307e8f5f
job_id Description The ID of the job
Allowed Values Hex String
Example job_id=64bea283eff6475ea6596027a6ba0929
media_url Description The URL from which media will be obtained
Allowed Values URL Encoded String
Example media_url=http%3A%2F%2Fyoutu.be%2F5m5MPiL99Nc

Responses

HTTP Code Details
200 Description Success
Contents
{
  "TaskId" : "Encoded Task ID"
}
400 Description An error occurred
Contents Error description (see :ref:`error-format-label` for details)

Example Requests

GET /api/job/add_media_url?v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f
&job_id=64bea283eff6475ea6596027a6ba0929
&media_url=http%3A%2F%2Fyoutu.be%2F5m5MPiL99Nc HTTP/1.1
Host: api.cielo24.com

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{ "TaskId" : "41ec7d23fb4b45f9b48a13d0b7283bf2" }