# Introduction

Overview

Every SocialTap endpoint takes the same API key and answers in one schema per kind of data. Each operation has its own page: parameters, the response field by field, prices, errors and a real example.

> [!TIP]
>
> Give your AI agent [llms.txt](https://socialtap.dev/llms.txt), the [OpenAPI spec](https://socialtap.dev/openapi.json) or [catalog.json](https://socialtap.dev/catalog.json). Every page here is also Markdown (the page menu, top right).

## Base URL

Every endpoint is served over HTTPS from one base URL:

Base URL:

```
https://socialtap.dev
```

## Authentication

Send your API key in the `x-api-key` header with every request. [Authentication](https://socialtap.dev/docs/authentication/index.md)

Header:

```
x-api-key: <your key>
```

## Endpoints

Data endpoints are `GET` requests with query parameters. Each returns `{data, meta}`, or `{data, page, meta}` for lists, where `data` follows one of 27 schemas, the same on every platform: [ads](https://socialtap.dev/resources/ad/index.md), [albums](https://socialtap.dev/resources/album/index.md), [comments](https://socialtap.dev/resources/comment/index.md), [communities](https://socialtap.dev/resources/community/index.md), [downloads](https://socialtap.dev/resources/download/index.md), [effects](https://socialtap.dev/resources/effect/index.md), [embeds](https://socialtap.dev/resources/embed/index.md), [engagement stats](https://socialtap.dev/resources/engagement/index.md), [events](https://socialtap.dev/resources/event/index.md), [hashtags](https://socialtap.dev/resources/hashtag/index.md), [livestreams](https://socialtap.dev/resources/live/index.md), [offers](https://socialtap.dev/resources/offer/index.md), [places](https://socialtap.dev/resources/place/index.md), [playlists](https://socialtap.dev/resources/playlist/index.md), [podcasts](https://socialtap.dev/resources/podcast/index.md), [posts](https://socialtap.dev/resources/post/index.md), [products](https://socialtap.dev/resources/product/index.md), [profiles](https://socialtap.dev/resources/profile/index.md), [reviews](https://socialtap.dev/resources/review/index.md), [sounds](https://socialtap.dev/resources/sound/index.md), [suggestions](https://socialtap.dev/resources/suggestion/index.md), [topics](https://socialtap.dev/resources/topic/index.md), [transcripts](https://socialtap.dev/resources/transcript/index.md), [trends](https://socialtap.dev/resources/trend/index.md), [usernames](https://socialtap.dev/resources/username/index.md), [web pages](https://socialtap.dev/resources/web_page/index.md), [web results](https://socialtap.dev/resources/web_result/index.md).

### Amazon

- [GETAmazon Deals API`/v1/amazon/deal_products`](https://socialtap.dev/docs/reference/amazon/deal_products/index.md)
- [GETAmazon Offers API`/v1/amazon/offers`](https://socialtap.dev/docs/reference/amazon/offers/index.md)
- [GETAmazon Product API`/v1/amazon/product`](https://socialtap.dev/docs/reference/amazon/product/index.md)
- [GETAmazon Reviews API`/v1/amazon/reviews`](https://socialtap.dev/docs/reference/amazon/reviews/index.md)
- [GETAmazon Product Search API`/v1/amazon/search_products`](https://socialtap.dev/docs/reference/amazon/search_products/index.md)
- [GETAmazon Seller API`/v1/amazon/seller`](https://socialtap.dev/docs/reference/amazon/seller/index.md)
- [GETAmazon Shop API`/v1/amazon/shop`](https://socialtap.dev/docs/reference/amazon/shop/index.md)
- [GETAmazon Shop Lists API`/v1/amazon/shop_lists`](https://socialtap.dev/docs/reference/amazon/shop_lists/index.md)
- [GETAmazon Shop Posts API`/v1/amazon/shop_posts`](https://socialtap.dev/docs/reference/amazon/shop_posts/index.md)
- [GETAmazon Best Sellers API`/v1/amazon/top_products`](https://socialtap.dev/docs/reference/amazon/top_products/index.md)

### Apple Music

- [GETApple Music Album API`/v1/applemusic/album`](https://socialtap.dev/docs/reference/applemusic/album/index.md)
- [GETApple Music Artist API`/v1/applemusic/artist`](https://socialtap.dev/docs/reference/applemusic/artist/index.md)
- [GETApple Music Album Search API`/v1/applemusic/search_albums`](https://socialtap.dev/docs/reference/applemusic/search_albums/index.md)
- [GETApple Music Artist Search API`/v1/applemusic/search_artists`](https://socialtap.dev/docs/reference/applemusic/search_artists/index.md)
- [GETApple Music Playlist Search API`/v1/applemusic/search_playlists`](https://socialtap.dev/docs/reference/applemusic/search_playlists/index.md)
- [GETApple Music Track Search API`/v1/applemusic/search_tracks`](https://socialtap.dev/docs/reference/applemusic/search_tracks/index.md)
- [GETApple Music Top Albums API`/v1/applemusic/top_albums`](https://socialtap.dev/docs/reference/applemusic/top_albums/index.md)
- [GETApple Music Top Playlists API`/v1/applemusic/top_playlists`](https://socialtap.dev/docs/reference/applemusic/top_playlists/index.md)
- [GETApple Music Top Tracks API`/v1/applemusic/top_tracks`](https://socialtap.dev/docs/reference/applemusic/top_tracks/index.md)
- [GETApple Music Track API`/v1/applemusic/track`](https://socialtap.dev/docs/reference/applemusic/track/index.md)

### Bluesky

- [GETBluesky Comments API`/v1/bluesky/comments`](https://socialtap.dev/docs/reference/bluesky/comments/index.md)
- [GETBluesky Post API`/v1/bluesky/post`](https://socialtap.dev/docs/reference/bluesky/post/index.md)
- [GETBluesky User Posts API`/v1/bluesky/posts`](https://socialtap.dev/docs/reference/bluesky/posts/index.md)
- [GETBluesky Profile API`/v1/bluesky/profile`](https://socialtap.dev/docs/reference/bluesky/profile/index.md)
- [GETBluesky Post Search API`/v1/bluesky/search_posts`](https://socialtap.dev/docs/reference/bluesky/search_posts/index.md)

### Facebook

- [GETFacebook Comments API`/v1/facebook/comments`](https://socialtap.dev/docs/reference/facebook/comments/index.md)
- [GETFacebook Engagement API`/v1/facebook/engagement`](https://socialtap.dev/docs/reference/facebook/engagement/index.md)
- [GETFacebook Group API`/v1/facebook/group`](https://socialtap.dev/docs/reference/facebook/group/index.md)
- [GETFacebook Group Posts API`/v1/facebook/group_posts`](https://socialtap.dev/docs/reference/facebook/group_posts/index.md)
- [GETFacebook Profile Photos API`/v1/facebook/photos`](https://socialtap.dev/docs/reference/facebook/photos/index.md)
- [GETFacebook Post API`/v1/facebook/post`](https://socialtap.dev/docs/reference/facebook/post/index.md)
- [GETFacebook Profile Posts API`/v1/facebook/posts`](https://socialtap.dev/docs/reference/facebook/posts/index.md)
- [GETFacebook Profile API`/v1/facebook/profile`](https://socialtap.dev/docs/reference/facebook/profile/index.md)
- [GETFacebook Reels API`/v1/facebook/reels`](https://socialtap.dev/docs/reference/facebook/reels/index.md)
- [GETFacebook Comment Replies API`/v1/facebook/replies`](https://socialtap.dev/docs/reference/facebook/replies/index.md)
- [GETFacebook Group Search API`/v1/facebook/search_groups`](https://socialtap.dev/docs/reference/facebook/search_groups/index.md)
- [GETFacebook Post Search API`/v1/facebook/search_posts`](https://socialtap.dev/docs/reference/facebook/search_posts/index.md)
- [GETFacebook Page and People Search API`/v1/facebook/search_profiles`](https://socialtap.dev/docs/reference/facebook/search_profiles/index.md)
- [GETFacebook Video Transcript API`/v1/facebook/transcript`](https://socialtap.dev/docs/reference/facebook/transcript/index.md)

### Facebook Ad Library

- [GETFacebook Ad Library Ad API`/v1/facebook/ad`](https://socialtap.dev/docs/reference/facebook/ad/index.md)
- [GETFacebook Ad Transcript API`/v1/facebook/ad_transcript`](https://socialtap.dev/docs/reference/facebook/ad_transcript/index.md)
- [GETFacebook Ad Library Advertiser Ads API`/v1/facebook/ads`](https://socialtap.dev/docs/reference/facebook/ads/index.md)
- [GETFacebook Ad Library Search API`/v1/facebook/search_ads`](https://socialtap.dev/docs/reference/facebook/search_ads/index.md)
- [GETFacebook Ad Library Advertiser Search API`/v1/facebook/search_advertisers`](https://socialtap.dev/docs/reference/facebook/search_advertisers/index.md)

### Facebook Marketplace

- [GETFacebook Marketplace Listing API`/v1/facebook/listing`](https://socialtap.dev/docs/reference/facebook/listing/index.md)
- [GETFacebook Marketplace Search API`/v1/facebook/search_listings`](https://socialtap.dev/docs/reference/facebook/search_listings/index.md)
- [GETFacebook Marketplace Location Search API`/v1/facebook/search_places`](https://socialtap.dev/docs/reference/facebook/search_places/index.md)

### Facebook Events

- [GETFacebook Event API`/v1/facebook/event`](https://socialtap.dev/docs/reference/facebook/event/index.md)
- [GETFacebook Page Events API`/v1/facebook/events`](https://socialtap.dev/docs/reference/facebook/events/index.md)
- [GETFacebook City Events API`/v1/facebook/place_events`](https://socialtap.dev/docs/reference/facebook/place_events/index.md)
- [GETFacebook Event Search API`/v1/facebook/search_events`](https://socialtap.dev/docs/reference/facebook/search_events/index.md)

### Google Ads Transparency Center

- [GETGoogle Ads Transparency Center Ad API`/v1/google/ad`](https://socialtap.dev/docs/reference/google/ad/index.md)
- [GETGoogle Ads Transparency Center Advertiser Ads API`/v1/google/ads`](https://socialtap.dev/docs/reference/google/ads/index.md)
- [GETGoogle Ads Transparency Center Advertiser API`/v1/google/advertiser`](https://socialtap.dev/docs/reference/google/advertiser/index.md)
- [GETGoogle Ads Transparency Center Ads by Website API`/v1/google/search_ads`](https://socialtap.dev/docs/reference/google/search_ads/index.md)
- [GETGoogle Ads Transparency Center Advertiser Search API`/v1/google/search_advertisers`](https://socialtap.dev/docs/reference/google/search_advertisers/index.md)
- [GETGoogle Ads Transparency Center Search Suggestions API`/v1/google/search_suggestions`](https://socialtap.dev/docs/reference/google/search_suggestions/index.md)

### Instagram

- [GETInstagram Comment API`/v1/instagram/comment`](https://socialtap.dev/docs/reference/instagram/comment/index.md)
- [GETInstagram Comments API`/v1/instagram/comments`](https://socialtap.dev/docs/reference/instagram/comments/index.md)
- [GETInstagram Embed API`/v1/instagram/embed`](https://socialtap.dev/docs/reference/instagram/embed/index.md)
- [GETInstagram Engagement API`/v1/instagram/engagement`](https://socialtap.dev/docs/reference/instagram/engagement/index.md)
- [GETInstagram Hashtag API`/v1/instagram/hashtag`](https://socialtap.dev/docs/reference/instagram/hashtag/index.md)
- [GETInstagram Hashtag Posts API`/v1/instagram/hashtag_posts`](https://socialtap.dev/docs/reference/instagram/hashtag_posts/index.md)
- [GETInstagram Highlights API`/v1/instagram/highlights`](https://socialtap.dev/docs/reference/instagram/highlights/index.md)
- [GETInstagram Location API`/v1/instagram/place`](https://socialtap.dev/docs/reference/instagram/place/index.md)
- [GETInstagram Location Posts API`/v1/instagram/place_posts`](https://socialtap.dev/docs/reference/instagram/place_posts/index.md)
- [GETInstagram Highlight Stories API`/v1/instagram/playlist_stories`](https://socialtap.dev/docs/reference/instagram/playlist_stories/index.md)
- [GETInstagram Post API`/v1/instagram/post`](https://socialtap.dev/docs/reference/instagram/post/index.md)
- [GETInstagram Posts API`/v1/instagram/posts`](https://socialtap.dev/docs/reference/instagram/posts/index.md)
- [GETInstagram Profile API`/v1/instagram/profile`](https://socialtap.dev/docs/reference/instagram/profile/index.md)
- [GETInstagram Reels API`/v1/instagram/reels`](https://socialtap.dev/docs/reference/instagram/reels/index.md)
- [GETInstagram Hashtag Search API`/v1/instagram/search_hashtags`](https://socialtap.dev/docs/reference/instagram/search_hashtags/index.md)
- [GETInstagram Location Search API`/v1/instagram/search_places`](https://socialtap.dev/docs/reference/instagram/search_places/index.md)
- [GETInstagram Search API`/v1/instagram/search_posts`](https://socialtap.dev/docs/reference/instagram/search_posts/index.md)
- [GETInstagram User Search API`/v1/instagram/search_profiles`](https://socialtap.dev/docs/reference/instagram/search_profiles/index.md)
- [GETInstagram Audio Search API`/v1/instagram/search_sounds`](https://socialtap.dev/docs/reference/instagram/search_sounds/index.md)
- [GETInstagram Search Suggestions API`/v1/instagram/search_suggestions`](https://socialtap.dev/docs/reference/instagram/search_suggestions/index.md)
- [GETInstagram Similar Accounts API`/v1/instagram/similar_profiles`](https://socialtap.dev/docs/reference/instagram/similar_profiles/index.md)
- [GETInstagram Audio API`/v1/instagram/sound`](https://socialtap.dev/docs/reference/instagram/sound/index.md)
- [GETInstagram Audio Reels API`/v1/instagram/sound_posts`](https://socialtap.dev/docs/reference/instagram/sound_posts/index.md)
- [GETInstagram Story API`/v1/instagram/story`](https://socialtap.dev/docs/reference/instagram/story/index.md)
- [GETInstagram Topic API`/v1/instagram/topic`](https://socialtap.dev/docs/reference/instagram/topic/index.md)
- [GETInstagram Reels Transcript API`/v1/instagram/transcript`](https://socialtap.dev/docs/reference/instagram/transcript/index.md)
- [GETInstagram Trending Reels API`/v1/instagram/trending_posts`](https://socialtap.dev/docs/reference/instagram/trending_posts/index.md)
- [GETInstagram Username Availability API`/v1/instagram/username`](https://socialtap.dev/docs/reference/instagram/username/index.md)

### Kick

- [GETKick Clip API`/v1/kick/post`](https://socialtap.dev/docs/reference/kick/post/index.md)
- [GETKick Clip Transcript API`/v1/kick/transcript`](https://socialtap.dev/docs/reference/kick/transcript/index.md)

### Komi

- [GETKomi Page API`/v1/komi/page`](https://socialtap.dev/docs/reference/komi/page/index.md)

### Kwai

- [GETKwai Post API`/v1/kwai/post`](https://socialtap.dev/docs/reference/kwai/post/index.md)
- [GETKwai User Posts API`/v1/kwai/posts`](https://socialtap.dev/docs/reference/kwai/posts/index.md)
- [GETKwai Profile API`/v1/kwai/profile`](https://socialtap.dev/docs/reference/kwai/profile/index.md)

### Lnk.Bio

- [GETLnk.Bio Profile API`/v1/linkbio/profile`](https://socialtap.dev/docs/reference/linkbio/profile/index.md)

### LinkedIn

- [GETLinkedIn Post API`/v1/linkedin/post`](https://socialtap.dev/docs/reference/linkedin/post/index.md)
- [GETLinkedIn Profile API`/v1/linkedin/profile`](https://socialtap.dev/docs/reference/linkedin/profile/index.md)
- [GETLinkedIn Post Search API`/v1/linkedin/search_posts`](https://socialtap.dev/docs/reference/linkedin/search_posts/index.md)
- [GETLinkedIn Company and People Search API`/v1/linkedin/search_profiles`](https://socialtap.dev/docs/reference/linkedin/search_profiles/index.md)

### LinkedIn Ad Library

- [GETLinkedIn Ad Library Ad API`/v1/linkedin/ad`](https://socialtap.dev/docs/reference/linkedin/ad/index.md)
- [GETLinkedIn Ad Library Search API`/v1/linkedin/search_ads`](https://socialtap.dev/docs/reference/linkedin/search_ads/index.md)

### Linkme

- [GETLinkme Profile API`/v1/linkme/profile`](https://socialtap.dev/docs/reference/linkme/profile/index.md)

### Linktree

- [GETLinktree Profile API`/v1/linktree/profile`](https://socialtap.dev/docs/reference/linktree/profile/index.md)

### Pillar

- [GETPillar Page API`/v1/pillar/page`](https://socialtap.dev/docs/reference/pillar/page/index.md)

### Pinterest

- [GETPinterest Board API`/v1/pinterest/board`](https://socialtap.dev/docs/reference/pinterest/board/index.md)
- [GETPinterest Board Pins API`/v1/pinterest/board_pins`](https://socialtap.dev/docs/reference/pinterest/board_pins/index.md)
- [GETPinterest Boards API`/v1/pinterest/boards`](https://socialtap.dev/docs/reference/pinterest/boards/index.md)
- [GETPinterest Pin API`/v1/pinterest/pin`](https://socialtap.dev/docs/reference/pinterest/pin/index.md)
- [GETPinterest Profile Pins API`/v1/pinterest/pins`](https://socialtap.dev/docs/reference/pinterest/pins/index.md)
- [GETPinterest Profile API`/v1/pinterest/profile`](https://socialtap.dev/docs/reference/pinterest/profile/index.md)
- [GETPinterest Search API`/v1/pinterest/search_pins`](https://socialtap.dev/docs/reference/pinterest/search_pins/index.md)
- [GETPinterest Trends API`/v1/pinterest/top_trends`](https://socialtap.dev/docs/reference/pinterest/top_trends/index.md)
- [GETPinterest Topic API`/v1/pinterest/topic`](https://socialtap.dev/docs/reference/pinterest/topic/index.md)
- [GETPinterest URL Save Count API`/v1/pinterest/web_page`](https://socialtap.dev/docs/reference/pinterest/web_page/index.md)

### Reddit

- [GETReddit Comments API`/v1/reddit/comments`](https://socialtap.dev/docs/reference/reddit/comments/index.md)
- [GETReddit Engagement API`/v1/reddit/engagement`](https://socialtap.dev/docs/reference/reddit/engagement/index.md)
- [GETReddit Post API`/v1/reddit/post`](https://socialtap.dev/docs/reference/reddit/post/index.md)
- [GETReddit User Posts API`/v1/reddit/posts`](https://socialtap.dev/docs/reference/reddit/posts/index.md)
- [GETReddit Profile API`/v1/reddit/profile`](https://socialtap.dev/docs/reference/reddit/profile/index.md)
- [GETReddit User Comments API`/v1/reddit/profile_comments`](https://socialtap.dev/docs/reference/reddit/profile_comments/index.md)
- [GETReddit Comment Search API`/v1/reddit/search_comments`](https://socialtap.dev/docs/reference/reddit/search_comments/index.md)
- [GETReddit Search API`/v1/reddit/search_posts`](https://socialtap.dev/docs/reference/reddit/search_posts/index.md)
- [GETReddit User Search API`/v1/reddit/search_profiles`](https://socialtap.dev/docs/reference/reddit/search_profiles/index.md)
- [GETReddit Subreddit Search API`/v1/reddit/search_subreddits`](https://socialtap.dev/docs/reference/reddit/search_subreddits/index.md)
- [GETReddit Subreddit API`/v1/reddit/subreddit`](https://socialtap.dev/docs/reference/reddit/subreddit/index.md)
- [GETReddit Subreddit Posts API`/v1/reddit/subreddit_posts`](https://socialtap.dev/docs/reference/reddit/subreddit_posts/index.md)
- [GETReddit Video Transcript API`/v1/reddit/transcript`](https://socialtap.dev/docs/reference/reddit/transcript/index.md)

### Rumble

- [GETRumble Comments API`/v1/rumble/comments`](https://socialtap.dev/docs/reference/rumble/comments/index.md)
- [GETRumble Engagement API`/v1/rumble/engagement`](https://socialtap.dev/docs/reference/rumble/engagement/index.md)
- [GETRumble Video API`/v1/rumble/post`](https://socialtap.dev/docs/reference/rumble/post/index.md)
- [GETRumble Channel Videos API`/v1/rumble/posts`](https://socialtap.dev/docs/reference/rumble/posts/index.md)
- [GETRumble Channel API`/v1/rumble/profile`](https://socialtap.dev/docs/reference/rumble/profile/index.md)
- [GETRumble Search API`/v1/rumble/search_posts`](https://socialtap.dev/docs/reference/rumble/search_posts/index.md)
- [GETRumble Transcript API`/v1/rumble/transcript`](https://socialtap.dev/docs/reference/rumble/transcript/index.md)

### Snapchat

- [GETSnapchat Comments API`/v1/snapchat/comments`](https://socialtap.dev/docs/reference/snapchat/comments/index.md)
- [GETSnapchat Profile API`/v1/snapchat/profile`](https://socialtap.dev/docs/reference/snapchat/profile/index.md)
- [GETSnapchat Spotlight API`/v1/snapchat/spotlight`](https://socialtap.dev/docs/reference/snapchat/spotlight/index.md)

### SoundCloud

- [GETSoundCloud Artist API`/v1/soundcloud/artist`](https://socialtap.dev/docs/reference/soundcloud/artist/index.md)
- [GETSoundCloud Track API`/v1/soundcloud/track`](https://socialtap.dev/docs/reference/soundcloud/track/index.md)
- [GETSoundCloud Artist Tracks API`/v1/soundcloud/tracks`](https://socialtap.dev/docs/reference/soundcloud/tracks/index.md)

### Spotify

- [GETSpotify Album API`/v1/spotify/album`](https://socialtap.dev/docs/reference/spotify/album/index.md)
- [GETSpotify Artist API`/v1/spotify/artist`](https://socialtap.dev/docs/reference/spotify/artist/index.md)
- [GETSpotify Playlist API`/v1/spotify/playlist`](https://socialtap.dev/docs/reference/spotify/playlist/index.md)
- [GETSpotify Playlist Tracks API`/v1/spotify/playlist_tracks`](https://socialtap.dev/docs/reference/spotify/playlist_tracks/index.md)
- [GETSpotify Podcast API`/v1/spotify/podcast`](https://socialtap.dev/docs/reference/spotify/podcast/index.md)
- [GETSpotify Podcast Episodes API`/v1/spotify/podcast_episodes`](https://socialtap.dev/docs/reference/spotify/podcast_episodes/index.md)
- [GETSpotify Album Search API`/v1/spotify/search_albums`](https://socialtap.dev/docs/reference/spotify/search_albums/index.md)
- [GETSpotify Artist Search API`/v1/spotify/search_artists`](https://socialtap.dev/docs/reference/spotify/search_artists/index.md)
- [GETSpotify Playlist Search API`/v1/spotify/search_playlists`](https://socialtap.dev/docs/reference/spotify/search_playlists/index.md)
- [GETSpotify Podcast Search API`/v1/spotify/search_podcasts`](https://socialtap.dev/docs/reference/spotify/search_podcasts/index.md)
- [GETSpotify Track Search API`/v1/spotify/search_tracks`](https://socialtap.dev/docs/reference/spotify/search_tracks/index.md)
- [GETSpotify Track API`/v1/spotify/track`](https://socialtap.dev/docs/reference/spotify/track/index.md)

### Telegram

- [GETTelegram Channel API`/v1/telegram/channel`](https://socialtap.dev/docs/reference/telegram/channel/index.md)
- [GETTelegram Channel Posts API`/v1/telegram/channel_posts`](https://socialtap.dev/docs/reference/telegram/channel_posts/index.md)
- [GETTelegram Post API`/v1/telegram/post`](https://socialtap.dev/docs/reference/telegram/post/index.md)
- [GETTelegram Channel Search API`/v1/telegram/search_channels`](https://socialtap.dev/docs/reference/telegram/search_channels/index.md)

### Threads

- [GETThreads Comments API`/v1/threads/comments`](https://socialtap.dev/docs/reference/threads/comments/index.md)
- [GETThreads Post API`/v1/threads/post`](https://socialtap.dev/docs/reference/threads/post/index.md)
- [GETThreads Posts API`/v1/threads/posts`](https://socialtap.dev/docs/reference/threads/posts/index.md)
- [GETThreads Profile API`/v1/threads/profile`](https://socialtap.dev/docs/reference/threads/profile/index.md)
- [GETThreads Search API`/v1/threads/search_posts`](https://socialtap.dev/docs/reference/threads/search_posts/index.md)
- [GETThreads User Search API`/v1/threads/search_profiles`](https://socialtap.dev/docs/reference/threads/search_profiles/index.md)

### TikTok

- [GETTikTok Comment API`/v1/tiktok/comment`](https://socialtap.dev/docs/reference/tiktok/comment/index.md)
- [GETTikTok Comments API`/v1/tiktok/comments`](https://socialtap.dev/docs/reference/tiktok/comments/index.md)
- [GETTikTok Download API`/v1/tiktok/download`](https://socialtap.dev/docs/reference/tiktok/download/index.md)
- [GETTikTok Effect API`/v1/tiktok/effect`](https://socialtap.dev/docs/reference/tiktok/effect/index.md)
- [GETTikTok Effect Posts API`/v1/tiktok/effect_posts`](https://socialtap.dev/docs/reference/tiktok/effect_posts/index.md)
- [GETTikTok Engagement API`/v1/tiktok/engagement`](https://socialtap.dev/docs/reference/tiktok/engagement/index.md)
- [GETTikTok Followers API`/v1/tiktok/followers`](https://socialtap.dev/docs/reference/tiktok/followers/index.md)
- [GETTikTok Following API`/v1/tiktok/following`](https://socialtap.dev/docs/reference/tiktok/following/index.md)
- [GETTikTok Hashtag API`/v1/tiktok/hashtag`](https://socialtap.dev/docs/reference/tiktok/hashtag/index.md)
- [GETTikTok Hashtag Posts API`/v1/tiktok/hashtag_posts`](https://socialtap.dev/docs/reference/tiktok/hashtag_posts/index.md)
- [GETTikTok Liked Posts API`/v1/tiktok/liked_posts`](https://socialtap.dev/docs/reference/tiktok/liked_posts/index.md)
- [GETTikTok Live API`/v1/tiktok/live`](https://socialtap.dev/docs/reference/tiktok/live/index.md)
- [GETTikTok Place Posts API`/v1/tiktok/place_posts`](https://socialtap.dev/docs/reference/tiktok/place_posts/index.md)
- [GETTikTok Playlist Posts API`/v1/tiktok/playlist_posts`](https://socialtap.dev/docs/reference/tiktok/playlist_posts/index.md)
- [GETTikTok Playlists API`/v1/tiktok/playlists`](https://socialtap.dev/docs/reference/tiktok/playlists/index.md)
- [GETTikTok Post API`/v1/tiktok/post`](https://socialtap.dev/docs/reference/tiktok/post/index.md)
- [GETTikTok Posts API`/v1/tiktok/posts`](https://socialtap.dev/docs/reference/tiktok/posts/index.md)
- [GETTikTok Profile API`/v1/tiktok/profile`](https://socialtap.dev/docs/reference/tiktok/profile/index.md)
- [GETTikTok Comment Replies API`/v1/tiktok/replies`](https://socialtap.dev/docs/reference/tiktok/replies/index.md)
- [GETTikTok Hashtag Search API`/v1/tiktok/search_hashtags`](https://socialtap.dev/docs/reference/tiktok/search_hashtags/index.md)
- [GETTikTok Search API`/v1/tiktok/search_posts`](https://socialtap.dev/docs/reference/tiktok/search_posts/index.md)
- [GETTikTok User Search API`/v1/tiktok/search_profiles`](https://socialtap.dev/docs/reference/tiktok/search_profiles/index.md)
- [GETTikTok Sound Search API`/v1/tiktok/search_sounds`](https://socialtap.dev/docs/reference/tiktok/search_sounds/index.md)
- [GETTikTok Search Suggestions API`/v1/tiktok/search_suggestions`](https://socialtap.dev/docs/reference/tiktok/search_suggestions/index.md)
- [GETTikTok Top Search API`/v1/tiktok/search_top`](https://socialtap.dev/docs/reference/tiktok/search_top/index.md)
- [GETTikTok Sound API`/v1/tiktok/sound`](https://socialtap.dev/docs/reference/tiktok/sound/index.md)
- [GETTikTok Sound Posts API`/v1/tiktok/sound_posts`](https://socialtap.dev/docs/reference/tiktok/sound_posts/index.md)
- [GETTikTok Top Videos API`/v1/tiktok/top_posts`](https://socialtap.dev/docs/reference/tiktok/top_posts/index.md)
- [GETTikTok Transcript API`/v1/tiktok/transcript`](https://socialtap.dev/docs/reference/tiktok/transcript/index.md)
- [GETTikTok Trending Hashtags API`/v1/tiktok/trending_hashtags`](https://socialtap.dev/docs/reference/tiktok/trending_hashtags/index.md)
- [GETTikTok Trending Videos API`/v1/tiktok/trending_posts`](https://socialtap.dev/docs/reference/tiktok/trending_posts/index.md)

### TikTok Ad Library

- [GETTikTok Ad Library Ad API`/v1/tiktok/ad`](https://socialtap.dev/docs/reference/tiktok/ad/index.md)
- [GETTikTok Ad Library Search API`/v1/tiktok/search_ads`](https://socialtap.dev/docs/reference/tiktok/search_ads/index.md)
- [GETTikTok Top Ads API`/v1/tiktok/top_ads`](https://socialtap.dev/docs/reference/tiktok/top_ads/index.md)

### TikTok Shop

- [GETTikTok Shop Product API`/v1/tiktokshop/product`](https://socialtap.dev/docs/reference/tiktokshop/product/index.md)
- [GETTikTok Shop Store Products API`/v1/tiktokshop/products`](https://socialtap.dev/docs/reference/tiktokshop/products/index.md)
- [GETTikTok Shop Reviews API`/v1/tiktokshop/reviews`](https://socialtap.dev/docs/reference/tiktokshop/reviews/index.md)
- [GETTikTok Shop Search API`/v1/tiktokshop/search_products`](https://socialtap.dev/docs/reference/tiktokshop/search_products/index.md)

### Truth Social

- [GETTruth Social Post API`/v1/truthsocial/post`](https://socialtap.dev/docs/reference/truthsocial/post/index.md)
- [GETTruth Social Posts API`/v1/truthsocial/posts`](https://socialtap.dev/docs/reference/truthsocial/posts/index.md)
- [GETTruth Social Profile API`/v1/truthsocial/profile`](https://socialtap.dev/docs/reference/truthsocial/profile/index.md)

### Twitch

- [GETTwitch Profile API`/v1/twitch/profile`](https://socialtap.dev/docs/reference/twitch/profile/index.md)
- [GETTwitch Schedule API`/v1/twitch/schedule`](https://socialtap.dev/docs/reference/twitch/schedule/index.md)
- [GETTwitch Clip Transcript API`/v1/twitch/transcript`](https://socialtap.dev/docs/reference/twitch/transcript/index.md)
- [GETTwitch Video and Clip API`/v1/twitch/video`](https://socialtap.dev/docs/reference/twitch/video/index.md)
- [GETTwitch Videos API`/v1/twitch/videos`](https://socialtap.dev/docs/reference/twitch/videos/index.md)

### X

- [GETX (Twitter) Community API`/v1/x/community`](https://socialtap.dev/docs/reference/x/community/index.md)
- [GETX (Twitter) Post API`/v1/x/post`](https://socialtap.dev/docs/reference/x/post/index.md)
- [GETX (Twitter) Profile API`/v1/x/profile`](https://socialtap.dev/docs/reference/x/profile/index.md)
- [GETX (Twitter) Community Search API`/v1/x/search_communities`](https://socialtap.dev/docs/reference/x/search_communities/index.md)
- [GETX (Twitter) Hashtag Search API`/v1/x/search_hashtags`](https://socialtap.dev/docs/reference/x/search_hashtags/index.md)
- [GETX (Twitter) Post Search API`/v1/x/search_posts`](https://socialtap.dev/docs/reference/x/search_posts/index.md)
- [GETX (Twitter) User Search API`/v1/x/search_profiles`](https://socialtap.dev/docs/reference/x/search_profiles/index.md)

### YouTube

- [GETYouTube Comments API`/v1/youtube/comments`](https://socialtap.dev/docs/reference/youtube/comments/index.md)
- [GETYouTube Engagement API`/v1/youtube/engagement`](https://socialtap.dev/docs/reference/youtube/engagement/index.md)
- [GETYouTube Video API`/v1/youtube/post`](https://socialtap.dev/docs/reference/youtube/post/index.md)
- [GETYouTube Channel Videos API`/v1/youtube/posts`](https://socialtap.dev/docs/reference/youtube/posts/index.md)
- [GETYouTube Channel API`/v1/youtube/profile`](https://socialtap.dev/docs/reference/youtube/profile/index.md)
- [GETYouTube Transcript API`/v1/youtube/transcript`](https://socialtap.dev/docs/reference/youtube/transcript/index.md)

## Conventions

`data` follows the resource's shared schema; `null` means unknown, never 0 or "". Errors are non-2xx responses with this body: branch on `error.code`, never on the message ([error codes](https://socialtap.dev/docs/errors/index.md)).

Error body:

```json
{
  "error": {
    "code": "<code>",
    "message": "…",
    "request_id": "…",
    "status": "…",
    "retryable": "…",
    "param": "…",
    "remediation": "…",
    "doc_url": "…",
    "details": "…",
    "charged": "…"
  }
}
```

### The `meta` object

| Field | Type | Description |
| --- | --- | --- |
| `meta.request_id` | `string` | Unique request ID; include it when contacting support. |
| `meta.platform` | `string` | Platform ID of the endpoint (youtube, tiktok, …). |
| `meta.source` | `string` | Which upstream strategy produced the data. |
| `meta.is_cached` | `boolean` | True when served from the cache (free); see max_age. |
| `meta.credits_charged` | `integer` | Credits charged for this request (0 for errors and cache hits). |
| `meta.latency_ms` | `integer` | Time SocialTap spent on the request, in milliseconds. |
| `meta.fetched_at` | `string` (date-time) | When the data was fetched from the platform, RFC 3339 UTC (older than the request for cache hits). |
| `meta.input` | `object` or `null` | What the request's url or handle resolved to: kind, platform ID and canonical URL, so you can confirm what was fetched; null for searches. |
| `meta.input.kind` | `string` | What the input points to (profile, video, post, …). New values may be added; treat unknown values as other. |
| `meta.input.id` | `string` or `null` | Platform-native ID of the item; null when it is only known after the fetch and the request failed. |
| `meta.input.url` | `string` or `null` | Canonical URL of the item; null when unknown. |
| `meta.credits_remaining` | `integer` or `null` | Account balance after this request (the x-credits-remaining header); for a busy account an estimate that may not yet subtract concurrent requests (about a second of usage), never below the real balance; null when SocialTap could not read it. |
| `meta.client_request_id` | `string` or `null` | Your x-client-request-id, echoed; null when you sent none. |
| `meta.warnings` | `object[]` | Things to act on that did not fail the request: a deprecated endpoint, partial data, items a list's walk leaves out. \[\] when none. |
| `meta.warnings[].code` | `string` | Machine-readable warning code (see the warnings list). New codes may be added. |
| `meta.warnings[].message` | `string` | What to do about it. |
| `meta.warnings[].doc_url` | `string` | Where to read more (the changelog entry, the endpoint's docs). |
| `meta.warnings[].fields` | `string[]` | partial_data: the output fields (catalog paths such as metrics.view_count) that are null or \[\] because part of the data could not be fetched; absent for other codes. |

### List endpoints

Repeat the same request with `cursor` set to `page.next_cursor` while `page.has_more` is true ([pagination guide](https://socialtap.dev/docs/pagination/index.md)).

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `limit` optional | `integer`<br>min 1 | Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for. | — |
| `cursor` optional | `string` | page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page. | — |

| Field | Type | Description |
| --- | --- | --- |
| `page.has_more` | `boolean` | True when another page exists; then next_cursor is set. An empty page with has_more true is not the end. |
| `page.next_cursor` | `string` or `null` | Pass as cursor, with the same other parameters, to get the next page; null at the end. |
| `page.next_cursor_expires_at` | `string` (date-time) or `null` | When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors. |
| `page.end_reason` | `string` or `null` | Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.<br>One of `end`, `platform_limit`, `max_pages` |

### Parameters every endpoint accepts

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `max_age` optional | `integer`<br>min 0 | Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. | — |
| `fields` optional | `string` | Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments\[\].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole. | — |

### Request headers

| Header | Type | Description |
| --- | --- | --- |
| `x-api-key` | `string` | Your API key. |
| `authorization` | `string` | Bearer \<your API key>: the same key as x-api-key, in the form most HTTP and MCP clients send (x-api-key wins when both are sent). |
| `x-account-id` | `string` | Dashboard session only: the account (acct_…) to act on, one of Session.accounts (default: the person's own); one they aren't on is refused (forbidden, reason not_a_member). API keys ignore it. |
| `x-client-request-id` | `string` | Your own ID for the request (1–128 printable ASCII characters): echoed back and logged with ours, so support can find a request whose response never reached you. |
| `traceparent` | `string` | W3C Trace Context of your trace: recorded with the request (its trace ID) so a trace can be matched to ours; SocialTap starts its own trace. |
| `idempotency-key` | `string` | On any POST: your unique key for the request (1–255 printable ASCII characters; a UUID is ideal), kept 24 hours. Retrying with the same key and body never repeats the work: the answer is the first request's result, in its current state. |
| `prefer` | `string` | RFC 7240. respond-async on any endpoint request runs it as a one-request job: the answer is 202 with the job (Location: its URL) instead of the result. |
| `cache-control` | `string` | max-age=N accepts a cached response up to N seconds old, like the max_age parameter (max_age wins when both are sent). Other directives are ignored. |

### Response headers

| Header | Type | Description |
| --- | --- | --- |
| `x-request-id` | `string` | Unique request ID; include it when contacting support. |
| `x-credits-charged` | `int` | Credits charged for this request (0 for errors and cache hits). |
| `x-credits-remaining` | `int` | Account balance after this request; for a busy account an estimate that may not yet subtract concurrent requests (about a second of usage), never below the real balance. |
| `retry-after` | `int` | Seconds to wait before retrying; sent only with the codes whose retry_after is set in the error codes list (never on credit errors). |
| `allow` | `string` | Methods the endpoint accepts (method_not_allowed only). |
| `age` | `int` | Seconds since the data was fetched (cache hits only). |
| `x-client-request-id` | `string` | Your x-client-request-id, echoed (also meta.client_request_id). |
| `ratelimit-policy` | `string` | The account's runaway-protection ceiling as an IETF RateLimit-Policy field, as enforced: a token bucket of q requests (twice the ceiling in requests per second, at least 10) that refills in w seconds: "account";q=\<requests>;w=\<seconds>. Not a plan limit. |
| `ratelimit` | `string` | What is left of the ceiling (IETF RateLimit field): "account";r=\<requests that may be sent at once now>;t=\<seconds until the bucket is full again>. |
| `deprecation` | `string` | RFC 9745: the endpoint is deprecated, as of this date (@\<unix seconds>; may be in the future). Also in meta.warnings. |
| `sunset` | `string` | RFC 8594: when a deprecated endpoint stops answering (HTTP-date); from then on it answers endpoint_retired. |
| `link` | `string` | RFC 8288 links: rel="next" is the next page of a list (while page.has_more), the same request with cursor set; rel="deprecation" is a deprecated endpoint's notice. |
| `location` | `string` | On 202 answers: the job's URL (GET it, free, for its status). |
| `preference-applied` | `string` | RFC 7240: respond-async when Prefer: respond-async turned the request into a job (202). |
| `idempotent-replayed` | `bool` | true when the answer replays an earlier request with the same Idempotency-Key (it shows the resource's current state). |

## Account, billing, jobs and webhooks

The operations SocialTap serves itself. Their JSON answers are `{data, meta}` (plus `page` on cursor-paged lists); every one is free unless it says otherwise.

### Status

- [GETLive health of every endpoint`/status.json`](https://socialtap.dev/docs/reference/status/get/index.md)

### Account

- [DELETEDelete the account (after a grace period)`/v1/account`](https://socialtap.dev/docs/reference/account/delete/index.md)
- [GETGet the account, balance and calling key`/v1/account`](https://socialtap.dev/docs/reference/account/get/index.md)
- [PATCHUpdate account settings`/v1/account`](https://socialtap.dev/docs/reference/account/update/index.md)
- [GETList credit transactions (the ledger)`/v1/credit_transactions`](https://socialtap.dev/docs/reference/account/credit-transactions-list/index.md)
- [GETUsage report: requests and credits over time`/v1/usage`](https://socialtap.dev/docs/reference/account/usage-list/index.md)
- [GETRequest rate against the runaway-protection ceiling`/v1/usage/rate`](https://socialtap.dev/docs/reference/account/usage-rate-list/index.md)

### Team

- [POSTLeave the account`/v1/account/leave`](https://socialtap.dev/docs/reference/team/account-leave/index.md)
- [POSTHand the account to another member`/v1/account/transfer`](https://socialtap.dev/docs/reference/team/account-transfer/index.md)
- [GETList invitations waiting to be accepted`/v1/invitations`](https://socialtap.dev/docs/reference/team/invitations-list/index.md)
- [POSTInvite someone by email`/v1/invitations`](https://socialtap.dev/docs/reference/team/invitations-create/index.md)
- [POSTAccept an invitation`/v1/invitations/accept`](https://socialtap.dev/docs/reference/team/invitations-accept/index.md)
- [DELETERevoke an invitation`/v1/invitations/{id}`](https://socialtap.dev/docs/reference/team/invitations-revoke/index.md)
- [GETList the account's people`/v1/members`](https://socialtap.dev/docs/reference/team/members-list/index.md)
- [DELETERemove someone from the account`/v1/members/{user_id}`](https://socialtap.dev/docs/reference/team/members-remove/index.md)
- [PATCHChange someone's role`/v1/members/{user_id}`](https://socialtap.dev/docs/reference/team/members-update/index.md)

### Signup

- [POSTApprove an agent's request for a key`/v1/agent_claims/approve`](https://socialtap.dev/docs/reference/signup/agent-claims-approve/index.md)
- [POSTRefuse an agent's request for a key`/v1/agent_claims/deny`](https://socialtap.dev/docs/reference/signup/agent-claims-deny/index.md)
- [POSTSee an agent's request for a key`/v1/agent_claims/lookup`](https://socialtap.dev/docs/reference/signup/agent-claims-lookup/index.md)
- [POSTSign up as an agent: a key that works on confirm`/v1/agent_signup`](https://socialtap.dev/docs/reference/signup/agent-signup-create/index.md)
- [GETList sign-in and security events`/v1/security_events`](https://socialtap.dev/docs/reference/signup/security-events-list/index.md)
- [DELETESign out`/v1/session`](https://socialtap.dev/docs/reference/signup/session-delete/index.md)
- [GETGet the dashboard session`/v1/session`](https://socialtap.dev/docs/reference/signup/session-get/index.md)
- [POSTStart the dashboard: set up the account`/v1/session`](https://socialtap.dev/docs/reference/signup/session-create/index.md)

### API keys

- [GETList API keys`/v1/api_keys`](https://socialtap.dev/docs/reference/api-keys/list/index.md)
- [POSTCreate an API key`/v1/api_keys`](https://socialtap.dev/docs/reference/api-keys/create/index.md)
- [DELETERevoke an API key`/v1/api_keys/{id}`](https://socialtap.dev/docs/reference/api-keys/revoke/index.md)
- [GETGet an API key`/v1/api_keys/{id}`](https://socialtap.dev/docs/reference/api-keys/get/index.md)
- [PATCHUpdate an API key`/v1/api_keys/{id}`](https://socialtap.dev/docs/reference/api-keys/update/index.md)
- [POSTRotate an API key's secret`/v1/api_keys/{id}/rotate_secret`](https://socialtap.dev/docs/reference/api-keys/rotate-secret/index.md)

### Billing

- [GETGet auto top-up`/v1/billing/auto_topup`](https://socialtap.dev/docs/reference/billing/auto-topup-get/index.md)
- [PATCHTurn auto top-up on or off, or change it`/v1/billing/auto_topup`](https://socialtap.dev/docs/reference/billing/auto-topup-update/index.md)
- [POSTBuy a credit pack (Stripe Checkout)`/v1/billing/checkout`](https://socialtap.dev/docs/reference/billing/checkout-create/index.md)
- [GETGet a credit pack purchase`/v1/billing/checkout/{id}`](https://socialtap.dev/docs/reference/billing/checkout-get/index.md)
- [POSTOpen the payment settings (Stripe)`/v1/billing/portal`](https://socialtap.dev/docs/reference/billing/portal-create/index.md)
- [POSTRedeem a promo code`/v1/billing/promo_codes/redeem`](https://socialtap.dev/docs/reference/billing/promo-codes-redeem/index.md)
- [GETList purchases`/v1/billing/purchases`](https://socialtap.dev/docs/reference/billing/purchases-list/index.md)
- [GETGet a purchase's receipt`/v1/billing/purchases/{id}/receipt`](https://socialtap.dev/docs/reference/billing/purchases-receipt/index.md)
- [GETGet the monthly plan`/v1/billing/subscription`](https://socialtap.dev/docs/reference/billing/subscription-get/index.md)
- [PATCHChange the monthly plan`/v1/billing/subscription`](https://socialtap.dev/docs/reference/billing/subscription-update/index.md)
- [POSTCancel the monthly plan, or undo it`/v1/billing/subscription/cancel`](https://socialtap.dev/docs/reference/billing/subscription-cancel/index.md)
- [POSTStart a monthly plan (Stripe Checkout)`/v1/billing/subscription/checkout`](https://socialtap.dev/docs/reference/billing/subscription-checkout/index.md)

### Events

- [GETList events, newest first`/v1/events`](https://socialtap.dev/docs/reference/events/list/index.md)
- [GETGet an event`/v1/events/{id}`](https://socialtap.dev/docs/reference/events/get/index.md)
- [POSTDeliver an event again`/v1/events/{id}/redeliver`](https://socialtap.dev/docs/reference/events/redeliver/index.md)

### Jobs

- [GETList jobs, newest first`/v1/jobs`](https://socialtap.dev/docs/reference/jobs/list/index.md)
- [POSTRun many requests (or one long one) as a job`/v1/jobs`](https://socialtap.dev/docs/reference/jobs/create/index.md)
- [GETGet a job (free to poll)`/v1/jobs/{id}`](https://socialtap.dev/docs/reference/jobs/get/index.md)
- [POSTCancel a job`/v1/jobs/{id}/cancel`](https://socialtap.dev/docs/reference/jobs/cancel/index.md)
- [GETList a job's results as they complete`/v1/jobs/{id}/results`](https://socialtap.dev/docs/reference/jobs/results-list/index.md)
- [GETDownload every result of a job (JSON Lines)`/v1/jobs/{id}/results.jsonl`](https://socialtap.dev/docs/reference/jobs/results-download/index.md)

### Notifications

- [GETGet notification preferences`/v1/notification_preferences`](https://socialtap.dev/docs/reference/notifications/notification-preferences-get/index.md)
- [PATCHUpdate notification preferences`/v1/notification_preferences`](https://socialtap.dev/docs/reference/notifications/notification-preferences-update/index.md)
- [GETList the dashboard's notifications, newest first`/v1/notifications`](https://socialtap.dev/docs/reference/notifications/list/index.md)
- [POSTMark notifications read`/v1/notifications/read`](https://socialtap.dev/docs/reference/notifications/read/index.md)
- [GETCount unread notifications`/v1/notifications/summary`](https://socialtap.dev/docs/reference/notifications/summary/index.md)

### Requests

- [GETList requests, newest first (the request log)`/v1/requests`](https://socialtap.dev/docs/reference/requests/list/index.md)
- [GETGet a request from the request log`/v1/requests/{id}`](https://socialtap.dev/docs/reference/requests/get/index.md)
- [GETGet the response a request returned`/v1/requests/{id}/response`](https://socialtap.dev/docs/reference/requests/get-response/index.md)

### Docs

- [POSTRun a free tool`/v1/tool_runs`](https://socialtap.dev/docs/reference/docs/tool-runs-create/index.md)

### Webhooks

- [GETList webhook endpoints`/v1/webhook_endpoints`](https://socialtap.dev/docs/reference/webhooks/webhook-endpoints-list/index.md)
- [POSTRegister a webhook endpoint`/v1/webhook_endpoints`](https://socialtap.dev/docs/reference/webhooks/webhook-endpoints-create/index.md)
- [DELETEDelete a webhook endpoint`/v1/webhook_endpoints/{id}`](https://socialtap.dev/docs/reference/webhooks/webhook-endpoints-delete/index.md)
- [GETGet a webhook endpoint`/v1/webhook_endpoints/{id}`](https://socialtap.dev/docs/reference/webhooks/webhook-endpoints-get/index.md)
- [PATCHUpdate a webhook endpoint`/v1/webhook_endpoints/{id}`](https://socialtap.dev/docs/reference/webhooks/webhook-endpoints-update/index.md)
- [GETList an endpoint's delivery attempts`/v1/webhook_endpoints/{id}/deliveries`](https://socialtap.dev/docs/reference/webhooks/webhook-endpoints-deliveries-list/index.md)
- [POSTRotate a webhook endpoint's signing secret`/v1/webhook_endpoints/{id}/rotate_secret`](https://socialtap.dev/docs/reference/webhooks/webhook-endpoints-rotate-secret/index.md)
- [POSTSend a webhook.test event to an endpoint`/v1/webhook_endpoints/{id}/test`](https://socialtap.dev/docs/reference/webhooks/webhook-endpoints-test/index.md)

### Their `meta`

| Field | Type | Description |
| --- | --- | --- |
| `meta.client_request_id` | `string` or `null` | Your x-client-request-id, echoed; null when you sent none. |
| `meta.credits_charged` | `integer` | Always 0: the gateway's own routes are free (a job's items are charged as they end, at their endpoints' prices). |
| `meta.credits_remaining` | `integer` or `null` | Account balance; null without an account (signup) or when SocialTap could not read it. |
| `meta.request_id` | `string` | Unique request ID; include it when contacting support. |
| `meta.warnings` | `object[]` | Things to act on that did not fail the request. \[\] when none. |
| `meta.warnings[].code` | `string` | Machine-readable warning code (see the warnings list). New codes may be added. |
| `meta.warnings[].doc_url` | `string` | Where to read more (the changelog entry, the endpoint's docs). |
| `meta.warnings[].fields?` | `string[]` | partial_data: the output fields (catalog paths such as metrics.view_count) that are null or \[\] because part of the data could not be fetched; absent for other codes. |
| `meta.warnings[].message` | `string` | What to do about it. |

---

[HTML version](https://socialtap.dev/docs/reference/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)