KonbiniAPI

https://docs.konbiniapi.com
Admin
KonbiniAPI is a unified data layer and MCP server for Instagram, TikTok, X, Reddit, and LinkedIn...
Tokens:138,911
Snippets:710
Trust Score:4.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Pagination Example

Source: https://docs.konbiniapi.com/reference/api/instagram/get-user-posts

Example of the next page URL structure returned in the API response.

```text
https://api.konbiniapi.com/v1/instagram/users/khaby00/posts?cursor=abc123&count=12
```

--------------------------------

### XImage Schema Example

Source: https://docs.konbiniapi.com/reference/api/x/get-post

Example values for the XImage object representing a profile picture.

```yaml
type: Image
url: https://pbs.twimg.com/amplify_video_thumb/2024515147692195840/img/t8ePmit3Wst1hxAM.jpg
width: 1536
height: 2048
```

--------------------------------

### x_get_community_media tool call example

Source: https://docs.konbiniapi.com/reference/mcp/tools/x/get-community-media

Example of a tool call structure for retrieving community media with specific data and item fields.

```json
{
  "name": "x_get_community_media",
  "arguments": {
    "communityId": "<communityId>",
    "count": 40,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "published",
      "content",
      "url",
      "viewCount"
    ]
  }
}
```

--------------------------------

### x_get_user_posts tool call example

Source: https://docs.konbiniapi.com/reference/mcp/tools/x/get-user-posts

Example JSON payload for invoking the x_get_user_posts tool with specific projection settings and requested data fields.

```json
{
  "name": "x_get_user_posts",
  "arguments": {
    "username": "khaby.lame",
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "published",
      "content",
      "url",
      "viewCount"
    ]
  }
}
```

--------------------------------

### RedditQuotedPost Schema Examples

Source: https://docs.konbiniapi.com/reference/api/reddit/get-post

Schema definition and example values for a quoted Reddit post.

```yaml
id:
          type: string
          format: uri
          description: Quoted post permalink
          example: https://www.reddit.com/r/programming/comments/post_1/launch_day/
        url:
          type: string
          format: uri
          description: Quoted post permalink
          example: https://www.reddit.com/r/programming/comments/post_1/launch_day/
        entityId:
          type: string
          description: Quoted Reddit post ID
          example: post_1
        name:
          type: string
          description: Quoted post title
          example: Launch day
        content:
          type:
            - string
            - 'null'
          description: Post body text
          example: We shipped Reddit support.
        published:
          type: string
          format: date-time
          description: Publication date in ISO 8601 format
          example: '2026-02-27T20:37:38.000Z'
        isEdited:
          type: boolean
          description: Whether the post has been edited
          example: false
        isLocked:
          type: boolean
          description: Whether the post is locked
          example: false
        isOriginal:
          type: boolean
          description: Whether the post is marked as original content
          example: false
        isPinned:
          type: boolean
          description: Whether the post is stickied
          example: false
        isSponsored:
          type: boolean
          description: Whether the post is promoted
          example: false
        isAdult:
          type: boolean
          description: Whether the post is marked as adult content
          example: false
        isSpoiler:
          type: boolean
          description: Whether the post is marked as a spoiler
          example: false
        isSearchable:
          type: boolean
          description: Whether the post is visible to search engines
          example: true
        likeCount:
          type: integer
          description: Number of likes
          example: 93210
        voteCount:
          type: integer
          description: Net score
          example: 118
        commentCount:
          type: integer
          description: Comment count
          example: 15
```

--------------------------------

### XLinkAttachment Schema Example

Source: https://docs.konbiniapi.com/reference/api/x/get-post

Example values for the XLinkAttachment object representing a link preview.

```yaml
type: Link
href: https://www.formulae.com/en/latest/article/nissan-and-khaby-lame-share-the-track-in-jeddah.3xexample
name: Nissan and Khaby Lame share the track in Jeddah
summary: A quick recap from Formula E race week in Jeddah.
```

--------------------------------

### XAttachment Schema Example

Source: https://docs.konbiniapi.com/reference/api/x/get-post

Example values for the XAttachment object representing a post media attachment.

```yaml
type: Video
url:
  - https://video.twimg.com/ext_tw_video/123/pu/vid/avc1/example.mp4
mediaType: video/mp4
width: 1280
height: 720
bitrate: 950000
duration: 16.266
```

--------------------------------

### XTag Schema Example

Source: https://docs.konbiniapi.com/reference/api/x/get-post

Example values for the XTag object representing a hashtag or user mention.

```yaml
type: Tag
name: learnfromkhaby
href: https://x.com/hashtag/learnfromkhaby
```

