Search capabilities (start here) | BeatAPI API Documentation

{
  "data": {
    "object": "capability.list",
    "data": [
      {
        "execution": "sync",
        "kind": "model",
        "platform": "string",
        "price": "string",
        "readiness": "ready",
        "reference": "string",
        "signature": "string",
        "summary": "string",
        "title": "string"
      }
    ],
    "next_cursor": "string",
    "total": 1,
    "understood": {
      "platforms": [
        "string"
      ],
      "terms": [
        "string"
      ],
      "ignored": [
        "string"
      ]
    },
    "recommended": {
      "reference": "string",
      "title": "string",
      "readiness": "ready",
      "why_match": {
        "platforms": [
          "string"
        ],
        "terms": [
          "string"
        ]
      },
      "missing_inputs": [
        "string"
      ],
      "price": "string"
    },
    "groups": [
      {
        "key": "string",
        "label": "string",
        "count": 1,
        "examples": [
          {
            "reference": "string",
            "summary": "string",
            "price": "string"
          }
        ],
        "search": {}
      }
    ],
    "hints": [
      "string"
    ],
    "next": {
      "action": "search",
      "call": "string",
      "note": "string"
    },
    "catalog_features": [
      "string"
    ]
  }
}

The entry point to every BeatAPI capability: social media data (小红书 Xiaohongshu, 抖音 Douyin, TikTok, B站 Bilibili, 微博 Weibo, X, Instagram, YouTube and more), text, image, video and decision (JEV) models, web search and media workflows. Free, needs no key and never executes anything.

Write query the way the user would say it, platform + action, in Chinese or English: 小红书搜索笔记, 抖音用户作品, tiktok user profile, video model. A whole sentence works; words that match nothing are ignored and listed in understood.ignored. A query that names only a platform (or group_by: function) returns an overview in groups; an empty query returns the catalogue map. Zero matches return hints on how to rephrase.

Results are compact cards by default (view: full returns complete contracts). Every reply carries next, the exact call to make next — usually Inspect on the best match. Copy references exactly; never build one.

Request

This endpoint expects an object.

querystringOptional

What the user wants, as platform + action in their own words, Chinese or English: 小红书搜索笔记, B站视频评论, image model. Only a platform name returns an overview; empty returns the catalogue map.

kindenumOptional

Optional filter. model: text, image, video and decision models. data: social media and web data. workflow: multi-step media jobs.

Allowed values:

platformstringOptional

Optional platform filter, slug or name: xiaohongshu or 小红书, douyin or 抖音, tiktok, bilibili, weibo, x, instagram, youtube.

limitintegerOptional1-50Defaults to 5

Results per page.

cursorstringOptional

next_cursor from the previous page.

viewenumOptionalDefaults to compact

compact: one card per result. full: complete contracts; usually Inspect one reference instead.

Allowed values:

group_byenumOptional

function: group matches by what they do (search, content, comments, users, trends, feeds, commerce, live).

Allowed values:

Response

Capability search page

dataobject

Errors

400

Bad Request Error

Headers

Request

Response

Errors