StatusSupportGet API keyDashboard
SchemasEffects

Schemas

Effect

Use with AI

Camera effects, filters and lenses creators use in their videos, with their creator and how many posts use them.

Endpoints

1 endpoint returns effects on TikTok.

Schema

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

platformstring

Platform ID (tiktok, …).

idstring

Platform-native effect ID (string; TikTok's effect ID, the number ending its /effect/ link).

urlstring uri

Canonical public page of the effect.

namestring

The effect's name as the platform shows it.

descriptionstringnullable

The creator's description of the effect; null when empty or not exposed.

creatorobject

The account that made the effect. Fields are null where the platform names no account (TikTok's own effects show only a display name).

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_officialbooleannullable

True when the platform itself made the effect, false for an effect made by a community creator; null when not exposed.

icon_urlstring urinullable

The effect's icon image URL. Platform CDN URLs can expire within hours.

mediaobject[]

Preview images and videos the platform shows of the effect in use; [] if none or not exposed.

ShowHide 8 child fields
typestring

Kind of file. New values may be added; treat unknown values as other.

One ofimagevideoaudiogif

urlstring urinullable

Direct file URL; null when the platform withholds it, or when the link would only work from SocialTap's network or with a login. Often signed and expiring: see expires_at.

expires_atstring date-timenullable

When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire.

thumbnail_urlstring urinullable

Poster or preview image URL.

widthintegernullable

Width in pixels.

heightintegernullable

Height in pixels.

duration_msintegernullable

Duration in milliseconds (video and audio only).

alt_textstringnullable

Accessibility text provided by the author or platform.

published_atstring date-timenullable

When the effect was published, RFC 3339 UTC.

metricsobject

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

ShowHide 2 child fields
post_countintegernullable

Public posts made with the effect, as the platform counts them (TikTok's "videos" figure on the effect page).

total_view_countintegernullable

Views across all posts made with the effect.

platform_specificobject

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

ShowHide 1 child field
tiktokobjectnullable

A TikTok effect's own fields.

ShowHide 1 child field
creator_sec_uidstringnullable

The creator's secUid, TikTok's account key that survives a rename; null for TikTok's own effects.

approximate_fieldsstring[]

JSON paths of values rounded by the platform or parsed from display text (e.g. metrics.post_count from "304.5M videos"). A list path (media) 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, effect 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.

Last updated