Browse the documentation
Get YouTube Summary
Summary, key points and optional transcript for one cited YouTube URL. A brand whose run hasn't finished gets a 404 whose details carry its run_id, status and error_code.
GET
/youtube/summary
Query parameters
| Name | Type | Description |
|---|---|---|
| brand required | string | Tracked brand name, exactly as returned by listTrackedBrands. |
| url required | string | Full YouTube video URL. |
| include_transcript |
boolean
default False |
Include the full transcript text. |
Example request
curl -H "Authorization: Bearer $MENTIONBIRD_API_KEY" \
"https://api.mentionbird.ai/api/v1/youtube/summary?brand=Acme&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Daqz-KE-bpKQ"
Example response
Recorded from a live call against a demo workspace, so the shape is exactly what the endpoint returns.
{
"channel_title": "Acme",
"credits_charged": 5,
"domain": "youtube.com",
"key_points": [
"Start from the sales process"
],
"run_id": 1,
"status": "done",
"summarized_at": "2026-11-18T08:49:45.554264+00:00",
"summary_text": "A buyer's walkthrough of CRM selection criteria.",
"topics": [
"crm"
],
"transcript_text": null,
"url": "https://youtube.com/watch?v=aqz-KE-bpKQ",
"video_duration_s": 612,
"video_title": "How to Choose a CRM"
}
Responses
- 200
- YouTube summary detail.
- 400
- Validation error — check the message in `error.message`.
- 401
- Unauthorized — missing, invalid or revoked bearer token.
- 403
- Forbidden — the plan lacks API access, the key is read-only, or addTrackedBrand would pass the tracked-brand limit.
- 404
- Not found — the brand, prompt or resource does not exist.
- 405
- Method not allowed.
- 429
- Too many requests — over the key's per-minute or per-day limit. Wait the seconds in the `Retry-After` header, then retry.
- 500
- Internal error — logged; retry is safe for reads.