/iqiyi/videos

POST /api/iqiyi/videos

Price: 1 credit

Get one iQIYI video — an episode, film cut, trailer or clip — by its id or iq.com play URL. Returns the video title and episode order, its parent album, runtime in seconds, synopsis, cast with their credits, genre and region tags, VIP and exclusivity flags, publication dates, artwork and the country codes it may be played in.

How to use it

Use this for one playable item; the series or film it belongs to is /iqiyi/albums, and passing an album id here returns 412 rather than its first episode. A film is the one exception to that: it has no video record of its own, so its play URL carries the album's id and returns 412 here too — read a film from /iqiyi/albums instead. Episodes carry `cast` and `tags` only occasionally; the parent album carries both.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• lang string — Language of the titles, synopses and tag names in the response (default: "en_us"; one of: "en_us", "zh_cn", "zh_tw", "ar_ae", "vi_vn", "th_th", "pt_br", "ms_my", "id_id", "es_mx")
• market string — Storefront whose catalogue and licensing the request is answered for (default: "us"; one of: "ae", "ar", "au", "bh", "bn", "br", "ca", "cl", "co", "de", "eg", "es", "fr", "gb", "hk", "id", "in", "jp", "kh", "kr", "kw", "kz", "la", "mm", "mo", "mx", "my", "nz", "om", "pe", "ph", "pt", "qa", "sa", "sg", "th", "ua", "us", "vn")
• video string required — Video numeric id, short id or iq.com play URL (examples: "1170059162663100", "c3hbjhxtcg", "https://www.iq.com/play/knot-episode-1-c3hbjhxtcg"; minLength: 1)

Response

• @type string (default: "IqiyiVideo")
• id string required
• alias string nullable
• name string nullable
• short_name string nullable
• subtitle string nullable
• description string nullable
• tagline string nullable
• url string nullable
• album_id string nullable
• album_alias string nullable
• album_name string nullable
• album_description string nullable
• album_url string nullable
• channel string nullable
• channel_id string nullable
• episode_order integer nullable
• season integer nullable
• duration integer nullable
• is_series boolean (default: false)
• is_short boolean (default: false)
• is_exclusive boolean (default: false)
• is_iqiyi_produced boolean (default: false)
• is_dolby boolean (default: false)
• is_1080p boolean (default: false)
• is_3d boolean (default: false)
• is_vip boolean (default: false)
• is_tvod boolean (default: false)
• is_coupon boolean (default: false)
• is_package boolean (default: false)
• pay_mark string nullable
• content_rating string nullable
• content_warning string nullable
• publish_date string nullable
• published_at integer nullable
• issued_at integer nullable
• image string nullable
• cover string nullable
• cast array (default: [])
  • @type string (default: "IqiyiCastMember")
  • id string required
  • name string nullable
  • credit string nullable
  • role string nullable
  • character string nullable
  • image string nullable
  • profile_url string nullable
• tags array (default: [])
  • @type string (default: "IqiyiTag")
  • id string required
  • name string nullable
  • group string nullable
• hdr_formats array (default: [])
• collection_ids array (default: [])
• allowed_regions array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No video with this id Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.