> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scraperize.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Clip
> Fetches a public Twitch clip by its URL and returns everything about it as clean JSON: title, view count, language, created date, duration, and where in the broadcast it was taken from; the broadcaster (with follower count) and the curator who clipped it; the game/category with box art; the source broadcast and VOD; and every video rendition (quality, frame rate, codec, bitrate, dimensions) with a ready-to-use, time-limited download URL (see `downloadExpiresAt`). Only publicly available data is returned.
**Cost: 1 credit** per successful request. Errors and cache hits (`cache_max_age`) are free.
Paste this into ChatGPT, Claude or your coding assistant to generate working code for this endpoint (use the copy button).
```text Prompt
I want to make an API call to /v1/twitch/clip. Here are the details:
Endpoint: GET https://api.scraperize.com/v1/twitch/clip
Description: Fetches a public Twitch clip by its URL and returns everything about it as clean JSON: title, view count, language, created date, duration, and where in the broadcast it was taken from; the broadcaster (with follower count) and the curator who clipped it; the game/category with box art; the source broadcast and VOD; and every video rendition (quality, frame rate, codec, bitrate, dimensions) with a ready-to-use, time-limited download URL (see `downloadExpiresAt`). Only publicly available data is returned.
Required Headers:
- x-api-key: Your API key
Parameters:
- url (string) [required]: The Twitch clip URL, e.g. `https://www.twitch.tv/ishowspeed/clip/SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi`. Also accepts a `clips.twitch.tv` link or a bare clip slug.
- cache_max_age (select): Optional. Return a cached result if one this age or newer exists — served for **0 credits** with `meta.cached=true` and `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and refreshes the cache. Omit to always scrape fresh.
Example Response:
{
"data": {
"clip": {
"id": "3428043031",
"slug": "SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi",
"url": "https://www.twitch.tv/ishowspeed/clip/SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi",
"embedUrl": "https://clips.twitch.tv/embed?clip=SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi",
"title": "nick eh 30",
"viewCount": 14271,
"language": "EN",
"createdAt": "2026-09-21T21:40:51Z",
"durationSeconds": 30,
"videoOffsetSeconds": null,
"isFeatured": false,
"isPublished": true,
"hasCaptions": true,
"isCommentsEnabled": true,
"commentCount": 5,
"thumbnailUrl": "https://static-cdn.jtvnw.net/twitch-video-assets/twitch-vap-video-assets-prod-us-west-2/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/thumb/thumb-0000000000-19…",
"broadcaster": {
"id": "220476955",
"login": "ishowspeed",
"displayName": "IShowSpeed",
"url": "https://www.twitch.tv/ishowspeed",
"profileImageUrl": "https://static-cdn.jtvnw.net/jtv_user_pictures/46a38d3a-a39c-4c43-ac12-c331b1c469c2-profile_image-150x150.png",
"primaryColorHex": "FF4747",
"isPartner": true,
"followerCount": 6223177
},
"curator": {
"id": "559630290",
"login": "iferdx21",
"displayName": "iferdx21",
"url": "https://www.twitch.tv/iferdx21",
"profileImageUrl": "https://static-cdn.jtvnw.net/jtv_user_pictures/1761f18d-598a-40d8-ae86-ce01ad507409-profile_image-150x150.png"
},
"game": {
"id": "33214",
"name": "Fortnite",
"slug": "fortnite",
"boxArtUrl": "https://static-cdn.jtvnw.net/ttv-boxart/33214-144x192.jpg"
},
"broadcast": {
"id": "320423010140",
"title": null
},
"sourceVideo": null,
"videoQualities": [
{
"quality": "1080",
"frameRate": 60,
"bitrate": null,
"codecs": null,
"videoCodec": null,
"width": null,
"height": null,
"sourceUrl": "https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/h264/1080/index.mp4",
"downloadUrl": "https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/h264/1080/index.mp4?sig=8808ae981d7a1925695b9170aab1f3061f74a511&toke…"
}
],
"assets": [
{
"id": "ed02fecf-0fc5-427b-ba49-43fcd7410dfa/LANDSCAPE",
"aspectRatio": 1.7777777777777777,
"createdAt": "2026-09-21T21:40:51.479066948Z",
"thumbnailUrl": "https://static-cdn.jtvnw.net/twitch-video-assets/twitch-vap-video-assets-prod-us-west-2/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/thumb/thumb-0000000000-19…",
"videoQualities": [
{
"quality": "1080",
"frameRate": 60,
"bitrate": 2229058,
"codecs": "hvc1.1.6.L123.90",
"videoCodec": "HEVC",
"width": 1920,
"height": 1080,
"sourceUrl": "https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/hevc/source/index.mp4",
"downloadUrl": "https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/hevc/source/index.mp4?sig=8808ae981d7a1925695b9170aab1f3061f74a511&to…"
}
]
}
],
"downloadExpiresAt": "2026-10-06T10:46:48.000Z"
},
"fetchedAt": "2026-10-05T14:46:48.242Z"
},
"meta": {
"requestId": "req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f",
"creditsCharged": 1,
"creditsRemaining": 4999,
"cached": false
}
}
Please help me write code in my preferred programming language to make this API call and handle the response appropriately. Include error handling and best practices.
```
## OpenAPI
````yaml /api-reference/openapi.json get /v1/twitch/clip
openapi: 3.0.3
info:
title: Scraperize API
version: 1.0.0
description: >-
Extract public data from social media platforms as clean JSON. Endpoints are
split by platform and by what they return, e.g. `GET /v1/twitter/tweet`.
## Authentication
Send your API key in the `x-api-key` header (or `Authorization: Bearer
`). Create keys in your dashboard.
## Credits
Each successful live scrape costs **1 credit**. Credits are prepaid and
never expire.
## Caching
Every endpoint accepts an optional `cache_max_age`
(`1d`|`3d`|`7d`|`14d`|`30d`). A cache hit within that window is returned for
**0 credits**.
## Responses
Success returns `{ "data": …, "meta": { "requestId", … } }`. Errors return
`{ "error": { "code", "message", "requestId" } }` with a matching HTTP
status. `meta` on a scrape carries `creditsCharged`, `creditsRemaining`,
`cached`, and (on a hit) `cachedAt`.
## Rate limits
Requests are limited per team per minute; over the limit returns `429` with
a `Retry-After` header.
servers:
- url: https://api.scraperize.com
description: Production
security:
- ApiKeyAuth: []
tags:
- name: Twitter
description: Twitter / X scraping endpoints
- name: Facebook
description: Facebook scraping endpoints
- name: Linkme
description: Linkme (link.me) scraping endpoints
- name: Amazon
description: Amazon (creator shop / storefront) scraping endpoints
- name: Linkbio
description: Linkbio (lnk.bio) scraping endpoints
- name: Pillar
description: Pillar (pillar.io) scraping endpoints
- name: Komi
description: Komi (komi.io) scraping endpoints
- name: Linktree
description: Linktree (linktr.ee) scraping endpoints
- name: Kick
description: Kick (kick.com) scraping endpoints
- name: Snapchat
description: Snapchat (snapchat.com) scraping endpoints
- name: Telegram
description: Telegram (t.me) scraping endpoints
- name: LinkedIn
description: LinkedIn scraping endpoints
- name: Twitch
description: Twitch scraping endpoints
- name: TikTok
description: TikTok (tiktok.com) scraping endpoints
paths:
/v1/twitch/clip:
get:
tags:
- Twitch
summary: Clip
description: >-
Fetches a public Twitch clip by its URL and returns everything about it
as clean JSON: title, view count, language, created date, duration, and
where in the broadcast it was taken from; the broadcaster (with follower
count) and the curator who clipped it; the game/category with box art;
the source broadcast and VOD; and every video rendition (quality, frame
rate, codec, bitrate, dimensions) with a ready-to-use, time-limited
download URL (see `downloadExpiresAt`). Only publicly available data is
returned.
parameters:
- name: url
in: query
required: true
description: >-
The Twitch clip URL, e.g.
`https://www.twitch.tv/ishowspeed/clip/SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi`.
Also accepts a `clips.twitch.tv` link or a bare clip slug.
schema:
type: string
example: >-
https://www.twitch.tv/ishowspeed/clip/SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi
- name: cache_max_age
in: query
required: false
description: >-
Optional. Return a cached result if one this age or newer exists —
served for **0 credits** with `meta.cached=true` and
`meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and
refreshes the cache. Omit to always scrape fresh.
schema:
type: string
enum:
- 1d
- 3d
- 7d
- 14d
- 30d
example: 7d
responses:
'200':
description: The clip.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
clip:
type: object
nullable: true
fetchedAt:
type: string
format: date-time
meta:
type: object
description: >-
requestId + credit/caching metadata (creditsCharged,
creditsRemaining, cached, cachedAt).
required:
- data
- meta
example:
data:
clip:
id: '3428043031'
slug: SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi
url: >-
https://www.twitch.tv/ishowspeed/clip/SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi
embedUrl: >-
https://clips.twitch.tv/embed?clip=SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi
title: nick eh 30
viewCount: 14271
language: EN
createdAt: '2026-09-21T21:40:51Z'
durationSeconds: 30
videoOffsetSeconds: null
isFeatured: false
isPublished: true
hasCaptions: true
isCommentsEnabled: true
commentCount: 5
thumbnailUrl: >-
https://static-cdn.jtvnw.net/twitch-video-assets/twitch-vap-video-assets-prod-us-west-2/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/thumb/thumb-0000000000-1920x1080.jpg
broadcaster:
id: '220476955'
login: ishowspeed
displayName: IShowSpeed
url: https://www.twitch.tv/ishowspeed
profileImageUrl: >-
https://static-cdn.jtvnw.net/jtv_user_pictures/46a38d3a-a39c-4c43-ac12-c331b1c469c2-profile_image-150x150.png
primaryColorHex: FF4747
isPartner: true
followerCount: 6223177
curator:
id: '559630290'
login: iferdx21
displayName: iferdx21
url: https://www.twitch.tv/iferdx21
profileImageUrl: >-
https://static-cdn.jtvnw.net/jtv_user_pictures/1761f18d-598a-40d8-ae86-ce01ad507409-profile_image-150x150.png
game:
id: '33214'
name: Fortnite
slug: fortnite
boxArtUrl: >-
https://static-cdn.jtvnw.net/ttv-boxart/33214-144x192.jpg
broadcast:
id: '320423010140'
title: null
sourceVideo: null
videoQualities:
- quality: '1080'
frameRate: 60
bitrate: null
codecs: null
videoCodec: null
width: null
height: null
sourceUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/h264/1080/index.mp4
downloadUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/h264/1080/index.mp4?sig=8808ae981d7a1925695b9170aab1f3061f74a511&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnauth%2Fed02fecf-0fc5-427b-ba49-43fcd7410dfa%2Flandscape%2Fh264%2F720%2Findex.mp4%22%2C%22clip_slug%22%3A%22SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi%22%2C%22device_id%22%3Anull%2C%22expires%22%3A1791283608%2C%22user_id%22%3A%22%22%2C%22version%22%3A3%7D
- quality: '720'
frameRate: 60.0200080871582
bitrate: null
codecs: null
videoCodec: null
width: null
height: null
sourceUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/h264/720/index.mp4
downloadUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/h264/720/index.mp4?sig=8808ae981d7a1925695b9170aab1f3061f74a511&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnauth%2Fed02fecf-0fc5-427b-ba49-43fcd7410dfa%2Flandscape%2Fh264%2F720%2Findex.mp4%22%2C%22clip_slug%22%3A%22SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi%22%2C%22device_id%22%3Anull%2C%22expires%22%3A1791283608%2C%22user_id%22%3A%22%22%2C%22version%22%3A3%7D
- quality: '480'
frameRate: 30.0100040435791
bitrate: null
codecs: null
videoCodec: null
width: null
height: null
sourceUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/h264/480/index.mp4
downloadUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/h264/480/index.mp4?sig=8808ae981d7a1925695b9170aab1f3061f74a511&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnauth%2Fed02fecf-0fc5-427b-ba49-43fcd7410dfa%2Flandscape%2Fh264%2F720%2Findex.mp4%22%2C%22clip_slug%22%3A%22SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi%22%2C%22device_id%22%3Anull%2C%22expires%22%3A1791283608%2C%22user_id%22%3A%22%22%2C%22version%22%3A3%7D
assets:
- id: ed02fecf-0fc5-427b-ba49-43fcd7410dfa/LANDSCAPE
aspectRatio: 1.7777777777777777
createdAt: '2026-09-21T21:40:51.479066948Z'
thumbnailUrl: >-
https://static-cdn.jtvnw.net/twitch-video-assets/twitch-vap-video-assets-prod-us-west-2/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/thumb/thumb-0000000000-1920x1080.jpg
videoQualities:
- quality: '1080'
frameRate: 60
bitrate: 2229058
codecs: hvc1.1.6.L123.90
videoCodec: HEVC
width: 1920
height: 1080
sourceUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/hevc/source/index.mp4
downloadUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/hevc/source/index.mp4?sig=8808ae981d7a1925695b9170aab1f3061f74a511&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnauth%2Fed02fecf-0fc5-427b-ba49-43fcd7410dfa%2Flandscape%2Fh264%2F720%2Findex.mp4%22%2C%22clip_slug%22%3A%22SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi%22%2C%22device_id%22%3Anull%2C%22expires%22%3A1791283608%2C%22user_id%22%3A%22%22%2C%22version%22%3A3%7D
- quality: '720'
frameRate: 60
bitrate: 892982
codecs: hvc1.1.6.L120.90
videoCodec: HEVC
width: 1280
height: 720
sourceUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/hevc/720/index.mp4
downloadUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/hevc/720/index.mp4?sig=8808ae981d7a1925695b9170aab1f3061f74a511&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnauth%2Fed02fecf-0fc5-427b-ba49-43fcd7410dfa%2Flandscape%2Fh264%2F720%2Findex.mp4%22%2C%22clip_slug%22%3A%22SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi%22%2C%22device_id%22%3Anull%2C%22expires%22%3A1791283608%2C%22user_id%22%3A%22%22%2C%22version%22%3A3%7D
- quality: '480'
frameRate: 30
bitrate: 353545
codecs: hvc1.1.6.L90.90
videoCodec: HEVC
width: 854
height: 480
sourceUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/hevc/480/index.mp4
downloadUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/landscape/hevc/480/index.mp4?sig=8808ae981d7a1925695b9170aab1f3061f74a511&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnauth%2Fed02fecf-0fc5-427b-ba49-43fcd7410dfa%2Flandscape%2Fh264%2F720%2Findex.mp4%22%2C%22clip_slug%22%3A%22SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi%22%2C%22device_id%22%3Anull%2C%22expires%22%3A1791283608%2C%22user_id%22%3A%22%22%2C%22version%22%3A3%7D
- id: ed02fecf-0fc5-427b-ba49-43fcd7410dfa/PORTRAIT
aspectRatio: 0.5625
createdAt: '2026-09-21T21:40:51.479066948Z'
thumbnailUrl: >-
https://static-cdn.jtvnw.net/twitch-video-assets/twitch-vap-video-assets-prod-us-west-2/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/portrait/thumb/thumb-0000000000-153x272.jpg
videoQualities:
- quality: '1296'
frameRate: 60
bitrate: 2736706
codecs: hvc1.1.6.L150.90
videoCodec: HEVC
width: 1296
height: 2304
sourceUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/portrait/hevc/source/index.mp4
downloadUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/portrait/hevc/source/index.mp4?sig=8808ae981d7a1925695b9170aab1f3061f74a511&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnauth%2Fed02fecf-0fc5-427b-ba49-43fcd7410dfa%2Flandscape%2Fh264%2F720%2Findex.mp4%22%2C%22clip_slug%22%3A%22SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi%22%2C%22device_id%22%3Anull%2C%22expires%22%3A1791283608%2C%22user_id%22%3A%22%22%2C%22version%22%3A3%7D
- quality: '720'
frameRate: 60
bitrate: 974194
codecs: hvc1.1.6.L120.90
videoCodec: HEVC
width: 720
height: 1280
sourceUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/portrait/hevc/720/index.mp4
downloadUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/portrait/hevc/720/index.mp4?sig=8808ae981d7a1925695b9170aab1f3061f74a511&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnauth%2Fed02fecf-0fc5-427b-ba49-43fcd7410dfa%2Flandscape%2Fh264%2F720%2Findex.mp4%22%2C%22clip_slug%22%3A%22SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi%22%2C%22device_id%22%3Anull%2C%22expires%22%3A1791283608%2C%22user_id%22%3A%22%22%2C%22version%22%3A3%7D
- quality: '480'
frameRate: 30
bitrate: 418775
codecs: hvc1.1.6.L90.90
videoCodec: HEVC
width: 480
height: 854
sourceUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/portrait/hevc/480/index.mp4
downloadUrl: >-
https://d1ndex63qxojbr.cloudfront.net/nauth/ed02fecf-0fc5-427b-ba49-43fcd7410dfa/portrait/hevc/480/index.mp4?sig=8808ae981d7a1925695b9170aab1f3061f74a511&token=%7B%22authorization%22%3A%7B%22forbidden%22%3Afalse%2C%22reason%22%3A%22%22%7D%2C%22clip_uri%22%3A%22https%3A%2F%2Fd1ndex63qxojbr.cloudfront.net%2Fnauth%2Fed02fecf-0fc5-427b-ba49-43fcd7410dfa%2Flandscape%2Fh264%2F720%2Findex.mp4%22%2C%22clip_slug%22%3A%22SavageCrazyBunnyPunchTrees-zmhBSGkmHAFb_nWi%22%2C%22device_id%22%3Anull%2C%22expires%22%3A1791283608%2C%22user_id%22%3A%22%22%2C%22version%22%3A3%7D
downloadExpiresAt: '2026-10-06T10:46:48.000Z'
fetchedAt: '2026-10-05T14:46:48.242Z'
meta:
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
creditsCharged: 1
creditsRemaining: 4999
cached: false
'401':
description: Missing, invalid, or revoked API key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UNAUTHORIZED
message: API key required — pass it in the `x-api-key` header.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'402':
description: Not enough credits for this request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: INSUFFICIENT_CREDITS
message: >-
This request costs 1 credit, but your balance is 0. Top up
to continue.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'404':
description: No public Twitch clip found for that URL.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: NOT_FOUND
message: >-
The requested content was not found (it may not exist, be
deleted, or be private).
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'422':
description: Invalid query parameters (missing or unrecognisable clip URL).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: VALIDATION_ERROR
message: Request validation failed
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
details:
- path: url
message: Required
'429':
description: Over the per-minute rate limit — honour `Retry-After`.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: RATE_LIMITED
message: >-
Rate limit exceeded — max 100 requests per 60s. Retry in
~30s.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
'503':
description: >-
Temporarily unavailable — retry after `Retry-After`. `error.code`
tells you why: `UPSTREAM_BLOCKED` (the source blocked this request),
`EXTRACTION_FAILED` (the source returned unexpected data),
`PLATFORM_UNAVAILABLE` (the source is down), or
`SERVICE_UNAVAILABLE` (we are at capacity).
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: UPSTREAM_BLOCKED
message: >-
The source is temporarily unavailable. Please try again
shortly.
requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
components:
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: NOT_FOUND
message:
type: string
example: The requested content was not found.
requestId:
type: string
example: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
details:
type: array
items:
type: object
description: Present on validation errors.
required:
- code
- message
- requestId
required:
- error
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
Your API key. Send it in the `x-api-key` header (or `Authorization:
Bearer `). Create and manage keys from your dashboard.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.