--------------------------------

### XLink Schema Example

Source: https://docs.konbiniapi.com/reference/api/x/get-post

Example values for the XLink object representing an external link.

```yaml
type: Link
href: https://t.co/examplelink
rel: preferred
```

--------------------------------

### Author Object Schema Example

Source: https://docs.konbiniapi.com/reference/api/linkedin/get-user-posts

Example structure of a post author object including type, URL, and follower metrics.

```yaml
type: Person
id: https://www.linkedin.com/in/reidhoffman
url: https://www.linkedin.com/in/reidhoffman
name: Reid Hoffman
preferredUsername: reidhoffman
followerCount: 2783365
```

--------------------------------

### WebVTT Transcript Format Example

Source: https://docs.konbiniapi.com/reference/api/linkedin/get-post-video-transcript

Example of a WebVTT formatted transcript used for video content.

```text
WEBVTT


00:00.000 --> 00:03.000

Open the Gemini app and select "New notebook."


00:03.000 --> 00:06.500

Tell Gemini what you're studying for and upload your class
notes or readings.
```

--------------------------------

### Reddit Attachment and Tag Schema Examples

Source: https://docs.konbiniapi.com/reference/api/reddit/get-post

Examples of schema definitions for image, video, link attachments, and tags.

```yaml
type: string
          description: ActivityStreams object type
          example: Image
        url:
          type: string
          format: uri
          description: Image URL
          example: https://i.redd.it/post1.png
        width:
          type: integer
          description: Width in pixels
          example: 1200
        height:
          type: integer
          description: Height in pixels
          example: 675
```

```yaml
type: array
          items:
            type: string
            format: uri
          description: Media download URLs
          example:
            - https://v.redd.it/abc123/DASH_720.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
        duration:
          type: number
          description: Duration in seconds
          example: 15
```

```yaml
href:
          type: string
          format: uri
          description: Linked URL
          example: https://example.com/article
        name:
          type: string
          description: Link title
          example: External article
        summary:
          type: string
          description: Link preview summary
          example: A quick summary from the linked article.
```

```yaml
type:
          type: string
          description: ActivityStreams object type
          example: Tag
        name:
          type: string
          description: Tag name
          example: programming
        href:
          type: string
          format: uri
          description: Subreddit or flair URL
          example: https://www.reddit.com/r/programming/
```

--------------------------------

### Search subreddits tool request example

Source: https://docs.konbiniapi.com/reference/mcp/tools/reddit/search-subreddits

Example JSON payload for invoking the reddit_search_subreddits tool with specific projection presets and field selections.

```json
{
  "name": "reddit_search_subreddits",
  "arguments": {
    "q": "<q>",
    "count": 25,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "name",
      "published",
      "summary",
      "url"
    ]
  }
}
```

--------------------------------

### TikTok Get User Followers Tool Call

Source: https://docs.konbiniapi.com/reference/mcp/tools/tiktok/get-user-followers

Example of a tool invocation using specific projection presets and custom data fields.

```json
{
  "name": "tiktok_get_user_followers",
  "arguments": {
    "username": "khaby.lame",
    "count": 30,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "name",
      "preferredUsername",
      "published",
      "summary"
    ]
  }
}
```

--------------------------------

### Reddit Get User Tool Call

Source: https://docs.konbiniapi.com/reference/mcp/tools/reddit/get-user

Example of a tool call structure for retrieving a Reddit user profile with specific data fields.

```json
{
  "name": "reddit_get_user",
  "arguments": {
    "username": "khaby.lame",
    "projection_preset": "minimal",
    "data_fields": [
      "entityId",
      "name",
      "preferredUsername",
      "published"
    ]
  }
}
```

--------------------------------

### TikTok Get Video Transcript Tool Call

Source: https://docs.konbiniapi.com/reference/mcp/tools/tiktok/get-video-transcript

Example of a tool call structure for retrieving a transcript with specific projection presets and data fields.

```json
{
  "name": "tiktok_get_video_transcript",
  "arguments": {
    "videoId": "7526718640041882912",
    "language": "en-US",
    "projection_preset": "minimal",
    "data_fields": [
      "content",
      "url",
      "type",
      "id"
    ]
  }
}
```

--------------------------------

### Execute reddit_get_user_overview

Source: https://docs.konbiniapi.com/reference/mcp/tools/reddit/get-user-overview

Example JSON payload for invoking the reddit_get_user_overview tool with specific projection presets and field selections.

