fetchproof.

/v1/instagram/user/reels

GET

Reels

Get public reels by user_id or handle. Pinned reels and captions are excluded. Play counts may be inaccurate and exclude Facebook views. Use Post for captions.

Credit cost

Default: 1 credit

How charges are determined

Cost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns.

A call that fails costs 0 credits. A result served from cache costs 0 credits.

`default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins.

A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true).

A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute.

Cache supportNot specified in the published contract.
PaginationNo explicit pagination metadata in the published contract. Consult the parameters and response fields below.

Parameters

NameLocation / requiredSchema
user_id

Numeric Instagram user ID; faster than using a handle.

query / optional

string

handle

Instagram handle; use user_id for faster responses.

query / optional

string

require_play_counts

Require play_count on returned reels; 0 is valid. Missing counts return an uncharged error. Why counts can be missing.

query / optional

boolean

trim

Set to true for a trimmed response.

query / optional

boolean

max_id

Pass max_id from the previous response for the next page.

query / optional

string

Request examples

Replace placeholder values and supply your own API key. For operations with a request body, populate the body using the schema above.

cURL
curl --request GET 'https://api.fetchproof.com/v1/instagram/user/reels' \
  --header 'x-api-key: YOUR_API_KEY'
JavaScript
const response = await fetch("https://api.fetchproof.com/v1/instagram/user/reels", {
  method: 'GET',
  headers: { 'x-api-key': process.env.FETCHPROOF_API_KEY }
});
console.log(await response.text());
Python
import os
import requests

response = requests.get("https://api.fetchproof.com/v1/instagram/user/reels",
    headers={"x-api-key": os.environ["FETCHPROOF_API_KEY"]})
print(response.text)

Responses

200Success. Envelope: success / credits_remaining / credits_charged.

application/json

object

successrequired

boolean

credits_remainingrequired

integer

credits_chargedrequired

integer

itemsrequired

array

Array items

object

mediaoptional

object

taken_atrequired

integer

created_atrequired

string

{
  "format": "date-time"
}
pkrequired

schema

anyOf

string

anyOf

integer

idrequired

string

fbidrequired

schema

anyOf

string

anyOf

integer

device_timestamprequired

integer

caption_is_editedrequired

boolean

strong_id__required

string

deleted_reasonrequired

integer

has_shared_to_fbrequired

integer

has_delayed_metadatarequired

boolean

mezql_tokenrequired

string

share_count_disabledrequired

boolean

is_visual_reply_commenter_notice_enabledrequired

boolean

like_and_view_counts_disabledrequired

boolean

is_post_live_clips_mediarequired

boolean

logging_info_tokenrequired

string

comment_threading_enabledoptional

boolean

is_unified_videooptional

boolean

commerciality_statusoptional

string

client_cache_keyrequired

string

integrity_review_decisionrequired

string

should_request_adsrequired

boolean

is_reshare_of_text_post_app_media_in_igrequired

boolean

has_privately_likedrequired

boolean

filter_typerequired

integer

photo_of_yourequired

boolean

can_see_insights_as_brandrequired

boolean

media_typerequired

integer

coderequired

string

captionrequired

object

strong_id__required

string

bit_flagsrequired

integer

created_atrequired

integer

created_at_utcrequired

integer

did_report_as_spamrequired

boolean

is_ranked_commentrequired

boolean

pkrequired

string

share_enabledrequired

boolean

content_typerequired

string

media_idrequired

integer

statusrequired

string

typerequired

integer

user_idrequired

integer

textrequired

string

userrequired

object

strong_id__required

string

pkrequired

integer

pk_idrequired

string

idrequired

string

is_unpublishedrequired

boolean

fbid_v2required

integer

usernamerequired

string

full_namerequired

string

is_privaterequired

boolean

is_verifiedrequired

boolean

profile_pic_idrequired

string

profile_pic_urlrequired

string

is_coveredrequired

boolean

private_reply_statusrequired

integer

text_translationoptional

string

sharing_friction_inforequired

object

bloks_app_urlrequired

null

should_have_sharing_frictionrequired

boolean

sharing_friction_payloadrequired

null

timeline_pinned_user_idsrequired

array

play_countrequired

integer

has_views_fetchingrequired

boolean

ig_play_countrequired

integer

creator_viewer_insightsoptional

array

display_urirequired

string

fb_user_tagsrequired

object

inrequired

array

coauthor_producersrequired

array

Array items

object

strong_id__required

string

pkrequired

integer

pk_idrequired

string

idrequired

string

usernamerequired

string

full_namerequired

string

is_privaterequired

boolean

is_verifiedrequired

boolean

profile_pic_idrequired

string

profile_pic_urlrequired

string

coauthor_producer_can_see_organic_insightsrequired

boolean

invited_coauthor_producersrequired

array

is_in_profile_gridrequired

boolean

profile_grid_control_enabledrequired

boolean

media_cropping_infooptional

object

square_cropoptional

object

crop_leftrequired

integer

crop_rightrequired

integer

crop_toprequired

integer

crop_bottomrequired

integer

four_by_three_cropoptional

object

crop_leftrequired

integer

crop_rightrequired

integer

crop_toprequired

schema

anyOf

schema

anyOf

integer

anyOf

number

anyOf

number

crop_bottomrequired

number

userrequired

object

fbid_v2required

schema

anyOf

string

anyOf

integer

feed_post_reshare_disabledrequired

boolean

full_namerequired

string

idrequired

string

is_privaterequired

boolean

is_unpublishedrequired

boolean

pkrequired

schema

anyOf

string

anyOf

integer

pk_idrequired

string

show_account_transparency_detailsrequired

boolean

strong_id__required

string

third_party_downloads_enabledrequired

integer

usernamerequired

string

account_typerequired

integer

account_badgesrequired

array

fan_club_inforequired

object

autosave_to_exclusive_highlightrequired

null

connected_member_countrequired

null

fan_club_idrequired

null

fan_club_namerequired

null

has_created_sscrequired

null

has_enough_subscribers_for_sscrequired

null

is_fan_club_gifting_eligiblerequired

null

is_fan_club_referral_eligiblerequired

null

is_free_trial_eligiblerequired

null

largest_public_bc_idrequired

null

subscriber_countrequired

null

fan_consideration_page_revamp_eligiblityrequired

null

should_show_playlists_in_profile_taboptional

null

has_anonymous_profile_picturerequired

boolean

hd_profile_pic_url_infooptional

object

heightrequired

integer

urlrequired

string

widthrequired

integer

hd_profile_pic_versionsoptional

array

Array items

object

heightrequired

integer

urlrequired

string

widthrequired

integer

is_verifiedrequired

boolean

profile_pic_idrequired

string

profile_pic_urlrequired

string

transparency_product_enabledrequired

boolean

is_embeds_disabledoptional

boolean

eligible_for_text_app_activation_badgeoptional

boolean

owneroptional

object

fbid_v2required

string

feed_post_reshare_disabledrequired

boolean

full_namerequired

string

idrequired

string

is_privaterequired

boolean

is_unpublishedrequired

boolean

pkrequired

string

pk_idrequired

string

show_account_transparency_detailsrequired

boolean

strong_id__required

string

third_party_downloads_enabledrequired

integer

usernamerequired

string

account_typerequired

integer

account_badgesrequired

array

hd_profile_pic_url_inforequired

object

heightrequired

integer

urlrequired

string

widthrequired

integer

hd_profile_pic_versionsrequired

array

Array items

object

heightrequired

integer

urlrequired

string

widthrequired

integer

is_verifiedrequired

boolean

profile_pic_idrequired

string

profile_pic_urlrequired

string

transparency_product_enabledrequired

boolean

is_embeds_disabledrequired

boolean

image_versions2required

object

candidatesrequired

array

Array items

object

widthrequired

integer

heightrequired

integer

urlrequired

string

estimated_scans_sizesoptional

array

Array items

integer

scans_profileoptional

string

is_spatial_imageoptional

boolean

additional_candidatesrequired

object

igtv_first_framerequired

object

widthrequired

integer

heightrequired

integer

urlrequired

string

estimated_scans_sizesoptional

array

Array items

integer

scans_profileoptional

string

is_spatial_imageoptional

boolean

first_framerequired

object

widthrequired

integer

heightrequired

integer

urlrequired

string

estimated_scans_sizesoptional

array

Array items

integer

scans_profileoptional

string

is_spatial_imageoptional

boolean

smart_framerequired

null

scrubber_spritesheet_info_candidatesoptional

object

defaultrequired

object

file_size_kbrequired

integer

max_thumbnails_per_spriterequired

integer

rendered_widthrequired

integer

sprite_heightrequired

integer

sprite_urlsrequired

array

Array items

string

sprite_widthrequired

integer

thumbnail_durationrequired

number

thumbnail_heightrequired

integer

thumbnail_widthrequired

integer

thumbnails_per_rowrequired

integer

total_thumbnail_num_per_spriterequired

integer

video_lengthrequired

number

original_widthrequired

integer

original_heightrequired

integer

is_artist_pickoptional

boolean

enable_media_notes_productionrequired

boolean

product_typerequired

string

is_paid_partnershiprequired

boolean

music_metadatarequired

null

organic_tracking_tokenrequired

string

is_third_party_downloads_eligiblerequired

boolean

ig_media_sharing_disabledrequired

boolean

are_remixes_crosspostablerequired

boolean

boost_unavailable_identifierrequired

null

boost_unavailable_reasonrequired

null

boost_unavailable_reason_v2required

array

subscribe_cta_visiblerequired

boolean

is_cutout_sticker_allowedrequired

boolean

gen_ai_detection_methodrequired

object

detection_methodrequired

string

fb_aggregated_like_countoptional

integer

fb_aggregated_comment_countoptional

integer

has_high_risk_gen_ai_inform_treatmentoptional

boolean

open_carousel_show_follow_buttonoptional

boolean

is_tagged_media_shared_to_viewer_profile_gridoptional

boolean

should_show_author_pog_for_tagged_media_shared_to_profile_gridrequired

boolean

is_eligible_for_media_note_recs_nuxoptional

boolean

is_social_ufi_disabledrequired

boolean

is_eligible_for_meta_ai_shareoptional

boolean

meta_ai_suggested_promptsrequired

array

can_replyoptional

boolean

is_eligible_content_for_post_roll_adrequired

boolean

can_view_more_preview_commentsoptional

boolean

preview_commentsoptional

array

comment_countrequired

integer

hide_view_all_comment_entrypointrequired

boolean

is_comments_gif_composer_enabledrequired

boolean

comment_inform_treatmentrequired

object

action_typerequired

null

should_have_inform_treatmentrequired

boolean

textrequired

string

urlrequired

null

has_likedrequired

boolean

like_countrequired

integer

video_sticker_localesrequired

array

is_dash_eligiblerequired

integer

number_of_qualitiesrequired

integer

video_versionsrequired

array

Array items

object

heightrequired

integer

typerequired

integer

urlrequired

string

widthrequired

integer

bandwidthoptional

integer

idoptional

string

progressive_identifieroptional

string

url_expiration_timestamp_usoptional

null

fallbackoptional

null

video_durationrequired

number

has_audiorequired

boolean

clips_tab_pinned_user_idsrequired

array

clips_metadatarequired

object

breaking_content_inforequired

null

breaking_creator_inforequired

null

clips_creation_entry_pointrequired

string

featured_labelrequired

null

is_public_chat_welcome_videorequired

boolean

is_shared_to_fbrequired

boolean

professional_clips_upsell_typerequired

integer

reels_on_the_rise_inforequired

null

show_tipsrequired

null

achievements_inforequired

object

num_earned_achievementsrequired

null

show_achievementsrequired

boolean

additional_audio_inforequired

object

additional_audio_usernamerequired

null

audio_reattribution_inforequired

object

should_allow_restorerequired

boolean

asset_recommendation_inforequired

null

audio_ranking_inforequired

object

best_audio_cluster_idoptional

string

audio_typerequired

string

branded_content_tag_inforequired

object

can_add_tagrequired

boolean

challenge_inforequired

null

content_appreciation_inforequired

object

enabledrequired

boolean

entry_point_containerrequired

null

contextual_highlight_inforequired

null

cutout_sticker_inforequired

array

disable_use_in_clips_client_cacherequired

boolean

external_media_inforequired

null

is_fan_club_promo_videorequired

null

merchandising_pill_inforequired

null

music_canonical_idrequired

string

music_inforequired

null

nux_inforequired

null

original_sound_inforequired

object

allow_creator_to_renamerequired

boolean

audio_asset_idrequired

schema

anyOf

string

anyOf

integer

attributed_custom_audio_asset_idrequired

null

can_remix_be_shared_to_fbrequired

boolean

can_remix_be_shared_to_fb_expansionrequired

boolean

duration_in_msrequired

integer

formatted_clips_media_countrequired

null

hide_remixingrequired

boolean

ig_artistrequired

object

pkrequired

schema

anyOf

string

anyOf

integer

pk_idrequired

string

idrequired

string

usernamerequired

string

full_namerequired

string

is_privaterequired

boolean

strong_id__required

string

is_verifiedrequired

boolean

profile_pic_idrequired

string

profile_pic_urlrequired

string

is_audio_automatically_attributedrequired

boolean

is_eligible_for_audio_effectsrequired

boolean

is_eligible_for_vinyl_stickerrequired

boolean

is_explicitrequired

boolean

is_original_audio_download_eligiblerequired

boolean

is_reuse_disabledrequired

boolean

is_xpost_from_fbrequired

boolean

music_canonical_idrequired

null

oa_owner_is_music_artistrequired

boolean

original_audio_subtyperequired

string

original_audio_titlerequired

string

original_media_idrequired

schema

anyOf

string

anyOf

integer

progressive_download_urlrequired

string

should_mute_audiorequired

boolean

time_createdrequired

integer

trend_rankrequired

null

previous_trend_rankrequired

null

overlap_duration_in_msrequired

null

audio_asset_start_time_in_msrequired

null

audio_filter_infosrequired

array

audio_partsrequired

array

audio_parts_by_filterrequired

array

consumption_inforequired

object

display_media_idrequired

null

is_bookmarkedrequired

boolean

is_trending_in_clipsrequired

boolean

should_mute_audio_reasonrequired

string

should_mute_audio_reason_typerequired

null

inline_audio_labeloptional

null

display_labelsoptional

null

display_labels_with_translationsoptional

null

user_notesoptional

null

xpost_fb_creator_inforequired

null

fb_downstream_use_xpost_metadatarequired

object

downstream_use_xpost_deny_reasonrequired

string

dash_manifestoptional

string

derived_content_start_time_in_composition_in_msoptional

null

should_allow_audio_editingoptional

boolean

volume_dataoptional

null

originality_inforequired

null

reusable_text_attribute_stringrequired

string

shopping_inforequired

null

show_achievementsrequired

boolean

template_inforequired

null

viewer_interaction_settingsrequired

null

basel_template_info_for_ig_appoptional

object

is_basel_templaterequired

null

original_template_media_idrequired

null

should_show_reuse_setting_for_ownerrequired

boolean

use_template_deeplinkrequired

null

mashup_infooptional

object

can_toggle_mashups_allowedrequired

boolean

formatted_mashups_countrequired

null

has_been_mashed_uprequired

boolean

has_nonmimicable_additional_audiorequired

boolean

is_creator_requesting_mashuprequired

boolean

is_light_weight_checkrequired

boolean

is_light_weight_reuse_allowed_checkrequired

boolean

is_pivot_page_availablerequired

boolean

is_reuse_allowedrequired

boolean

mashup_typerequired

null

mashups_allowedrequired

boolean

mashups_allowed_for_carouselrequired

boolean

non_privacy_filtered_mashups_media_countrequired

integer

privacy_filtered_mashups_media_countrequired

null

original_mediarequired

null

reusable_text_infooptional

null

may_have_template_infooptional

null

can_viewer_saverequired

boolean

can_viewer_resharerequired

boolean

shop_routing_user_idrequired

null

is_organic_product_tagging_eligiblerequired

boolean

igbio_productrequired

null

product_suggestionsoptional

array

commerce_integrity_review_decisionoptional

string

view_state_item_typerequired

integer

is_reuse_allowedrequired

boolean

has_more_commentsoptional

boolean

max_num_visible_preview_commentsoptional

integer

explore_hide_commentsoptional

boolean

is_open_to_public_submissionrequired

boolean

urlrequired

string

disable_caption_and_commentoptional

boolean

subtype_name_for_REST__optional

string

is_quiet_postoptional

boolean

is_short_dramaoptional

boolean

original_lang_for_translationsoptional

string

is_affiliate_commission_eligibleoptional

boolean

fundraiser_tagoptional

object

has_standalone_fundraiserrequired

boolean

cutout_sticker_infooptional

array

related_ads_pivots_media_infooptional

string

eligible_insights_entrypointsoptional

string

media_attributions_dataoptional

array

media_ui_attributions_dataoptional

array

media_ui_attributions_data_v2optional

array

is_eligible_for_poeoptional

boolean

is_eligible_for_organic_eager_refreshoptional

boolean

is_photo_comments_composer_enabled_for_authoroptional

boolean

locationsoptional

array

is_eligible_for_autoduboptional

boolean

is_eligible_for_autodub_upselloptional

boolean

video_codecoptional

string

tappable_elementsoptional

array

premium_reaction_countoptional

integer

viewer_premium_reaction_asset_idoptional

null

creator_is_in_premium_reactions_alphaoptional

null

wearable_attribution_infooptional

object

attribution_cta_action_urlrequired

string

attribution_cta_textrequired

string

attribution_icon_urlrequired

string

attribution_subtitlerequired

string

attribution_titlerequired

string

attribution_top_icon_urlrequired

string

attribution_typerequired

string

gating_reasonrequired

string

iconic_current_presencerequired

null

iconic_horizon_world_deeplinkrequired

null

iconic_horizon_world_idrequired

null

iconic_horizon_world_namerequired

null

iconic_horizon_world_thumbnail_img_urlrequired

null

is_wearable_media_producerrequired

boolean

pivot_page_cta_labelrequired

null

pivot_page_cta_urlrequired

null

pivot_page_descriptionrequired

null

pivot_page_image_urlrequired

null

pivot_page_titlerequired

null

reels_pill_attribution_titlerequired

string

pivot_page_micro_user_dictrequired

null

world_location_pages_inforequired

null

has_tagged_usersoptional

boolean

media_overlay_infooptional

null

creative_configoptional

null

hide_stickers_for_original_languageoptional

boolean

hidden_likes_string_variantoptional

integer

featured_productsoptional

array

video_dash_manifestoptional

string

clips_demotion_controloptional

object

titlerequired

string

title_stylerequired

string

confirmation_titlerequired

string

confirmation_title_stylerequired

string

confirmation_bodyrequired

string

confirmation_iconrequired

string

confirmation_stylerequired

string

undo_stylerequired

string

enable_word_wrappingrequired

boolean

followup_optionsrequired

array

Array items

object

textrequired

string

idrequired

string

show_iconrequired

boolean

stylerequired

null

datarequired

string

subtitlerequired

null

demotion_controlrequired

object

confirmation_titlerequired

string

confirmation_bodyrequired

string

confirmation_iconrequired

string

confirmation_stylerequired

string

undo_stylerequired

string

is_eligible_for_rtaoptional

boolean

is_meta_ai_invocation_blocked_by_authoroptional

boolean

original_media_has_visual_reply_mediaoptional

boolean

tya_media_related_topicsoptional

array

teen_project_infooptional

null

is_educationaloptional

null

is_affiliate_postoptional

boolean

is_eligible_for_poe_premiumoptional

boolean

is_longform_player_eligibleoptional

boolean

collaborator_edit_eligibilityoptional

boolean

media_reposter_bottomsheet_enabledoptional

boolean

translated_langs_for_autoduboptional

array

usertagsoptional

object

inrequired

array

Array items

object

positionrequired

array

Array items

integer

show_category_of_userrequired

boolean

userrequired

object

strong_id__required

string

pkrequired

integer

pk_idrequired

string

idrequired

string

usernamerequired

string

full_namerequired

string

is_privaterequired

boolean

is_verifiedrequired

boolean

profile_pic_idrequired

string

profile_pic_urlrequired

string

idoptional

string

codeoptional

string

taken_atoptional

integer

created_atoptional

string

{
  "format": "date-time"
}
captionoptional

object

bit_flagsrequired

integer

created_atrequired

integer

created_at_utcrequired

integer

did_report_as_spamrequired

boolean

is_ranked_commentrequired

boolean

pkrequired

string

share_enabledrequired

boolean

content_typerequired

string

media_idrequired

string

statusrequired

string

typerequired

integer

user_idrequired

string

strong_id__required

string

textrequired

string

userrequired

object

pkrequired

string

pk_idrequired

string

idrequired

string

full_namerequired

string

is_privaterequired

boolean

is_unpublishedrequired

boolean

strong_id__required

string

fbid_v2required

string

usernamerequired

string

is_verifiedrequired

boolean

profile_pic_idrequired

string

profile_pic_urlrequired

string

is_coveredrequired

boolean

private_reply_statusrequired

integer

play_countoptional

integer

ig_play_countoptional

integer

comment_countoptional

integer

like_countoptional

integer

display_urioptional

string

useroptional

object

fbid_v2required

string

feed_post_reshare_disabledrequired

boolean

full_namerequired

string

idrequired

string

is_privaterequired

boolean

is_unpublishedrequired

boolean

pkrequired

string

pk_idrequired

string

show_account_transparency_detailsrequired

boolean

strong_id__required

string

third_party_downloads_enabledrequired

integer

account_typerequired

integer

account_badgesrequired

array

fan_club_inforequired

object

autosave_to_exclusive_highlightrequired

null

connected_member_countrequired

null

fan_club_idrequired

null

fan_club_namerequired

null

has_created_sscrequired

null

has_enough_subscribers_for_sscrequired

null

is_fan_club_gifting_eligiblerequired

null

is_fan_club_referral_eligiblerequired

null

is_free_trial_eligiblerequired

null

largest_public_bc_idrequired

null

subscriber_countrequired

null

fan_consideration_page_revamp_eligiblityrequired

null

has_anonymous_profile_picturerequired

boolean

hd_profile_pic_url_inforequired

object

heightrequired

integer

urlrequired

string

widthrequired

integer

hd_profile_pic_versionsrequired

array

Array items

object

heightrequired

integer

urlrequired

string

widthrequired

integer

is_verifiedrequired

boolean

profile_pic_idrequired

string

profile_pic_urlrequired

string

transparency_product_enabledrequired

boolean

usernamerequired

string

is_embeds_disabledrequired

boolean

eligible_for_text_app_activation_badgerequired

boolean

owneroptional

object

fbid_v2required

string

feed_post_reshare_disabledrequired

boolean

full_namerequired

string

idrequired

string

is_privaterequired

boolean

is_unpublishedrequired

boolean

pkrequired

string

pk_idrequired

string

show_account_transparency_detailsrequired

boolean

strong_id__required

string

third_party_downloads_enabledrequired

integer

account_typerequired

integer

account_badgesrequired

array

fan_club_inforequired

object

autosave_to_exclusive_highlightrequired

null

connected_member_countrequired

null

fan_club_idrequired

null

fan_club_namerequired

null

has_created_sscrequired

null

has_enough_subscribers_for_sscrequired

null

is_fan_club_gifting_eligiblerequired

null

is_fan_club_referral_eligiblerequired

null

is_free_trial_eligiblerequired

null

largest_public_bc_idrequired

null

subscriber_countrequired

null

fan_consideration_page_revamp_eligiblityrequired

null

has_anonymous_profile_picturerequired

boolean

hd_profile_pic_url_inforequired

object

heightrequired

integer

urlrequired

string

widthrequired

integer

hd_profile_pic_versionsrequired

array

Array items

object

heightrequired

integer

urlrequired

string

widthrequired

integer

is_verifiedrequired

boolean

profile_pic_idrequired

string

profile_pic_urlrequired

string

transparency_product_enabledrequired

boolean

usernamerequired

string

is_embeds_disabledrequired

boolean

eligible_for_text_app_activation_badgerequired

boolean

image_versions2optional

object

additional_candidatesrequired

object

first_framerequired

object

heightrequired

integer

urlrequired

string

widthrequired

integer

igtv_first_framerequired

object

heightrequired

integer

urlrequired

string

widthrequired

integer

smart_framerequired

object

heightrequired

integer

urlrequired

string

widthrequired

integer

candidatesrequired

array

Array items

object

heightrequired

integer

urlrequired

string

widthrequired

integer

scrubber_spritesheet_info_candidatesrequired

object

defaultrequired

object

file_size_kbrequired

integer

max_thumbnails_per_spriterequired

integer

rendered_widthrequired

integer

sprite_heightrequired

integer

sprite_urlsrequired

array

Array items

string

sprite_widthrequired

integer

thumbnail_durationrequired

number

thumbnail_heightrequired

integer

thumbnail_widthrequired

integer

thumbnails_per_rowrequired

integer

total_thumbnail_num_per_spriterequired

integer

video_lengthrequired

number

urloptional

string

paging_infooptional

object

max_idrequired

string

more_availablerequired

boolean

statusoptional

string

max_idoptional

string

401Invalid or missing x-api-key
402No credits remaining
403Upstream denied (age gate, audience controls)
404Resource or endpoint not found
429Rate limited