{"openapi":"3.0.3","info":{"title":"Project API","description":"Public social data. Operation-specific contracts below describe the supported inputs and outputs.","version":"1.1.0"},"components":{"securitySchemes":{"accessKey":{"type":"apiKey","in":"header","name":"x-access-key","description":"Project access key from your dashboard. Prefer the x-access-key header."}},"schemas":{}},"paths":{"/instagram/stats":{"get":{"operationId":"getInstagramStats","summary":"Instagram Stats","tags":["Instagram"],"description":"Get engagement metrics and metadata for an Instagram post or reel. Views are optional by default: returns media immediately with null for unavailable views. Set requireViews=true to require a verified count; unavailable strict requests return 503 without a charge.","parameters":[{"schema":{"type":"string"},"in":"query","name":"url","required":true,"description":"Full URL of the resource"},{"schema":{"type":"string"},"in":"query","name":"access_key","required":false,"description":"Project access key (also accepted as x-access-key header)"},{"schema":{"enum":[true,false,"true","false","1","0"]},"in":"query","name":"requireViews","required":false,"description":"Require verified video views. Defaults to false; optional mode skips view-only recovery."}],"responses":{"200":{"description":"Post stats retrieved successfully","content":{"application/json":{"schema":{"description":"Post stats retrieved successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"postUrl":{"type":"string"},"id":{"type":"string"},"shortcode":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"views":{"type":"integer","nullable":true},"videoUrl":{"type":"string","description":"Temporary Instagram video CDN URL"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer","nullable":true,"description":"Unavailable from the current Instagram extractor; returns null."},"publishedAt":{"type":"string"},"author":{"type":"string"},"authorLink":{"type":"string"},"duration":{"type":"string","nullable":true},"thumbnail":{"type":"string"},"isVideo":{"type":"boolean"},"contentType":{"type":"string"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","enum":["content_restricted"],"description":"Present when Instagram explicitly restricts access to this content."},"retryable":{"type":"boolean","enum":[false],"description":"A retry cannot resolve a confirmed content restriction."}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","enum":["instagram_login_required","instagram_media_unavailable"],"description":"Anonymous retrieval encountered a login wall or exhausted its media sources."},"retryable":{"type":"boolean","enum":[true],"description":"A later bounded retry may help; this does not establish a permanent content restriction."}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"post":{"operationId":"postInstagramStats","summary":"Instagram Stats","tags":["Instagram"],"description":"Get engagement metrics and metadata for an Instagram post or reel. Views are optional by default: returns media immediately with null for unavailable views. Set requireViews=true to require a verified count; unavailable strict requests return 503 without a charge.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Full URL of the resource"},"access_key":{"type":"string","description":"Project access key (also accepted as x-access-key header)"},"requireViews":{"enum":[true,false,"true","false","1","0"],"description":"Require verified video views. Defaults to false; optional mode skips view-only recovery."}},"nullable":true,"required":["url"]}}}},"responses":{"200":{"description":"Post stats retrieved successfully","content":{"application/json":{"schema":{"description":"Post stats retrieved successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"postUrl":{"type":"string"},"id":{"type":"string"},"shortcode":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"views":{"type":"integer","nullable":true},"videoUrl":{"type":"string","description":"Temporary Instagram video CDN URL"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer","nullable":true,"description":"Unavailable from the current Instagram extractor; returns null."},"publishedAt":{"type":"string"},"author":{"type":"string"},"authorLink":{"type":"string"},"duration":{"type":"string","nullable":true},"thumbnail":{"type":"string"},"isVideo":{"type":"boolean"},"contentType":{"type":"string"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","enum":["content_restricted"],"description":"Present when Instagram explicitly restricts access to this content."},"retryable":{"type":"boolean","enum":[false],"description":"A retry cannot resolve a confirmed content restriction."}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","enum":["instagram_login_required","instagram_media_unavailable"],"description":"Anonymous retrieval encountered a login wall or exhausted its media sources."},"retryable":{"type":"boolean","enum":[true],"description":"A later bounded retry may help; this does not establish a permanent content restriction."}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}}},"/instagram/channel-stats":{"get":{"operationId":"getInstagramChannelStats","summary":"Instagram Channel Stats","tags":["Instagram"],"description":"Get stats and metadata for an Instagram profile.","parameters":[{"schema":{"type":"string"},"in":"query","name":"url","required":true,"description":"Full URL of the resource"},{"schema":{"type":"string"},"in":"query","name":"access_key","required":false,"description":"Project access key (also accepted as x-access-key header)"}],"responses":{"200":{"description":"Profile stats retrieved successfully","content":{"application/json":{"schema":{"description":"Profile stats retrieved successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"profileUrl":{"type":"string"},"userId":{"type":"string"},"username":{"type":"string"},"fullName":{"type":"string"},"verified":{"type":"boolean"},"followers":{"type":"integer"},"following":{"type":"integer"},"totalPosts":{"type":"integer"},"bio":{"type":"string"},"avatar":{"type":"string"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"post":{"operationId":"postInstagramChannelStats","summary":"Instagram Channel Stats","tags":["Instagram"],"description":"Get stats and metadata for an Instagram profile.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Full URL of the resource"},"access_key":{"type":"string","description":"Project access key (also accepted as x-access-key header)"}},"nullable":true,"required":["url"]}}}},"responses":{"200":{"description":"Profile stats retrieved successfully","content":{"application/json":{"schema":{"description":"Profile stats retrieved successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"profileUrl":{"type":"string"},"userId":{"type":"string"},"username":{"type":"string"},"fullName":{"type":"string"},"verified":{"type":"boolean"},"followers":{"type":"integer"},"following":{"type":"integer"},"totalPosts":{"type":"integer"},"bio":{"type":"string"},"avatar":{"type":"string"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}}},"/instagram/channel-posts":{"get":{"operationId":"getInstagramChannelPosts","summary":"Instagram Channel Posts","tags":["Instagram"],"description":"Get recent posts from an Instagram profile's feed.","parameters":[{"schema":{"type":"string"},"in":"query","name":"url","required":true,"description":"Full URL of the resource"},{"schema":{"type":"integer"},"in":"query","name":"limit","required":false,"description":"Maximum number of results to return"},{"schema":{"type":"string"},"in":"query","name":"access_key","required":false,"description":"Project access key (also accepted as x-access-key header)"}],"responses":{"200":{"description":"Channel posts retrieved successfully","content":{"application/json":{"schema":{"description":"Channel posts retrieved successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"profileUrl":{"type":"string"},"username":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"shortcode":{"type":"string"},"url":{"type":"string"},"type":{"type":"string"},"caption":{"type":"string"},"likes":{"type":"integer"},"comments":{"type":"integer"},"views":{"type":"integer"},"timestamp":{"type":"integer"},"thumbnailUrl":{"type":"string"},"imageCollection":{"type":"object","required":["status","order","sourceMediaCount","items"],"properties":{"status":{"type":"string","enum":["complete","partial","unavailable","unknown","not_applicable"],"description":"Image metadata coverage, not a guarantee that temporary URLs remain retrievable."},"order":{"type":"string","enum":["source","unknown"]},"sourceMediaCount":{"type":"integer","nullable":true,"minimum":1,"description":"Original media count including videos, or null when unknown."},"items":{"type":"array","items":{"type":"object","required":["id","position","url","status"],"properties":{"id":{"type":"string","nullable":true},"position":{"type":"integer","nullable":true,"minimum":1,"description":"One-based original slot, including skipped video slots; null when not provable."},"url":{"type":"string","nullable":true,"description":"Temporary upstream image URL, not permanent storage."},"status":{"type":"string","enum":["available","unavailable"]}}}}}},"author":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"fullName":{"type":"string"},"isVerified":{"type":"boolean"},"profilePicUrl":{"type":"string"}}}}}},"count":{"type":"integer"},"hasMore":{"type":"boolean"},"cursor":{"type":"string"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"post":{"operationId":"postInstagramChannelPosts","summary":"Instagram Channel Posts","tags":["Instagram"],"description":"Get recent posts from an Instagram profile's feed.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Full URL of the resource"},"limit":{"type":"integer","description":"Maximum number of results to return"},"access_key":{"type":"string","description":"Project access key (also accepted as x-access-key header)"}},"nullable":true,"required":["url"]}}}},"responses":{"200":{"description":"Channel posts retrieved successfully","content":{"application/json":{"schema":{"description":"Channel posts retrieved successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"profileUrl":{"type":"string"},"username":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"shortcode":{"type":"string"},"url":{"type":"string"},"type":{"type":"string"},"caption":{"type":"string"},"likes":{"type":"integer"},"comments":{"type":"integer"},"views":{"type":"integer"},"timestamp":{"type":"integer"},"thumbnailUrl":{"type":"string"},"imageCollection":{"type":"object","required":["status","order","sourceMediaCount","items"],"properties":{"status":{"type":"string","enum":["complete","partial","unavailable","unknown","not_applicable"],"description":"Image metadata coverage, not a guarantee that temporary URLs remain retrievable."},"order":{"type":"string","enum":["source","unknown"]},"sourceMediaCount":{"type":"integer","nullable":true,"minimum":1,"description":"Original media count including videos, or null when unknown."},"items":{"type":"array","items":{"type":"object","required":["id","position","url","status"],"properties":{"id":{"type":"string","nullable":true},"position":{"type":"integer","nullable":true,"minimum":1,"description":"One-based original slot, including skipped video slots; null when not provable."},"url":{"type":"string","nullable":true,"description":"Temporary upstream image URL, not permanent storage."},"status":{"type":"string","enum":["available","unavailable"]}}}}}},"author":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"fullName":{"type":"string"},"isVerified":{"type":"boolean"},"profilePicUrl":{"type":"string"}}}}}},"count":{"type":"integer"},"hasMore":{"type":"boolean"},"cursor":{"type":"string"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}}},"/instagram/channel-reels":{"get":{"operationId":"getInstagramChannelReels","summary":"Instagram Channel Reels","tags":["Instagram"],"description":"Get recent reels from an Instagram profile's reels tab.","parameters":[{"schema":{"type":"string"},"in":"query","name":"url","required":true,"description":"Full URL of the resource"},{"schema":{"type":"integer"},"in":"query","name":"limit","required":false,"description":"Maximum number of results to return"},{"schema":{"type":"string"},"in":"query","name":"access_key","required":false,"description":"Project access key (also accepted as x-access-key header)"}],"responses":{"200":{"description":"Channel reels retrieved successfully","content":{"application/json":{"schema":{"description":"Channel reels retrieved successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"profileUrl":{"type":"string"},"username":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"shortcode":{"type":"string"},"url":{"type":"string"},"caption":{"type":"string"},"likes":{"type":"integer"},"comments":{"type":"integer"},"views":{"type":"integer"},"duration":{"type":"number"},"thumbnailUrl":{"type":"string"},"author":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"fullName":{"type":"string"},"isVerified":{"type":"boolean"},"profilePicUrl":{"type":"string"}}}}}},"count":{"type":"integer"},"hasMore":{"type":"boolean"},"cursor":{"type":"string"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"post":{"operationId":"postInstagramChannelReels","summary":"Instagram Channel Reels","tags":["Instagram"],"description":"Get recent reels from an Instagram profile's reels tab.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Full URL of the resource"},"limit":{"type":"integer","description":"Maximum number of results to return"},"access_key":{"type":"string","description":"Project access key (also accepted as x-access-key header)"}},"nullable":true,"required":["url"]}}}},"responses":{"200":{"description":"Channel reels retrieved successfully","content":{"application/json":{"schema":{"description":"Channel reels retrieved successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"profileUrl":{"type":"string"},"username":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"shortcode":{"type":"string"},"url":{"type":"string"},"caption":{"type":"string"},"likes":{"type":"integer"},"comments":{"type":"integer"},"views":{"type":"integer"},"duration":{"type":"number"},"thumbnailUrl":{"type":"string"},"author":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"fullName":{"type":"string"},"isVerified":{"type":"boolean"},"profilePicUrl":{"type":"string"}}}}}},"count":{"type":"integer"},"hasMore":{"type":"boolean"},"cursor":{"type":"string"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}}},"/tiktok/stats":{"get":{"operationId":"getTiktokStats","summary":"Tiktok Stats","tags":["TikTok"],"description":"Get engagement metrics and metadata for a TikTok video.","parameters":[{"schema":{"type":"string"},"in":"query","name":"url","required":true,"description":"Full URL of the resource"},{"schema":{"type":"string"},"in":"query","name":"access_key","required":false,"description":"Project access key (also accepted as x-access-key header)"}],"responses":{"200":{"description":"Video stats retrieved successfully","content":{"application/json":{"schema":{"description":"Video stats retrieved successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"url":{"type":"string"},"videoId":{"type":"string"},"title":{"type":"string"},"channelName":{"type":"string"},"channelLink":{"type":"string"},"likes":{"type":"integer"},"comments":{"type":"integer"},"collects":{"type":"integer"},"shares":{"type":"integer"},"views":{"type":"integer"},"description":{"type":"string"},"duration":{"type":"string"},"thumbnailUrl":{"type":"string"},"publishedAt":{"type":"string"},"contentType":{"type":"string"},"isShortForm":{"type":"boolean"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"post":{"operationId":"postTiktokStats","summary":"Tiktok Stats","tags":["TikTok"],"description":"Get engagement metrics and metadata for a TikTok video.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Full URL of the resource"},"access_key":{"type":"string","description":"Project access key (also accepted as x-access-key header)"}},"nullable":true,"required":["url"]}}}},"responses":{"200":{"description":"Video stats retrieved successfully","content":{"application/json":{"schema":{"description":"Video stats retrieved successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"url":{"type":"string"},"videoId":{"type":"string"},"title":{"type":"string"},"channelName":{"type":"string"},"channelLink":{"type":"string"},"likes":{"type":"integer"},"comments":{"type":"integer"},"collects":{"type":"integer"},"shares":{"type":"integer"},"views":{"type":"integer"},"description":{"type":"string"},"duration":{"type":"string"},"thumbnailUrl":{"type":"string"},"publishedAt":{"type":"string"},"contentType":{"type":"string"},"isShortForm":{"type":"boolean"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}}},"/tiktok/channel-videos":{"get":{"operationId":"getTiktokChannelVideos","summary":"Tiktok Channel Videos","tags":["TikTok"],"description":"Get recent TikTok videos with bounded recovery. Paid requests allow up to 120 seconds; failures use zero credits.","parameters":[{"schema":{"type":"string"},"in":"query","name":"url","required":true,"description":"Full URL of the resource"},{"schema":{"type":"integer"},"in":"query","name":"limit","required":false,"description":"Maximum number of results to return"},{"schema":{"type":"string"},"in":"query","name":"cursor","required":false,"description":"Pagination cursor from a previous response"},{"schema":{"type":"string"},"in":"query","name":"access_key","required":false,"description":"Project access key (also accepted as x-access-key header)"},{"schema":{"type":"boolean"},"in":"query","name":"cache","required":false,"description":"Opt in to successful response caching; cache hits use zero credits."},{"schema":{"type":"integer","minimum":60,"maximum":2592000},"in":"query","name":"cache_ttl","required":false,"description":"Maximum response age in seconds. Default 86400; no stale fallback."},{"schema":{"type":"boolean"},"in":"query","name":"no_cache","required":false,"description":"Bypass all extraction and result caches."},{"schema":{"type":"string"},"in":"query","name":"country","required":false,"description":"Residential exit country (two-letter code)."}],"responses":{"200":{"description":"Channel videos retrieved successfully","content":{"application/json":{"schema":{"description":"Channel videos retrieved successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"profileUrl":{"type":"string"},"channelName":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"videoId":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"thumbnail":{"type":"string"},"duration":{"type":"number"},"createTime":{"type":"string"},"views":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"collects":{"type":"integer"}}}},"hasMore":{"type":"boolean"},"cursor":{"type":"string"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}}}},"post":{"operationId":"postTiktokChannelVideos","summary":"Tiktok Channel Videos","tags":["TikTok"],"description":"Get recent TikTok videos with bounded recovery. Paid requests allow up to 120 seconds; failures use zero credits.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Full URL of the resource"},"limit":{"type":"integer","description":"Maximum number of results to return"},"cursor":{"type":"string","description":"Pagination cursor from a previous response"},"access_key":{"type":"string","description":"Project access key (also accepted as x-access-key header)"},"cache":{"type":"boolean","description":"Opt in to successful response caching; cache hits use zero credits."},"cache_ttl":{"type":"integer","minimum":60,"maximum":2592000,"description":"Maximum response age in seconds. Default 86400; no stale fallback."},"no_cache":{"type":"boolean","description":"Bypass all extraction and result caches."},"country":{"type":"string","description":"Residential exit country (two-letter code)."}},"nullable":true,"required":["url"]}}}},"responses":{"200":{"description":"Channel videos retrieved successfully","content":{"application/json":{"schema":{"description":"Channel videos retrieved successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"profileUrl":{"type":"string"},"channelName":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"videoId":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"},"thumbnail":{"type":"string"},"duration":{"type":"number"},"createTime":{"type":"string"},"views":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"collects":{"type":"integer"}}}},"hasMore":{"type":"boolean"},"cursor":{"type":"string"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}}}}},"/tiktok/search":{"get":{"operationId":"getTiktokSearch","summary":"Tiktok Search","tags":["TikTok"],"description":"Search TikTok videos by keyword.","parameters":[{"schema":{"type":"string"},"in":"query","name":"query","required":true,"description":"Search query"},{"schema":{"type":"integer"},"in":"query","name":"limit","required":false,"description":"Maximum number of results"},{"schema":{"type":"string"},"in":"query","name":"access_key","required":false,"description":"Project access key (also accepted as x-access-key header)"}],"responses":{"200":{"description":"Search results returned","content":{"application/json":{"schema":{"description":"Search results returned","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"query":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"desc":{"type":"string"},"url":{"type":"string"},"createTime":{"type":"integer"},"author":{"type":"object","properties":{"id":{"type":"string"},"uniqueId":{"type":"string"},"nickname":{"type":"string"},"avatar":{"type":"string"},"verified":{"type":"boolean"}}},"stats":{"type":"object","properties":{"views":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"}}}}}},"hasMore":{"type":"boolean"},"cursor":{"type":"string"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"post":{"operationId":"postTiktokSearch","summary":"Tiktok Search","tags":["TikTok"],"description":"Search TikTok videos by keyword.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"Search query"},"limit":{"type":"integer","description":"Maximum number of results"},"access_key":{"type":"string","description":"Project access key (also accepted as x-access-key header)"}},"nullable":true,"required":["query"]}}}},"responses":{"200":{"description":"Search results returned","content":{"application/json":{"schema":{"description":"Search results returned","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"query":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"desc":{"type":"string"},"url":{"type":"string"},"createTime":{"type":"integer"},"author":{"type":"object","properties":{"id":{"type":"string"},"uniqueId":{"type":"string"},"nickname":{"type":"string"},"avatar":{"type":"string"},"verified":{"type":"boolean"}}},"stats":{"type":"object","properties":{"views":{"type":"integer"},"likes":{"type":"integer"},"comments":{"type":"integer"},"shares":{"type":"integer"},"saves":{"type":"integer"}}}}}},"hasMore":{"type":"boolean"},"cursor":{"type":"string"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}}},"/youtube/transcript":{"get":{"operationId":"getYoutubeTranscript","summary":"Youtube Transcript","tags":["YouTube"],"description":"Extract the full transcript (with timestamps) from a YouTube video or Short.","parameters":[{"schema":{"type":"string"},"in":"query","name":"url","required":true,"description":"Full URL of the resource"},{"schema":{"type":"string"},"in":"query","name":"access_key","required":false,"description":"Project access key (also accepted as x-access-key header)"},{"schema":{"type":"boolean"},"in":"query","name":"no_cache","required":false,"description":"Bypass transcript extraction and summary-result caches."}],"responses":{"200":{"description":"Transcript extracted successfully","content":{"application/json":{"schema":{"description":"Transcript extracted successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"url":{"type":"string"},"videoId":{"type":"string"},"transcript":{"type":"string","description":"Full plain-text transcript"},"transcriptSegments":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"start":{"type":"number"},"duration":{"type":"number"},"timestamp":{"type":"string"}}}},"wordCount":{"type":"integer"},"segments":{"type":"integer"},"language":{"type":"string"},"durationSeconds":{"type":"number"},"creditsUsed":{"type":"number"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}}}},"post":{"operationId":"postYoutubeTranscript","summary":"Youtube Transcript","tags":["YouTube"],"description":"Extract the full transcript (with timestamps) from a YouTube video or Short.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Full URL of the resource"},"access_key":{"type":"string","description":"Project access key (also accepted as x-access-key header)"},"no_cache":{"type":"boolean","description":"Bypass transcript extraction and summary-result caches."}},"nullable":true,"required":["url"]}}}},"responses":{"200":{"description":"Transcript extracted successfully","content":{"application/json":{"schema":{"description":"Transcript extracted successfully","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"url":{"type":"string"},"videoId":{"type":"string"},"transcript":{"type":"string","description":"Full plain-text transcript"},"transcriptSegments":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"start":{"type":"number"},"duration":{"type":"number"},"timestamp":{"type":"string"}}}},"wordCount":{"type":"integer"},"segments":{"type":"integer"},"language":{"type":"string"},"durationSeconds":{"type":"number"},"creditsUsed":{"type":"number"}}}}}}}},"400":{"description":"Invalid or missing request input","content":{"application/json":{"schema":{"description":"Invalid or missing request input","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"404":{"description":"Content not found or unavailable","content":{"application/json":{"schema":{"description":"Content not found or unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"422":{"description":"Unsupported input or documented media restriction","content":{"application/json":{"schema":{"description":"Unsupported input or documented media restriction","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"502":{"description":"Upstream query rejected or malformed response","content":{"application/json":{"schema":{"description":"Upstream query rejected or malformed response","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"503":{"description":"Upstream service temporarily unavailable; retry later","content":{"application/json":{"schema":{"description":"Upstream service temporarily unavailable; retry later","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}},"504":{"description":"Extraction or upstream operation timed out","content":{"application/json":{"schema":{"description":"Extraction or upstream operation timed out","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"errorCode":{"type":"string","description":"Classification of an extraction or download failure."},"retryable":{"type":"boolean","description":"Whether a later bounded retry may help. False means stop the current retry loop."}}}}}}}}},"/status":{"get":{"operationId":"getStatus","summary":"Status","tags":["Status"],"description":"Get the current public status of every Project API API capability.","security":[],"responses":{"200":{"description":"Current tool status","content":{"application/json":{"schema":{"description":"Current tool status","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","required":["overall","generatedAt","tools"],"properties":{"overall":{"type":"string","enum":["green","yellow","red"]},"generatedAt":{"type":"string","format":"date-time"},"tools":{"type":"array","items":{"type":"object","required":["id","channel","name","status","message","updatedAt"],"properties":{"id":{"type":"string"},"channel":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["green","yellow","red"]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time"}}}}}}}}}}},"503":{"description":"Status store unavailable","content":{"application/json":{"schema":{"description":"Status store unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}}},"/credits":{"get":{"operationId":"getCredits","summary":"Credits","tags":["Account"],"description":"Get the authenticated project’s remaining monthly and purchased credits. This request does not consume credits.","responses":{"200":{"description":"Current credit balance","content":{"application/json":{"schema":{"description":"Current credit balance","type":"object","required":["success","data"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","required":["totalRemaining","monthly","purchased"],"properties":{"totalRemaining":{"type":"number"},"monthly":{"type":"object","required":["limit","used","remaining","cycleStart","resetAt"],"properties":{"limit":{"type":"number"},"used":{"type":"number"},"remaining":{"type":"number"},"cycleStart":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"resetAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]}}},"purchased":{"type":"object","required":["total","used","remaining"],"properties":{"total":{"type":"number"},"used":{"type":"number"},"remaining":{"type":"number"}}}}}}}}}},"401":{"description":"Access key is missing","content":{"application/json":{"schema":{"description":"Access key is missing","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"403":{"description":"Access key is invalid or the project has insufficient credits","content":{"application/json":{"schema":{"description":"Access key is invalid or the project has insufficient credits","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"},"code":{"type":"string","enum":["insufficient_credits"]},"required_credits":{"type":"number"},"remaining_credits":{"type":"number"},"shortfall_credits":{"type":"number"},"reset_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"upgrade_url":{"type":"string","format":"uri"},"top_up_url":{"type":"string","format":"uri"},"incident_id":{"type":"string"},"upgradeUrl":{"type":"string","format":"uri","description":"Deprecated alias for upgrade_url."}}}}}},"429":{"description":"Project rate limit exceeded","content":{"application/json":{"schema":{"description":"Project rate limit exceeded","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"description":"Internal server error","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}},"503":{"description":"Credit store unavailable","content":{"application/json":{"schema":{"description":"Credit store unavailable","type":"object","required":["success","message"],"properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}}}},"servers":[{"url":"https://api.staging.fetchfox.net","description":"API"}],"security":[{"accessKey":[]}],"tags":[{"name":"YouTube","description":"YouTube video, channel, and search endpoints"},{"name":"TikTok","description":"TikTok video, channel, and search endpoints"},{"name":"Instagram","description":"Instagram post, reel, profile endpoints"},{"name":"Account","description":"Project account and balance endpoints"},{"name":"Status","description":"Public service health"}]}