Skip to content
MentionBird.ai
Browse the documentation

Summarize a YouTube Video

Summarize a YouTube video the brand's answers cite, spending credits: 1 per 5 minutes of video, rounded up, at most 24, charged when the run starts and refunded if it fails. The run usually takes about a minute, so this answers at once with run_id and status; read the result with getYouTubeSummary. A video the brand already has a summary of comes back free, as does a run in progress. A video that can't be summarized, or an account that can't pay, comes back with status error and an error_code; none of these starts a run or charges anything. started is true only when this call started one, and credits is what it spends. Requires a write-enabled API key.

POST /youtube/summaries

Request body

Send as application/json. This endpoint needs a write-enabled API key.

Field Type Description
brand required string Tracked brand name.
url required string The YouTube URL as cited.

Example request

curl -X POST -H "Authorization: Bearer $MENTIONBIRD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "brand": "Acme",
  "url": "Acme"
}' \
  "https://api.mentionbird.ai/api/v1/youtube/summaries"

Responses

200
The run started, or the existing run returned.
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.