program

program retrieve

GET

https://odkmedia.io/odx/api/v2

/program/{slug}/

program retrieve › path Parameters

slug

string · required

program retrieve › query Parameters

debug

string

If value is "on", debug is included in response.

program retrieve › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

program retrieve › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2Program

GET/program/{slug}/

curl https://odkmedia.io/odx/api/v2/program/:slug \
  --header 'Service-Name: <string>' \
  --header 'Authorization: <api-key>'

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "age_rating": {
      "is_block": true,
      "label": "All",
      "name": "All"
    },
    "badges": {
      "bottom_left": "bottom_left",
      "bottom_right": "bottom_right",
      "top_left": "top_left",
      "top_right": "top_right"
    },
    "categories": [
      {
        "id": 0,
        "slug": "slug",
        "title": "title"
      }
    ],
    "default_sales_type": "GUEST",
    "direct_play_episode": {
      "id": 0,
      "sales_type": "GUEST",
      "slug": "slug"
    },
    "direct_play_episode_id": 0,
    "genres": [
      {
        "id": 0,
        "slug": "slug",
        "title": "title"
      }
    ],
    "id": 0,
    "images": {
      "poster": "https://www.example.com/path/to/resource",
      "poster_landscape": "https://www.example.com/path/to/resource",
      "poster_portrait": "https://www.example.com/path/to/resource"
    },
    "is_coming_soon": true,
    "is_favorite": true,
    "kinds_of_episodes": [
      "series"
    ],
    "meta": {
      "cc_languages": [
        "ko"
      ],
      "episode_total": 0,
      "hide_ep_date": true,
      "produce_countries": [
        "KR"
      ],
      "running_time": 0
    },
    "partner": "partner",
    "people": [
      {
        "info": {},
        "name": "name",
        "role": "role",
        "slug": "slug"
      }
    ],
    "ppv": {
      "currency": "currency",
      "price": 0,
      "product_code": "product_code",
      "tier": "tier"
    },
    "produce_year": 0,
    "publish_start": "2022-08-02T00:00:00Z",
    "release_status": "coming-soon",
    "secondary_title": "secondary_title",
    "seo_keyword": "seo_keyword",
    "seo_synopsis": "seo_synopsis",
    "seo_title": "seo_title",
    "service_name": "odk",
    "slug": "slug",
    "synopsis": "synopsis",
    "title": "title",
    "user_payment": {
      "can_apply_trial": true,
      "is_ppv_purchased": true,
      "pay_per_view": {
        "expired_at": "2024-08-25T15:00:00Z",
        "is_purchased": true
      },
      "ppv_expired_at": "2024-08-25T15:00:00Z",
      "subscription": {
        "can_apply_trial": true,
        "type": "basic"
      },
      "subscription_type": "basic"
    },
    "uuid": "00000000-0000-0000-0000-000000000000"
  }
}

json

application/json

program episodes list

GET

https://odkmedia.io/odx/api/v2

/program/{slug}/episodes/

program episodes list › path Parameters

slug

string · required

program episodes list › query Parameters

debug

string

If value is "on", debug is included in response.

kind

string[]

You can pass several kinds, e.g. kind=series,main.

Enum values:

series

main

trailer

additional

clip

page

integer

The default value is 1

page_size

integer

The default value is 10

program episodes list › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

program episodes list › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

listResult

title

title

playback programs

program retrieve

GET

https://odkmedia.io/odx/api/v2

/program/{slug}/

program retrieve › path Parameters

slug

string · required

program retrieve › query Parameters

debug

string

If value is "on", debug is included in response.

program retrieve › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

program retrieve › Responses

200

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

title

title

OdxV2Program

program episodes list

GET

https://odkmedia.io/odx/api/v2

/program/{slug}/episodes/

program episodes list › path Parameters

slug

string · required

program episodes list › query Parameters

debug

string

If value is "on", debug is included in response.

kind

string[]

You can pass several kinds, e.g. kind=series,main.

Enum values:

series

main

trailer

additional

clip

page

integer

The default value is 1

page_size

integer

The default value is 10

program episodes list › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

program episodes list › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

messages

listResult

title

title