Ingest API (Video)｜SmartSTREAM Support Manual

Common Processing

Request Headers

Please refer here for request headers.

Remote Asset Ingest

You can create a video by specifying a source file accessible via http(s)://.

HTTP Request

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs

URL Parameters

Field	Type	Description	Example	Required
merchant_id	String	Merchant ID	nttsmc	Required

Request Body

Field	Type	Description	Required
source_url	String	Video source URL (http(s)://)	Required
job_profile_id	Integer	Job Profile ID	Required

Response

Field	Type	Description
id	String	Job ID
ref_id	String	Reference ID
name	String	Job Name
merchant_id	String	Merchant ID
job_profile_id	String	Job Profile ID
media_id	String	Media ID
description	String	Description
encode_status	Integer	Encoding Status
source_type	String	Source Type
source_url	String	Source URL
created_at	DateString	Created date and time
updated_at	DateString	Updated date and time

Error Codes

Status Code	Code	Message
400	BAD_REQUEST	Request parameter is invalid
401	UNAUTHORIZED	Authentication failed
404	JOB_PROFILE_NOT_FOUND	Job profile not found
404	STORAGE_NOT_FOUND	Storage not found
500	SERVER_ERROR	An unexpected error has occurred

Local File Ingest

You can upload and encode a local file specified with the curl command F option.

HTTP Request

POST https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs

URL Parameters

Field	Type	Description	Example	Required
merchant_id	String	Merchant ID	nttsmc	Required

Request Headers

Field	Type	Description	Required
Profile-Id	String	Job Profile ID	Not required (*)

* If omitted, encoding will be performed using the default profile.

Request Body

Field	Type	Description	Required
source_file	Hash	Video source file name	Required

Request Body Example

curl -H 'X-Streaks-Api-Key:<api-key>' 
        -H 'Authorization:Bearer <auth-token>' 
        -H 'Profile-Id: <profile_id>' 
        -XPOST https://ovp-s-api.smartstream.ne.jp/v1/merchants/smartstream/jobs 
        -F "source_file=@smartstream.mp4"

Response

Field	Type	Example
id	String	Job ID
ref_id	String	Reference ID
name	String	Job Name
merchant_id	String	Merchant ID
job_profile_id	String	Job Profile ID
media_id	String	Media ID
description	String	Description
encode_status	Integer	Encoding Status
source_type	String	Source Type
source_url	String	Source URL
created_at	DateString	Created date and time
updated_at	DateString	Updated date and time

Error Codes

Status Code	Code	Message
400	BAD_REQUEST	Invalid request parameters
401	UNAUTHORIZED	Authentication failed
404	JOB_PROFILE_NOT_FOUND	Job profile not found
404	STORAGE_NOT_FOUND	Storage not found
500	SERVER_ERROR	An unexpected error has occurred

Retrieve Job Information by ID or Reference ID

This API retrieves one job by specifying either the ID or the reference ID.

HTTP Request

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs/:job_id

OR

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs/ref:ref_id

URL Parameters

Field	Type	Description	Example	Required
merchant_id	String	Merchant ID	nttsmc	Required
job_id	String	Job ID	*****	Either job_id or ref_id is required
ref_id	String	Reference ID	job_1

Response

Field	Type	Description
id	String	Job ID
ref_id	String	Reference ID
name	String	Job Name
merchant_id	String	Merchant ID
job_profile_id	String	Job Profile ID
media_id	String	Media ID
description	String	Description
encode_status	Integer	Encoding Status
source_type	String	Source Type
source_url	String	Source URL
created_at	DateString	Created date and time
updated_at	DateString	Updated date and time

Error Codes

Status Code	Code	Message
401	UNAUTHORIZED	Authentication failed
404	JOB_NOT_FOUND	The specified job does not exist
500	SERVER_ERROR	An unexpected error has occurred

Retrieve Job Information List

API to retrieve a list of job information.

HTTP Request

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/jobs

URL Parameters

Field	Type	Description	Example	Required
merchant_id	String	Merchant ID	nttsmc	Required

Query Parameters

Field	Type	Description	Example
limit	Integer	Number of items to retrieve	30
page	Integer	Page number	1
sort	String	Sort column	updated_at
order	String	Sort order	ASC

Response

Field	Type	Description
id	String	Job ID
ref_id	String	Reference ID
name	String	Job Name
merchant_id	String	Merchant ID
job_profile_id	String	Job Profile ID
media_id	String	Media ID
description	String	Description
encode_status	Integer	Encoding Status
source_type	String	Source Type
source_url	String	Source URL
created_at	DateString	Created date and time
updated_at	DateString	Updated date and time

Error Codes

Status Code	Code	Message
400	BAD_REQUEST	Invalid request parameters
401	UNAUTHORIZED	Authentication failed
500	SERVER_ERROR	An unexpected error has occurred

Retrieve Job Profile Information by ID or Reference ID

API to retrieve a single profile by specifying ID or reference ID.

HTTP Request

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/job_profiles/:job_profile_id

OR

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/job_profiles/ref:ref_id

URL Parameters

Field	Type	Description	Example	Required
merchant_id	String	Merchant ID	nttsmc	Required
job_profile_id	String	Job Profile ID	*****	Either job_profile_id or ref_id is required
ref_id	String	Reference ID	job_profile_1

Response

Field	Type	Description
merchant_id	String	Merchant ID
id	String	Job Profile ID
ref_id	String	Reference ID
name	String	Job profile name
description	String	Description
created_at	String	Created date and time
updated_at	String	Updated date and time

Error Codes

Status Code	Code	Message
401	UNAUTHORIZED	Authentication failed
404	JOB_PROFILE_NOT_FOUND	The specified job profile does not exist
500	SERVER_ERROR	An unexpected error has occurred

Retrieve Job Profile Information List

API to retrieve a list of job information.

HTTP Request

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/job_profiles

URL Parameters

Field	Type	Description	Example	Required
merchant_id	String	Merchant ID	nttsmc	Required

Query Parameters

Field	Type	Description	Example
limit	Integer	Number of items to retrieve	30
page	Integer	Page number	1
sort	String	Sort column	updated_at
order	String	Sort order	ASC

Response

Field	Type	Description
merchant_id	String	Merchant ID
id	String	Job Profile ID
ref_id	String	Reference ID
name	String	Job profile ID
description	String	Description
created_at	String	Created date and time
updated_at	String	Updated date and time

Response Example

HTTP/1.1 200 OK
{
  "count": 30,
  "job_profiles":
    [
      {<job_profile1 fields>},
      {<job_profile2 fields>},
      ...
    ]
}

Error Codes

Status Code	Code	Message
400	BAD_REQUEST	Invalid request parameters
401	UNAUTHORIZED	Authentication failed
500	SERVER_ERROR	An unexpected error has occurred