Skip to main content
POST
MCP extract_video_metadata calls this synchronous endpoint. For file downloads, prefer start_video_download, get_video_download, then prepare_video_download; the host saves/sends the returned ready URL. See MCP download workflow. For server-to-server use, send a Pirehub API key with the video:extract scope. See Authentication for OAuth support and credential handling.The response contains only normalized public metadata, an internal preview URL, and opaque short-lived download tokens. See the video extraction guide for normalized platform families, additional supported sites, token handling, limits, and responsible-use requirements.

Subscription-backed API keys

Paid self-service keys use shared owner credits and the plan’s per-second and concurrent-job limits. Successful results, including cache hits, consume the configured action cost; errors release the reservation. Video jobs settle at completion. Inspect X-ApiKey-Credit-* and X-ApiKey-RateLimit-*. An optional Idempotency-Key prevents repeated synchronous execution/debits; repeated operations return 409 rather than replaying a response. Job starts use requestId instead. See API plans and idempotency for costs, billing periods, headers, error codes and retry rules.

Authorizations

Authorization
string
header
required

OAuth 2.0 Authorization Code with PKCE, issued by Pirehub's Clerk authorization server. Request only the scopes required by the operation.

Headers

Idempotency-Key
string

Self-service keys only. Owner-scoped operation identifier; reuse after admission returns 409 without another debit or execution. USAGE_CONCURRENCY_EXCEEDED retains no new reservation: wait and retry with the same identifier and payload. No response replay. Video jobs use requestId instead.

Required string length: 1 - 80
Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json
url
string
required

A public HTTP or HTTPS media URL from a supported site. A missing scheme is normalized to HTTPS.

Minimum string length: 1
Examples:

"https://www.youtube.com/watch?v=VIDEO_ID"

"https://www.tiktok.com/@creator/video/VIDEO_ID"

"https://vimeo.com/VIDEO_ID"

"https://www.reddit.com/r/videos/comments/POST_ID/example/"

Response

The public video metadata and available secure download options were extracted.

success
boolean
required
data
object
required