StatusSupportGet API keyDashboard
SchemasSounds

Schemas

Sound

Use with AI

Sounds posts use (catalog tracks or creators' original audio) with their artist, length, audio link and how many posts use them.

Endpoints

2 endpoints return sounds on Instagram and TikTok.

Schema

Every endpoint above returns this object as data. The standard meta comes with every response.

platformstring

Platform ID (tiktok, instagram, …).

idstring

Platform-native sound ID (string), the one in its page's URL; equals the ID a post's sound reference carries.

urlstring urinullable

Canonical page of the sound, listing the posts that use it; null where the platform has none (Facebook).

titlestringnullable

Sound or track title as shown (an original sound's generated title, e.g. "original sound - <name>", included).

author_namestringnullable

Who the platform credits for the sound: a track's artist(s) as one display string, or the creator's name for an original sound.

authorsobject[]

The platform accounts behind author_name (a track's artists, or the creator of an original sound), in the platform's order; [] when none is linked.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

is_originalbooleannullable

An original sound a creator uploaded or recorded (false: a catalogue or licensed track).

duration_msintegernullable

Length of the audio the platform serves for the sound, in milliseconds (TikTok: the usable clip, often shorter than the full song).

cover_urlstring urinullable

Cover art or thumbnail image URL. Platform CDN URLs can expire within hours.

play_urlstring urinullable

Audio file URL (a preview where the platform serves only one); signed links expire within hours; null when not exposed.

streaming_linksobject[]

The same track on music streaming services, as the platform links it; [] when none (always for original sounds).

ShowHide 2 child fields
servicestring

The streaming service. New values may be added; treat unknown values as other.

One ofspotifyapple_music

urlstring uri

The track's public page on the service.

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 1 child field
post_countintegernullable

Posts using the sound (TikTok videos, Instagram and Facebook reels, YouTube Shorts), as the platform counts them.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 2 child fields
tiktokobjectnullable

A TikTok sound's own fields.

ShowHide 3 child fields
albumstringnullable

Album of a catalogue track; null for original sounds and when not stated.

is_commercial_musicbooleannullable

TikTok's own is_commerce_music flag, as served. Not a licence check: TikTok sets it on original sounds and leaves it false on many licensed catalogue tracks, so it does not say a sound is cleared for business accounts or ads.

matched_songobjectnullable

The catalogue song TikTok matched the sound's audio to (for a catalogue track, the track itself): the song behind an original sound. null when TikTok names none.

ShowHide 2 child fields
idstringnullable

TikTok's ID of the song (not a sound ID: a sound endpoint does not take it). An official clip of a song and the original sounds matched to it share it, so grouping on it counts every use of the song; null when not stated.

streaming_linksobject[]

The matched song on music streaming services, as TikTok links it; [] when none.

ShowHide 2 child fields
servicestring

The streaming service. New values may be added; treat unknown values as other.

One ofspotifyapple_music

urlstring uri

The track's public page on the service.

instagramobjectnullable

An Instagram audio's own fields.

ShowHide 6 child fields
asset_idstringnullable

ID of a licensed track's audio asset (not the sound's page ID); null for original audio.

is_explicitbooleannullable

Instagram marks the track explicit.

is_trendingbooleannullable

Instagram labels the audio trending in reels.

is_lyrics_shownbooleannullable

Instagram has the licensed track's lyrics and shows them with it; null for original audio.

created_atstring date-timenullable

When the creator's original audio was created (RFC 3339 UTC): when the reel it comes from was published; null for a licensed track.

source_postobjectnullable

The reel an original audio comes from (the first published with it); null for a licensed track.

ShowHide 2 child fields
idstringnullable

The reel's shortcode: its post ID (equals post.id of instagram.post).

urlstring urinullable

The reel's link (instagram.com/reel/<id>/).

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text (e.g. metrics.post_count from "80K reels"). A list path means the list may be incomplete. [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.

Item errors

Besides the request-level errors every endpoint can return, sound endpoints return:

CodeHTTPRetryMeaningWhat to do
not_found404NoThe item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).Check the link or ID. Do not retry.
private_or_unavailable403NoThe item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.Only public items can be fetched. Do not retry.

Last updated