openapi: 3.1.0 info: title: Konbini Instagram TikTok API version: 1.0.0 description: 'Social media API that normalizes Instagram and TikTok data into a consistent ActivityStreams 2.0 format. Every authenticated response includes `X-Credits-Remaining` and `X-Credits-Used` headers. Each successful request costs 1 credit. Requests that fail with 400, 5xx, or upstream errors are refunded (X-Credits-Used: 0).' contact: name: KonbiniAPI email: hello@konbiniapi.com url: https://konbiniapi.com servers: - url: https://api.konbiniapi.com description: Production security: - apiKey: [] tags: - name: TikTok description: TikTok data endpoints paths: /v1/tiktok/users/{username}: get: operationId: tiktokGetUser tags: - TikTok summary: Get User Profile description: Returns profile information for a TikTok user including bio, follower counts, verification status, and profile picture. Look up any public TikTok account by username. parameters: - schema: type: string description: TikTok username (with or without @ symbol) example: khaby.lame required: true description: TikTok username (with or without @ symbol) name: username in: path responses: '200': description: Returns the user details headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams object type example: Person id: type: string format: uri description: Profile URL example: https://www.tiktok.com/@khaby.lame url: type: string format: uri description: Profile URL example: https://www.tiktok.com/@khaby.lame entityId: type: string description: TikTok secUid example: MS4wLjABAAAAwAg0rSzO65WQfz4RzQgGv2Xdv108BgPXhRrrmNVIHQZ9PO8-flwwRtEppYTS0OjA name: type: string description: Display name example: Khabane Lame preferredUsername: type: string description: Username or handle example: khaby.lame summary: type: string description: Bio text example: Just a guy who reacts attachment: type: array items: $ref: '#/components/schemas/TikTokLink' description: External links in bio published: type: string format: date-time description: Account creation date in ISO 8601 format example: '2020-03-15T00:00:00.000Z' isPrivate: type: boolean description: Whether account is private example: false isVerified: type: boolean description: Whether account is verified example: true isLive: type: boolean description: Whether user is currently live streaming example: false hasLikes: type: boolean description: Whether user's liked videos are public example: true hasPlaylists: type: boolean description: Whether user has playlists example: true followerCount: type: integer description: Number of followers example: 160300000 followingCount: type: integer description: Number of accounts followed example: 85 language: type: string description: User language preference (BCP47 code) example: en likeCount: type: integer description: Total likes received across all content example: 2600000000 likedCount: type: integer description: Number of videos the user has liked example: 5300 mediaCount: type: integer description: Number of posts example: 1309 icon: $ref: '#/components/schemas/TikTokImage' description: User profile picture image: type: array items: $ref: '#/components/schemas/TikTokImage' description: Profile pictures in multiple sizes required: - '@context' - type - id - url - entityId - name - preferredUsername - isPrivate - isVerified - isLive - followerCount - followingCount - likeCount - mediaCount required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/users/{username}/videos: get: operationId: tiktokGetUserVideos tags: - TikTok summary: Get User Videos description: Returns a paginated list of videos from a user's profile. Supports sorting by newest, popular, or oldest. Maximum 35 videos per page. parameters: - schema: type: string description: TikTok username (with or without @ symbol) example: khaby.lame required: true description: TikTok username (with or without @ symbol) name: username in: path - schema: type: integer minimum: 1 maximum: 35 default: 35 description: 'Number of videos to fetch (maximum: 35)' example: 35 required: false description: 'Number of videos to fetch (maximum: 35)' name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query - schema: type: string enum: - newest - popular - oldest default: newest description: 'Sort order: newest (default), popular, or oldest' example: newest required: false description: 'Sort order: newest (default), popular, or oldest' name: order in: query responses: '200': description: Returns the user videos headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/videos totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/videos?cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokVideo' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/users/{username}/likes: get: operationId: tiktokGetUserLikes tags: - TikTok summary: Get User Liked Videos description: 'Returns a paginated list of videos liked by a TikTok user. Note: Users may have their likes set to private, in which case an empty list will be returned.' parameters: - schema: type: string description: TikTok username (with or without @ symbol) example: khaby.lame required: true description: TikTok username (with or without @ symbol) name: username in: path - schema: type: integer minimum: 1 maximum: 35 default: 35 description: 'Number of videos to fetch (maximum: 35)' example: 35 required: false description: 'Number of videos to fetch (maximum: 35)' name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query responses: '200': description: Returns the user liked videos headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/likes totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/likes?cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokVideo' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/users/{username}/reposts: get: operationId: tiktokGetUserReposts tags: - TikTok summary: Get User Reposts description: 'Returns a paginated list of videos reposted by a TikTok user. Note: Users may have their reposts set to private, in which case an empty list will be returned.' parameters: - schema: type: string description: TikTok username (with or without @ symbol) example: khaby.lame required: true description: TikTok username (with or without @ symbol) name: username in: path - schema: type: integer minimum: 1 maximum: 30 default: 30 description: 'Number of videos to fetch (maximum: 30)' example: 30 required: false description: 'Number of videos to fetch (maximum: 30)' name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query - schema: type: string enum: - newest - popular - oldest default: newest description: 'Sort order: newest (default), popular, or oldest' example: newest required: false description: 'Sort order: newest (default), popular, or oldest' name: order in: query responses: '200': description: Returns the user reposts headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/reposts totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/reposts?cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokVideo' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/users/{username}/collections: get: operationId: tiktokGetUserCollections tags: - TikTok summary: Get User Collections description: Returns a paginated list of video collections (playlists and mixes) on a TikTok user's profile. Includes collection name, cover image, and video count. parameters: - schema: type: string description: TikTok username (with or without @ symbol) example: khaby.lame required: true description: TikTok username (with or without @ symbol) name: username in: path - schema: type: integer minimum: 1 maximum: 30 default: 30 description: 'Number of collections to fetch (maximum: 30)' example: 30 required: false description: 'Number of collections to fetch (maximum: 30)' name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query responses: '200': description: Returns the user collections headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/collections totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/collections?cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokCollection' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/users/{username}/stories: get: operationId: tiktokGetUserStories tags: - TikTok summary: Get User Stories description: Returns a paginated list of active stories for a TikTok user. Stories expire after 24 hours and include both images and videos with engagement data. parameters: - schema: type: string description: TikTok username (with or without @ symbol) example: khaby.lame required: true description: TikTok username (with or without @ symbol) name: username in: path - schema: type: integer minimum: 1 maximum: 35 default: 4 description: 'Number of stories to fetch (maximum: 35)' example: 4 required: false description: 'Number of stories to fetch (maximum: 35)' name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query responses: '200': description: Returns the user stories headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/stories totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/stories?cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokStory' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/users/{username}/following: get: operationId: tiktokGetUserFollowing tags: - TikTok summary: Get User Following List description: Returns a paginated list of accounts a TikTok user follows. Maximum 30 per page. Includes profile details for each followed account. parameters: - schema: type: string description: TikTok username (with or without @ symbol) example: khaby.lame required: true description: TikTok username (with or without @ symbol) name: username in: path - schema: type: integer minimum: 1 maximum: 30 default: 30 description: 'Number of users to fetch (maximum: 30)' example: 30 required: false description: 'Number of users to fetch (maximum: 30)' name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query responses: '200': description: Returns the user following list headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/following totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/following?cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokEmbeddedUser' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/users/{username}/followers: get: operationId: tiktokGetUserFollowers tags: - TikTok summary: Get User Followers List description: Returns a paginated list of accounts following a TikTok user. Maximum 30 per page. Includes profile details for each follower account. parameters: - schema: type: string description: TikTok username (with or without @ symbol) example: khaby.lame required: true description: TikTok username (with or without @ symbol) name: username in: path - schema: type: integer minimum: 1 maximum: 30 default: 30 description: 'Number of users to fetch (maximum: 30)' example: 30 required: false description: 'Number of users to fetch (maximum: 30)' name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query responses: '200': description: Returns the user followers list headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/followers totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/users/khaby.lame/followers?cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokEmbeddedUser' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/users/{username}/live: get: operationId: tiktokGetUserLive tags: - TikTok summary: Get User Live Stream description: Returns the current live stream for a user, including stream URLs and viewer count. Returns 404 if the user is not currently live. parameters: - schema: type: string description: TikTok username (with or without @ symbol) example: khaby.lame required: true description: TikTok username (with or without @ symbol) name: username in: path responses: '200': description: Returns the live stream details headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams object type example: Video id: type: string format: uri description: Live stream permalink example: https://www.tiktok.com/@khaby.lame/live url: type: string format: uri description: Live stream URL example: https://www.tiktok.com/@khaby.lame/live entityId: type: string description: TikTok internal room ID example: '7600000000000000001' published: type: string format: date-time description: Publication date in ISO 8601 format example: '2026-02-27T18:36:42.000Z' isLive: type: boolean description: Whether stream is currently live example: true viewCount: type: integer description: Number of views example: 42600000 viewerCount: type: integer description: Current number of viewers example: 15000 content: type: string description: Caption or description example: 'When you realize there is a simpler way #learnfromkhaby' attributedTo: allOf: - $ref: '#/components/schemas/TikTokEmbeddedUser' - description: Stream host image: allOf: - $ref: '#/components/schemas/TikTokImage' - description: Stream cover image attachment: type: array items: $ref: '#/components/schemas/TikTokLiveStreamAttachment' description: Stream media sources required: - '@context' - type - id - url - entityId - isLive - attributedTo required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/videos/{videoId}: get: operationId: tiktokGetVideo tags: - TikTok summary: Get Video Details description: Returns details for a single TikTok video including engagement counts, media files in multiple qualities, audio track, author info, and hashtags. parameters: - schema: type: string description: TikTok video ID example: '7611615657754381599' required: true description: TikTok video ID name: videoId in: path responses: '200': description: Returns the video details headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams object type example: Video id: type: string format: uri description: Video permalink example: https://www.tiktok.com/@khaby.lame/video/7611615657754381599 url: type: string format: uri description: Video URL example: https://www.tiktok.com/@khaby.lame/video/7611615657754381599 entityId: type: string description: TikTok internal video ID example: '7611615657754381599' content: type: string description: Caption or description example: 'When you realize there is a simpler way #learnfromkhaby' published: type: string format: date-time description: Publication date in ISO 8601 format example: '2026-02-27T18:36:42.000Z' duration: type: number description: Duration in seconds example: 23 viewCount: type: integer description: Number of views example: 42600000 likeCount: type: integer description: Number of likes example: 2800000 commentCount: type: integer description: Number of comments example: 29200 repostCount: type: integer description: Number of reposts example: 0 shareCount: type: integer description: Number of shares example: 157700 saveCount: type: integer description: Number of saves example: 153238 language: type: string description: Content language (BCP47 code) example: en isSponsored: type: boolean description: Whether the video is a promoted ad example: false location: type: object properties: type: type: string description: ActivityStreams object type example: Place id: type: string description: Location ID example: '213385402' name: type: string description: Location name or country code example: Los Angeles, California url: type: string format: uri description: Location page URL latitude: type: number description: Geographic latitude example: 34.0522 longitude: type: number description: Geographic longitude example: -118.2437 required: - type - name description: Location where the video was created example: type: Place name: US tag: type: array items: $ref: '#/components/schemas/TikTokTag' description: Hashtags and mentions attributedTo: $ref: '#/components/schemas/TikTokEmbeddedUser' description: Video creator attachment: type: array items: $ref: '#/components/schemas/TikTokVideoAttachment' description: Video files in multiple qualities image: allOf: - $ref: '#/components/schemas/TikTokImage' - description: Video thumbnail preview: allOf: - $ref: '#/components/schemas/TikTokImage' - description: Animated preview thumbnail audio: $ref: '#/components/schemas/TikTokAudio' description: Video audio track required: - '@context' - type - id - url - entityId - published - viewCount - likeCount - commentCount - repostCount - shareCount - saveCount - attributedTo required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/videos/{videoId}/comments: get: operationId: tiktokGetVideoComments tags: - TikTok summary: Get Video Comments description: Returns a paginated list of top-level comments on a video. Maximum 50 per page. Use the replies endpoint to fetch threaded replies. parameters: - schema: type: string description: TikTok video ID example: '7611615657754381599' required: true description: TikTok video ID name: videoId in: path - schema: type: integer minimum: 1 maximum: 50 default: 20 description: 'Number of comments to fetch (maximum: 50)' example: 20 required: false description: 'Number of comments to fetch (maximum: 50)' name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query responses: '200': description: Returns the video comments headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/videos/7611615657754381599/comments totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/videos/7611615657754381599/comments?cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokComment' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/videos/{videoId}/comments/{commentId}/replies: get: operationId: tiktokGetCommentReplies tags: - TikTok summary: Get Comment Replies description: Returns a paginated list of replies to a TikTok comment. Maximum 50 per page. Includes author info, like counts, and reply timestamps. parameters: - schema: type: string description: TikTok video ID example: '7611615657754381599' required: true description: TikTok video ID name: videoId in: path - schema: type: string description: TikTok comment ID example: '7611616052479869736' required: true description: TikTok comment ID name: commentId in: path - schema: type: integer minimum: 1 maximum: 50 default: 50 description: 'Number of replies to fetch (maximum: 50)' example: 50 required: false description: 'Number of replies to fetch (maximum: 50)' name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query responses: '200': description: Returns the comment replies headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/videos/7611615657754381599/comments/7611646895321105170/replies totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/videos/7611615657754381599/comments/7611646895321105170/replies?cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokComment' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/videos/{videoId}/transcripts/{language}: get: operationId: tiktokGetVideoTranscript tags: - TikTok summary: Get Video Transcript description: Returns the transcript for a video in a specific language. Supports both auto-generated (ASR) and machine-translated subtitles. Returns WebVTT format. parameters: - schema: type: string description: TikTok video ID example: '7611615657754381599' required: true description: TikTok video ID name: videoId in: path - schema: type: string enum: - ar-SA - az-AZ - ca-ES - ceb-PH - cs-CZ - da-DK - de-DE - en-US - es-ES - et-EE - fi-FI - fil-PH - fr-FR - ga-IE - he-IL - hr-HR - id-ID - it-IT - ja-JP - ko-KR - lv-LV - lt-LT - ms-MY - nb-NO - nl-NL - pl-PL - pt-PT - ru-RU - sw-SW - sv-SE - th-TH - uk-UA - vi-VN - zh-Hans-CN - zh-Hant-CN description: BCP47 language code example: en required: true description: BCP47 language code name: language in: path responses: '200': description: Returns the transcript in Document format or raw WebVTT headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams object type example: Document id: type: string format: uri description: Transcript permalink example: https://www.tiktok.com/@khaby.lame/video/7611615657754381599/transcript/en-US url: type: string format: uri description: Video permalink example: https://www.tiktok.com/@khaby.lame/video/7611615657754381599 mediaType: type: string description: MIME type example: text/vtt language: type: string description: BCP47 language code example: en-US size: type: integer description: File size in bytes example: 1024 source: type: string description: 'Source of the transcript: "ASR" (Automatic Speech Recognition) or "MT" (Machine Translation)' example: ASR content: type: string description: WebVTT formatted transcript content example: 'WEBVTT 00:00:00.000 --> 00:00:02.000 Hello everyone' required: - '@context' - type - id - url - mediaType - language - content required: - data text/vtt: schema: type: string '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/tags/{tagName}: get: operationId: tiktokGetTagVideos tags: - TikTok summary: Get Videos with Tag description: Returns TikTok videos associated with a hashtag or challenge. The tag name is resolved to an internal ID automatically. Includes video details and engagement counts. parameters: - schema: type: string description: Tag name example: learnfromkhaby required: true description: Tag name name: tagName in: path - schema: type: integer minimum: 1 maximum: 30 default: 30 description: 'Number of videos to fetch (maximum: 30)' example: 30 required: false description: 'Number of videos to fetch (maximum: 30)' name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query responses: '200': description: Returns the tag videos headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/tags/learnfromkhaby/videos totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/tags/learnfromkhaby/videos?cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokVideo' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/collections/{collectionId}: get: operationId: tiktokGetCollectionVideos tags: - TikTok summary: Get Collection Videos description: Returns a paginated list of videos in a TikTok collection (playlist or mix). Maximum 35 per page. Includes full video details and engagement counts. parameters: - schema: type: string description: TikTok collection ID (mix ID) example: '6966746276732559110' required: true description: TikTok collection ID (mix ID) name: collectionId in: path - schema: type: integer minimum: 1 maximum: 35 default: 20 description: 'Number of videos to fetch (maximum: 35)' example: 20 required: false description: 'Number of videos to fetch (maximum: 35)' name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query responses: '200': description: Returns the collection videos headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/collections/7200000000000000001/videos totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/collections/7200000000000000001/videos?cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokVideo' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/audios/{audioId}: get: operationId: tiktokGetAudio tags: - TikTok summary: Get Audio Details description: Returns metadata for a TikTok audio track including title, artist, duration, usage count, and cover image. Look up any sound by its audio ID. parameters: - schema: type: string description: TikTok audio/music ID example: '6988100049893232686' required: true description: TikTok audio/music ID name: audioId in: path responses: '200': description: Returns the audio details headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams object type example: Audio id: type: string format: uri description: Audio permalink example: https://www.tiktok.com/music/original-sound-7611615657754381599 url: type: string format: uri description: Audio playback URL example: https://sf16-ies-music.tiktokcdn.com/obj/tos-alisg-v/123456 name: type: string description: Track name example: original sound duration: type: number description: Duration in seconds example: 23 mediaType: type: string description: MIME type example: audio/mpeg attributedTo: anyOf: - $ref: '#/components/schemas/TikTokEmbeddedUser' - type: array items: $ref: '#/components/schemas/TikTokEmbeddedUser' description: Audio creator or artist icon: allOf: - $ref: '#/components/schemas/TikTokImage' - description: Thumbnail image image: type: array items: $ref: '#/components/schemas/TikTokImage' description: Cover images in multiple sizes entityId: type: string description: Audio ID example: '7493556331997071377' album: type: string description: Album name example: Greatest Hits isOriginal: type: boolean description: Whether audio is user-created vs a licensed track example: false isCopyrighted: type: boolean description: Whether audio has copyright restrictions example: false videoCount: type: integer description: Number of videos using this audio example: 500000 required: - '@context' - type - name - duration required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/audios/{audioId}/videos: get: operationId: tiktokGetAudioVideos tags: - TikTok summary: Get Videos with Audio description: Returns a paginated list of TikTok videos using a specific audio track. Maximum 30 per page. Discover trending content by sound or music. parameters: - schema: type: string description: TikTok audio/music ID example: '6988100049893232686' required: true description: TikTok audio/music ID name: audioId in: path - schema: type: integer minimum: 1 maximum: 30 default: 30 description: 'Number of videos to fetch (maximum: 30)' example: 30 required: false description: 'Number of videos to fetch (maximum: 30)' name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query responses: '200': description: Returns the audio videos headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/audios/7611615657754381599/videos totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/audios/7611615657754381599/videos?cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokVideo' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/search: get: operationId: tiktokSearchContent tags: - TikTok summary: Search Content description: General search that returns mixed results including videos and user profiles. Supports sorting and publish-time filters. parameters: - schema: type: string minLength: 1 description: Search query example: khaby.lame required: true description: Search query name: query in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: 'Number of items to fetch (maximum: 100, actual results may vary)' example: 50 required: false description: 'Number of items to fetch (maximum: 100, actual results may vary)' name: count in: query - schema: type: string enum: - relevance - most-liked - date-posted default: relevance description: 'Sort order: relevance (default), most-liked, or date-posted' example: relevance required: false description: 'Sort order: relevance (default), most-liked, or date-posted' name: order in: query - schema: type: string enum: - all-time - yesterday - this-week - this-month - last-3-months - last-6-months default: all-time description: 'Filter by publish time: all-time (default), yesterday, this-week, this-month, last-3-months, or last-6-months' example: all-time required: false description: 'Filter by publish time: all-time (default), yesterday, this-week, this-month, last-3-months, or last-6-months' name: published in: query responses: '200': description: Returns the search results headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/search totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/search?query=khaby&cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: oneOf: - allOf: - $ref: '#/components/schemas/TikTokVideo' - type: object properties: type: type: string enum: - Video description: Video post - allOf: - $ref: '#/components/schemas/TikTokEmbeddedUser' - type: object properties: type: type: string enum: - Person description: Compact user profile for embedded contexts - allOf: - $ref: '#/components/schemas/TikTokEmbeddedUser' - type: object properties: type: type: string enum: - Organization description: Compact user profile for embedded contexts description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/search/users: get: operationId: tiktokSearchUsers tags: - TikTok summary: Search Users description: Searches TikTok for user profiles matching a query. Fixed page size of 10 (platform limit). Returns profile details including follower counts and verification status. parameters: - schema: type: string minLength: 1 description: Search query example: khaby.lame required: true description: Search query name: query in: query - schema: type: integer minimum: 10 maximum: 10 default: 10 description: Page size (fixed at 10 by the platform) example: 10 required: false description: Page size (fixed at 10 by the platform) name: count in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query responses: '200': description: Returns the search results headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/search/users totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/search/users?query=khaby&cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokEmbeddedUser' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data /v1/tiktok/search/videos: get: operationId: tiktokSearchVideos tags: - TikTok summary: Search Videos description: Searches TikTok for videos matching a query. Supports filtering by publish time and sorting by relevance, likes, or date. parameters: - schema: type: string minLength: 1 description: Search query example: khaby.lame required: true description: Search query name: query in: query - schema: type: string default: '0' description: Pagination cursor example: '0' required: false description: Pagination cursor name: cursor in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: 'Number of videos to fetch (maximum: 100, actual results may vary)' example: 50 required: false description: 'Number of videos to fetch (maximum: 100, actual results may vary)' name: count in: query - schema: type: string enum: - relevance - most-liked - date-posted default: relevance description: 'Sort order: relevance (default), most-liked, or date-posted' example: relevance required: false description: 'Sort order: relevance (default), most-liked, or date-posted' name: order in: query - schema: type: string enum: - all-time - yesterday - this-week - this-month - last-3-months - last-6-months default: all-time description: 'Filter by publish time: all-time (default), yesterday, this-week, this-month, last-3-months, or last-6-months' required: false description: 'Filter by publish time: all-time (default), yesterday, this-week, this-month, last-3-months, or last-6-months' name: published in: query responses: '200': description: Returns the search results headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: data: type: object properties: '@context': type: array prefixItems: - type: string enum: - https://www.w3.org/ns/activitystreams# - type: string enum: - https://konbiniapi.com/ns/social# description: ActivityStreams JSON-LD context example: - https://www.w3.org/ns/activitystreams# - https://konbiniapi.com/ns/social# type: type: string description: ActivityStreams collection type example: OrderedCollectionPage partOf: type: string format: uri description: URL of the full collection example: https://api.konbiniapi.com/v1/tiktok/search/videos totalItems: type: - integer - 'null' description: Total number of items, null if unknown example: 1309 cursor: type: - string - 'null' description: Current page cursor, null on first page example: '0' nextCursor: type: - string - 'null' description: Cursor for the next page, null on last page example: '1772217402000' next: type: - string - 'null' format: uri description: URL for the next page, null on last page example: https://api.konbiniapi.com/v1/tiktok/search/videos?query=khaby&cursor=1772217402000&count=30 itemCount: type: integer description: Number of items returned in this page example: 30 orderedItems: type: array items: $ref: '#/components/schemas/TikTokVideo' description: Items in this page required: - '@context' - type - partOf - totalItems - cursor - nextCursor - next - itemCount - orderedItems required: - data '400': description: Bad Request — Invalid parameters headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - validation_error description: Machine-readable error code message: type: string example: Validation error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '401': description: Unauthorized — Missing or invalid API key content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - missing_api_key - invalid_api_key description: Machine-readable error code message: type: string example: Invalid API key description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '402': description: Payment Required — Credits exhausted content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - credits_exhausted description: Machine-readable error code message: type: string example: Credits exhausted. Upgrade your plan at konbiniapi.com description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '403': description: Forbidden — API key disabled or expired content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - api_key_disabled - api_key_expired description: Machine-readable error code message: type: string example: API key is disabled description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '404': description: Not Found headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - not_found - route_not_found description: Machine-readable error code message: type: string example: Not found description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '500': description: Internal Server Error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - internal_error description: Machine-readable error code message: type: string example: Internal error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '502': description: Bad Gateway — Upstream platform error headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - platform_error description: Machine-readable error code message: type: string example: Platform error description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data '503': description: Service Unavailable headers: X-Credits-Remaining: schema: type: integer description: Credits remaining after this request X-Credits-Used: schema: type: integer description: Credits consumed (1 if charged, 0 if refunded on error) content: application/json: schema: type: object properties: errors: type: array items: type: object properties: code: type: string enum: - service_unavailable description: Machine-readable error code message: type: string example: Service unavailable description: Human-readable error message required: - code - message description: List of errors data: type: 'null' description: Always null for error responses required: - errors - data components: schemas: TikTokCollection: type: object properties: type: type: string description: ActivityStreams object type example: OrderedCollection id: type: string format: uri description: Collection permalink example: https://www.tiktok.com/@khaby.lame/playlist/7200000000000000001 name: type: string description: Collection name example: Best of 2025 image: allOf: - $ref: '#/components/schemas/TikTokImage' - description: Collection cover image totalItems: type: - integer - 'null' description: Number of items in collection example: 42 entityId: type: string description: TikTok internal collection ID example: '7200000000000000001' attributedTo: allOf: - $ref: '#/components/schemas/TikTokEmbeddedUser' - description: Collection owner required: - type - id - name - totalItems - entityId - attributedTo description: Video collection or playlist TikTokStory: type: object properties: type: type: string description: ActivityStreams object type example: Video id: type: string format: uri description: Story permalink example: https://www.tiktok.com/@khaby.lame/video/7600000000000000000 url: type: string format: uri description: Story URL example: https://www.tiktok.com/@khaby.lame/video/7600000000000000000 entityId: type: string description: TikTok internal story ID example: '7600000000000000000' content: type: string description: Caption or description example: 'When you realize there is a simpler way #learnfromkhaby' published: type: string format: date-time description: Publication date in ISO 8601 format example: '2026-02-27T18:36:42.000Z' endTime: type: string format: date-time description: Story expiration date in ISO 8601 format example: '2026-02-28T18:36:42.000Z' viewCount: type: integer description: Number of views example: 42600000 likeCount: type: integer description: Number of likes example: 2800000 commentCount: type: integer description: Number of comments example: 29200 repostCount: type: integer description: Number of reposts example: 0 shareCount: type: integer description: Number of shares example: 157700 saveCount: type: integer description: Number of saves example: 153238 attributedTo: allOf: - $ref: '#/components/schemas/TikTokEmbeddedUser' - description: Story author duration: type: number description: Duration in seconds example: 23 attachment: type: array items: $ref: '#/components/schemas/TikTokStoryAttachment' description: Video files image: allOf: - $ref: '#/components/schemas/TikTokImage' - description: Story thumbnail preview: allOf: - $ref: '#/components/schemas/TikTokImage' - description: Animated preview thumbnail audio: allOf: - $ref: '#/components/schemas/TikTokAudio' - description: Story audio track required: - type - id - url - entityId - published - viewCount - likeCount - commentCount - repostCount - shareCount - saveCount - attributedTo description: Story post TikTokEmbeddedUser: type: object properties: type: type: string description: ActivityStreams object type example: Person id: type: string format: uri description: Profile URL example: https://www.tiktok.com/@khaby.lame url: type: string format: uri description: Profile URL example: https://www.tiktok.com/@khaby.lame entityId: type: string description: TikTok secUid example: MS4wLjABAAAAwAg0rSzO65WQfz4RzQgGv2Xdv108BgPXhRrrmNVIHQZ9PO8-flwwRtEppYTS0OjA name: type: string description: Display name example: Khabane Lame preferredUsername: type: string description: Username or handle example: khaby.lame summary: type: string description: Bio text example: Just a guy who reacts attachment: type: array items: $ref: '#/components/schemas/TikTokLink' description: External links in bio published: type: string format: date-time description: Account creation date in ISO 8601 format example: '2020-03-15T00:00:00.000Z' isPrivate: type: boolean description: Whether account is private example: false isVerified: type: boolean description: Whether account is verified example: true isLive: type: boolean description: Whether user is currently live streaming example: false hasLikes: type: boolean description: Whether user's liked videos are public example: true hasPlaylists: type: boolean description: Whether user has playlists example: true followerCount: type: integer description: Number of followers example: 160300000 followingCount: type: integer description: Number of accounts followed example: 85 language: type: string description: User language preference (BCP47 code) example: en likeCount: type: integer description: Total likes received across all content example: 2600000000 likedCount: type: integer description: Number of videos the user has liked example: 5300 mediaCount: type: integer description: Number of posts example: 1309 icon: allOf: - $ref: '#/components/schemas/TikTokImage' - description: Author avatar image: type: array items: $ref: '#/components/schemas/TikTokImage' description: Profile pictures in multiple sizes required: - type - id - url - isPrivate - isVerified description: Compact user profile for embedded contexts TikTokLink: type: object properties: type: type: string description: ActivityStreams object type example: Link href: type: string format: uri description: Link URL example: https://linktr.ee/khaby.lame rel: type: string description: Link relation hint example: preferred required: - type - href description: External link TikTokImage: type: object properties: type: type: string description: ActivityStreams object type example: Image url: type: string format: uri description: Image URL example: https://p16-sign.tiktokcdn-us.com/tos-maliva-avt-0068/avatar.jpeg width: type: integer description: Width in pixels example: 576 height: type: integer description: Height in pixels example: 1024 required: - type - url description: Image resource with optional dimensions TikTokAudio: type: object properties: type: type: string description: ActivityStreams object type example: Audio id: type: string format: uri description: Audio permalink example: https://www.tiktok.com/music/original-sound-7611615657754381599 url: type: string format: uri description: Audio playback URL example: https://sf16-ies-music.tiktokcdn.com/obj/tos-alisg-v/123456 name: type: string description: Track name example: original sound duration: type: number description: Duration in seconds example: 23 mediaType: type: string description: MIME type example: audio/mpeg attributedTo: anyOf: - $ref: '#/components/schemas/TikTokEmbeddedUser' - type: array items: $ref: '#/components/schemas/TikTokEmbeddedUser' description: Audio creator or artist icon: allOf: - $ref: '#/components/schemas/TikTokImage' - description: Thumbnail image image: type: array items: $ref: '#/components/schemas/TikTokImage' description: Cover images in multiple sizes entityId: type: string description: Audio ID example: '7493556331997071377' album: type: string description: Album name example: Greatest Hits isOriginal: type: boolean description: Whether audio is user-created vs a licensed track example: false isCopyrighted: type: boolean description: Whether audio has copyright restrictions example: false videoCount: type: integer description: Number of videos using this audio example: 500000 required: - type - name - duration description: Audio or music track TikTokVideo: type: object properties: type: type: string description: ActivityStreams object type example: Video id: type: string format: uri description: Video permalink example: https://www.tiktok.com/@khaby.lame/video/7611615657754381599 url: type: string format: uri description: Video URL example: https://www.tiktok.com/@khaby.lame/video/7611615657754381599 entityId: type: string description: TikTok internal video ID example: '7611615657754381599' content: type: string description: Caption or description example: 'When you realize there is a simpler way #learnfromkhaby' published: type: string format: date-time description: Publication date in ISO 8601 format example: '2026-02-27T18:36:42.000Z' duration: type: number description: Duration in seconds example: 23 viewCount: type: integer description: Number of views example: 42600000 likeCount: type: integer description: Number of likes example: 2800000 commentCount: type: integer description: Number of comments example: 29200 repostCount: type: integer description: Number of reposts example: 0 shareCount: type: integer description: Number of shares example: 157700 saveCount: type: integer description: Number of saves example: 153238 language: type: string description: Content language (BCP47 code) example: en isSponsored: type: boolean description: Whether the video is a promoted ad example: false location: type: object properties: type: type: string description: ActivityStreams object type example: Place id: type: string description: Location ID example: '213385402' name: type: string description: Location name or country code example: Los Angeles, California url: type: string format: uri description: Location page URL latitude: type: number description: Geographic latitude example: 34.0522 longitude: type: number description: Geographic longitude example: -118.2437 required: - type - name description: Location where the video was created example: type: Place name: US tag: type: array items: $ref: '#/components/schemas/TikTokTag' description: Hashtags and mentions attributedTo: $ref: '#/components/schemas/TikTokEmbeddedUser' description: Video creator attachment: type: array items: $ref: '#/components/schemas/TikTokVideoAttachment' description: Video files in multiple qualities image: allOf: - $ref: '#/components/schemas/TikTokImage' - description: Video thumbnail preview: allOf: - $ref: '#/components/schemas/TikTokImage' - description: Animated preview thumbnail audio: $ref: '#/components/schemas/TikTokAudio' description: Video audio track required: - type - id - url - entityId - published - viewCount - likeCount - commentCount - repostCount - shareCount - saveCount - attributedTo description: Video post TikTokVideoAttachment: type: object properties: type: type: string description: ActivityStreams object type example: Video name: type: string description: Quality label (e.g. h264_540p_829898-0) example: normal_540_0 url: type: array items: type: string format: uri description: Media download URLs example: - https://v19-webapp.tiktok.com/video/tos/us/tos-useast5-ve-0068c004/video.mp4 headers: $ref: '#/components/schemas/TikTokVideoAttachmentHeaders' description: Authentication headers for video download mediaType: type: string description: MIME type example: video/mp4 codec: type: string description: Video codec (e.g. h264, h265) example: h264 width: type: integer description: Width in pixels example: 576 height: type: integer description: Height in pixels example: 1024 bitrate: type: integer description: Bitrate in bits per second example: 1101943 required: - type - name - url - mediaType - codec - width - height - bitrate description: Video media file with download details TikTokStoryAttachment: type: object properties: type: type: string description: ActivityStreams object type example: Video url: type: array items: type: string format: uri description: Media download URLs example: - https://v19-webapp.tiktok.com/video/tos/us/tos-useast5-ve-0068c004/story.mp4 mediaType: type: string description: MIME type example: video/mp4 width: type: integer description: Width in pixels example: 576 height: type: integer description: Height in pixels example: 1024 name: type: string description: Quality label example: normal_540_0 headers: allOf: - $ref: '#/components/schemas/TikTokVideoAttachmentHeaders' - description: Authentication headers for story download codec: type: string description: Video codec example: h264 bitrate: type: integer description: Bitrate in bits per second example: 1101943 required: - type - url description: Story media file TikTokComment: type: object properties: type: type: string description: ActivityStreams object type example: Note id: type: string format: uri description: Comment permalink example: https://www.tiktok.com/@khaby.lame/video/7611615657754381599/comment/7611646895321105170 url: type: string format: uri description: Comment permalink example: https://www.tiktok.com/@khaby.lame/video/7611615657754381599/comment/7611646895321105170 entityId: type: string description: TikTok internal comment ID example: '7611646895321105170' content: type: string description: Comment text example: This man hasn't been in my fyp for so long language: type: string description: Comment language code example: en published: type: string format: date-time description: Publication date in ISO 8601 format example: '2026-02-27T20:37:38.000Z' likeCount: type: integer description: Number of likes example: 93210 replyCount: type: integer description: Number of replies example: 96 status: type: string description: Moderation status example: '1' isPinned: type: boolean description: Whether comment is pinned example: false isLiked: type: boolean description: Whether comment is liked by the video author example: false attributedTo: allOf: - $ref: '#/components/schemas/TikTokEmbeddedUser' - description: Comment author inReplyTo: type: string format: uri description: URL of parent content example: https://www.tiktok.com/@khaby.lame/video/7611615657754381599 required: - type - id - content - likeCount - attributedTo description: Video comment TikTokLiveStreamAttachment: type: object properties: type: type: string description: ActivityStreams object type example: Video url: type: array items: type: string format: uri description: Media download URLs example: - https://webcast.tiktok.com/live/pull/l4/stream.flv mediaType: type: string description: MIME type example: video/x-flv width: type: integer description: Width in pixels example: 576 height: type: integer description: Height in pixels example: 1024 name: type: string description: Stream quality label example: flv codec: type: string description: Video codec example: h264 bitrate: type: integer description: Bitrate in bits per second example: 2500000 required: - type - url - mediaType - name description: Live stream media source TikTokVideoAttachmentHeaders: type: object properties: Cookie: type: string description: Required cookie header for video download example: tt_chain_token=sTA6PK6OnvhW7YemGVwMig== Referer: type: string description: Required referer header for video download example: https://www.tiktok.com/ required: - Cookie - Referer description: HTTP headers required for authenticated media download TikTokTag: type: object properties: type: type: string description: ActivityStreams object type example: Tag name: type: string description: Tag name example: learnfromkhaby href: type: string format: uri description: Tag URL example: https://www.tiktok.com/tag/learnfromkhaby id: type: string format: uri description: Tag permalink example: https://www.tiktok.com/tag/learnfromkhaby entityId: type: string description: TikTok internal tag ID example: '1697657584273413' required: - type - name description: Hashtag or mention securitySchemes: apiKey: type: http scheme: bearer description: 'Send your API key in the Authorization header as a Bearer token. Example: `Authorization: Bearer `'