Unif API Docs

コアコンセプト

Skills、MCP 操作、公開データ API、スキーマ、ページネーション全体で使われる用語。

UnifAPI ではいくつかの言葉があらゆる場所に登場します。一度学べば、残りのドキュメントが速く読めるようになります。

Skill

エージェントが UnifAPI MCP で実行できるタスク固有のワークフロー。Skill は、KOL 価格算定ブリーフやクリエイターのショートリストなど、望む出力から出発し、証拠が必要なときにエージェントが公開データ操作を発見して呼び出せるようにします。

Skills は、エージェントユーザーにとって推奨される出発点です。API リファレンスは、その背後にあるデータレイヤーです。

Provider(プロバイダー)

API がデータを公開する元の公開プラットフォーム — 例えば TikTok、Twitter/X、LinkedIn、YouTube、Reddit、Instagram など。すべてのプロバイダーには最上位のパスプレフィックスがあります。

https://api.unifapi.com/tiktok/...

Operation(操作)

プロバイダー内の単一の呼び出し可能な公開データエンドポイント — 例えば GET /tiktok/videos/{id}。すべての操作は API リファレンス に独自のページを持ち、MCP は list_operationsget_operation を通じて操作の発見を公開します。

正規化スキーマ

同じ種類のリソース(Video、User、Comment)を返すすべての操作は、同じ正規化スキーマを使用します。そのため、GET /tiktok/videos/{id}GET /tiktok/users/{id}/videos は、いずれも同一のフィールド名と型を持つ Video オブジェクトを返します。

正規化された形状は OpenAPI 仕様components.schemas に存在し、VideoAuthorMusicMusicDetailCommentUserHashtagLiveRoom が含まれます。

Identifiers(識別子)

ID は 不透明な文字列 です。長い数字のように見えますが、精度を保つために文字列として扱ってください(一部は > 2^53)。

  • TikTok のユーザー ID(sec_uid)は長い base64 トークンです。例:MS4wLjABAAAA...
  • TikTok の動画、音楽、ハッシュタグの ID は数字のように見える文字列です。TikTok のユーザーエンドポイントは、サポートされている箇所では公開ハンドル、数値ユーザー ID、または sec_uid を受け付けます。

/tiktok/users/resolve?username=jennmelon でユーザー名を安定したユーザー ID に解決します。/tiktok/videos/resolve?url=... で共有 URL を動画に解決します。

公開レスポンスエンベロープ

成功したレスポンスは、同じ最上位エンベロープを使用します:

{
  "request_id": "req_...",
  "data": {
    /* resource or list payload */
  },
  "pagination": {
    "cursor": "1711494099000",
    "has_more": true
  },
  "billing": {
    "credits_charged": 10,
    "records_charged": 10,
    "balance_remaining": 90,
    "truncated_due_to_balance": false
  }
}
  • request_id — サポートとトレースのための UnifAPI リクエスト ID。
  • data — ビジネスペイロード。
  • pagination — リスト操作が継続できる場合に存在します。
  • billing — その呼び出しで課金されたクレジットとレコード。

ページネーション

  • pagination.has_more — さらに 1 ページ以上存在する場合に true
  • pagination.cursor — 次のページのために ?cursor= として渡す 不透明な文字列has_morefalse のときは null

limit クエリパラメータは 50 で上限が設けられています。

カーソルは意図的に不透明です。一部のソースは整数オフセットを使用し、他はタイムスタンプを、また他はページトークンを使用します。UnifAPI はこの違いを隠します。pagination.cursor をパースしようとしないでください。

エラーエンベロープ

すべてのエラーは、単一のネストされたエンベロープを共有します:

{
  "error": {
    "type": "...",
    "message": "...",
    "request_id": "...",
    "issues": [
      /* validation only */
    ]
  }
}

error.type は閉じた語彙です(validation_errornot_foundunauthorized、...)。エラー を参照してください。

Workspace(ワークスペース)

課金とアクセスの境界。OAuth MCP セッション、API キー、利用状況、請求書はすべてワークスペースレベルに存在します。ダッシュボードからチームメンバーを招待してください — 彼らは同じキーと利用状況カウンターを共有します。

公開データの境界

UnifAPI は公開データを提供します。OAuth は UnifAPI MCP アクセスとワークスペースクレジットを認可するものであり、プライベートなソースアカウントを認可するものではありません。ワークフローがユーザーのプライベートな SaaS データを必要とする場合は、UnifAPI をその OAuth 統合レイヤーとして扱うのではなく、UnifAPI をコネクタプラットフォームと組み合わせてください。

このページの内容