```json
{
  "name": "reddit_get_user_overview",
  "arguments": {
    "username": "khaby.lame",
    "count": 25,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "name",
      "published",
      "content",
      "url"
    ]
  }
}
```

--------------------------------

### TikTok Get Video Comments Tool Call

Source: https://docs.konbiniapi.com/reference/mcp/tools/tiktok/get-video-comments

Example of a tool call configuration for retrieving video comments with specific data and item fields.

```json
{
  "name": "tiktok_get_video_comments",
  "arguments": {
    "videoId": "7526718640041882912",
    "count": 20,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "published",
      "content",
      "url",
      "likeCount"
    ]
  }
}
```

--------------------------------

### Reddit Get User Posts Tool Call

Source: https://docs.konbiniapi.com/reference/mcp/tools/reddit/get-user-posts

Example of a tool call to retrieve posts for a specific Reddit user with custom field projections.

```json
{
  "name": "reddit_get_user_posts",
  "arguments": {
    "username": "khaby.lame",
    "count": 25,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "name",
      "published",
      "content",
      "url"
    ]
  }
}
```

--------------------------------

### Call x_get_user_highlights tool

Source: https://docs.konbiniapi.com/reference/mcp/tools/x/get-user-highlights

Example JSON payload for invoking the x_get_user_highlights tool with specific projection presets and requested data fields.

```json
{
  "name": "x_get_user_highlights",
  "arguments": {
    "username": "khaby.lame",
    "count": 40,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "published",
      "content",
      "url",
      "viewCount"
    ]
  }
}
```

--------------------------------

### Instagram Get Post Tool Call

Source: https://docs.konbiniapi.com/reference/mcp/tools/instagram/get-post

Example of a tool call structure for retrieving post details with a specified projection preset and additional data fields.

```json
{
  "name": "instagram_get_post",
  "arguments": {
    "postId": "DM8Q1ABC123",
    "projection_preset": "minimal",
    "data_fields": [
      "totalItems",
      "entityId",
      "name",
      "published"
    ]
  }
}
```

--------------------------------

### Example usage of tiktok_get_video_download_url

Source: https://docs.konbiniapi.com/reference/mcp/tools/tiktok/get-video-download-url

Demonstrates the JSON structure for invoking the tool with a specific video ID and optional projection settings.

```json
{
  "name": "tiktok_get_video_download_url",
  "arguments": {
    "videoId": "7526718640041882912",
    "projection_preset": "minimal",
    "data_fields": [
      "url",
      "type",
      "mediaType"
    ]
  }
}
```

--------------------------------

### Instagram Get Post Comments Tool Call

Source: https://docs.konbiniapi.com/reference/mcp/tools/instagram/get-post-comments

Example of a tool call structure for retrieving comments from an Instagram post with specific data and item fields.

```json
{
  "name": "instagram_get_post_comments",
  "arguments": {
    "postId": "DM8Q1ABC123",
    "count": 15,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "published",
      "content",
      "likeCount",
      "id"
    ]
  }
}
```

--------------------------------

### Configure KonbiniAPI Connector Details

Source: https://docs.konbiniapi.com/reference/mcp/setup/claude

Use these values when prompted during the custom connector setup process in Claude.

```text
KonbiniAPI
```

```text
https://mcp.konbiniapi.com
```

--------------------------------

### Validation Error Example

Source: https://docs.konbiniapi.com/reference/api/instagram/get-user-posts

Example of a human-readable validation error message.

```text
Validation error
```

--------------------------------

### Call x_get_user tool

Source: https://docs.konbiniapi.com/reference/mcp/tools/x/get-user

Example request payload for retrieving a user profile with a minimal projection preset and additional data fields.

```json
{
  "name": "x_get_user",
  "arguments": {
    "username": "khaby.lame",
    "projection_preset": "minimal",
    "data_fields": [
      "entityId",
      "name",
      "preferredUsername",
      "published"
    ]
  }
}
```

--------------------------------

### XArticleAttachment Schema Example

Source: https://docs.konbiniapi.com/reference/api/x/get-post

Example values for the XArticleAttachment object representing an article attachment.

```yaml
type: Article
entityId: '1971521477247789275'
url: https://www.formulae.com/en/latest/article/nissan-and-khaby-lame-share-the-track-in-jeddah.3xexample
name: Nissan and Khaby Lame share the track in Jeddah
```

--------------------------------

### Launch MCP Inspector

Source: https://docs.konbiniapi.com/reference/mcp/setup/custom-agents

Command to start the MCP Inspector for testing and debugging the server.

```bash
npx @modelcontextprotocol/inspector
```

--------------------------------

### Example tiktok_search_videos tool call

Source: https://docs.konbiniapi.com/reference/mcp/tools/tiktok/search-videos

A JSON object demonstrating how to invoke the tiktok_search_videos tool with specific query parameters and field projections.

```json
{
  "name": "tiktok_search_videos",
  "arguments": {
    "query": "cooking",
    "count": 50,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "published",
      "content",
      "url",
      "viewCount"
    ]
  }
}
```

--------------------------------

### Call tiktok_get_audio_videos tool

Source: https://docs.konbiniapi.com/reference/mcp/tools/tiktok/get-audio-videos

Example JSON payload for invoking the tiktok_get_audio_videos tool with specific projection presets and data fields.

```json
{
  "name": "tiktok_get_audio_videos",
  "arguments": {
    "audioId": "7517710000000000000",
    "count": 30,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "published",
      "content",
      "url",
      "viewCount"
    ]
  }
}
```

--------------------------------

### Call x_get_community_posts tool

Source: https://docs.konbiniapi.com/reference/mcp/tools/x/get-community-posts

Example JSON payload for invoking the x_get_community_posts tool with specific data and item field projections.

```json
{
  "name": "x_get_community_posts",
  "arguments": {
    "communityId": "<communityId>",
    "count": 40,
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "nextCursor",
      "cursor",
      "itemCount"
    ],
    "item_fields": [
      "entityId",
      "published",
      "content",
      "url",
      "viewCount"
    ]
  }
}
```

--------------------------------

### Payment Required Error Example

Source: https://docs.konbiniapi.com/reference/api/instagram/get-user-posts

Example of a human-readable error message when credits are exhausted.

```text
Credits exhausted. Upgrade your plan at
konbiniapi.com
```

--------------------------------

### Example Request for reddit_get_subreddit_sticky

Source: https://docs.konbiniapi.com/reference/mcp/tools/reddit/get-subreddit-sticky

A JSON payload demonstrating how to call the reddit_get_subreddit_sticky tool with specific projection presets and field selections.

```json
{
  "name": "reddit_get_subreddit_sticky",
  "arguments": {
    "subreddit": "programming",
    "projection_preset": "minimal",
    "data_fields": [
      "orderedItems",
      "totalItems",
      "url",
      "type"
    ],
    "item_fields": [
      "entityId",
      "name",
      "published",
      "content",
      "url"
    ]
  }
}
```

--------------------------------

### Unauthorized Error Example

Source: https://docs.konbiniapi.com/reference/api/instagram/get-user-posts

Example of a human-readable error message for invalid API keys.

```text
Invalid API key
```

--------------------------------

### Configure KonbiniAPI MCP server

Source: https://docs.konbiniapi.com/reference/mcp/setup/antigravity

Add the KonbiniAPI server URL to the mcpServers object in the Antigravity configuration file.

```json
{
  "mcpServers": {
    "konbiniapi": {
      "serverUrl": "https://mcp.konbiniapi.com"
    }
  }
}
```

--------------------------------

### SubRip (SRT) Transcript Format Example

Source: https://docs.konbiniapi.com/reference/api/linkedin/get-post-video-transcript

Example of a SubRip formatted transcript used for video content.

```text
1
00:00:00,060 --> 00:00:02,571
But now, because anybody can code, what happens is the

2
00:00:02,571 --> 00:00:05,173
software people play the role of the architect
```

--------------------------------

### POST /

Source: https://docs.konbiniapi.com/reference/mcp/setup/custom-agents

Sends an MCP JSON-RPC request to the KonbiniAPI server to invoke tools.

```APIDOC
## POST /

### Description
Sends an MCP JSON-RPC request to the KonbiniAPI server to execute specific tools.

### Method
POST

### Endpoint
https://mcp.konbiniapi.com

### Request Body
- **jsonrpc** (string) - Required - Must be "2.0"
- **method** (string) - Required - The MCP method to call (e.g., "tools/call")
- **params** (object) - Required - Parameters for the method, including tool name and arguments
- **id** (integer) - Required - Request identifier

### Request Example
{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "name": "tiktok_get_user",
    "arguments": {
      "username": "khaby.lame",
      "projection_preset": "minimal"
    }
  },
  "id": 1
}
```

--------------------------------

### Configure KonbiniAPI in Zed settings

Source: https://docs.konbiniapi.com/reference/mcp/setup/zed

Add the KonbiniAPI remote server URL to the context_servers object in your Zed settings file.

```json
{
  "context_servers": {
    "konbiniapi": {
      "url": "https://mcp.konbiniapi.com"
    }
  }
}
```
Tokens:
Raw