検索は使用時のみ読み込みます。以下ですべてのカテゴリを閲覧できます。
SosoAPI · 開発者ドキュメント
APIリファレンス
アプリから呼べる107操作と、エージェントログイン用4エンドポイントを掲載。各操作でリクエスト、レスポンス、権限、呼び出し例を確認できます。
アカウントとワークスペース
- 組織のコンテキストを取得
POST /identity-api/agent/organization-context組織、ワークスペース、チャンネルの現在の権限情報を取得します。 - APIキーを作成
POST /identity-api/api-keys/create選択した機能権限と任意のワークスペース制限でAPIキーを作成します。シークレットは一度だけ返されます。エージェントは自身の認可に含まれる権限のみを最大30日間付与でき、一つの認可で有効にできるキーは最大25個です（API_KEY_GRANT_KEY_LIMIT）。 - APIキーの有効期限を延長
POST /identity-api/api-keys/extendAPIキーの有効期限を現在から最大365日（エージェント作成キーは30日）まで延長します。それを超える日時はAPI_KEY_LIFETIME_EXCEEDS_CAPで拒否されます。レスポンスには適用された有効期限が含まれます。 - APIキーの一覧を取得
POST /identity-api/api-keys/listシークレットなしでAPIキーメタデータを取得。権限とワークスペース制限はinclude_authorityを指定します。 - 後継のAPIキーを作成
POST /identity-api/api-keys/renew同じ機能権限とワークスペース制限を持つ後継APIキーを、既存キーを失効させずに作成します。 - APIキーを失効
POST /identity-api/api-keys/revokeAPIキーを失効させます。エージェントが失効できるのは、自身が作成したキーのみです。 - 請求状況を取得
POST /identity-api/billing/status請求プラン、権利、利用枠の情報を取得します。 - 商用アクセス情報を取得
POST /identity-api/commercial-access/statusワークスペースの商用アクセス情報を取得します。 - フィードバックを送信
POST /identity-api/feedback/submit送信元情報付きで製品へのフィードバックを送信します。 - ワークスペースメンバーの一覧を取得
POST /identity-api/member/listメンバーと保留中の招待を取得します。 - 組織のチャンネル一覧を取得
POST /identity-api/organization/channels/listチャンネルとワークスペースへの接続状態の一覧を取得します。 - チャンネル移動をプレビュー
POST /identity-api/organization/channels/move/previewチャンネルの移動前に、移動を妨げる条件を確認します。 - 組織の接続一覧を取得
POST /identity-api/organization/connections/list組織のプロバイダー接続を取得します。 - 組織の接続をレビュー
POST /identity-api/organization/connections/reviewレビュー用に検出された、正確なプロバイダーリソースを取得します。 - 組織の一覧を取得
POST /identity-api/organization/list認証済みユーザーが閲覧できる組織の一覧を取得します。 - 受信トレイの通知一覧を取得
POST /identity-api/user/inbox/list認証済みユーザーの受信トレイを取得します。 - 通知設定を取得
POST /identity-api/user/notifications/get通知の配信設定を取得します。 - 通知設定を更新
POST /identity-api/user/notifications/update通知の配信設定を更新します。 - ユーザープロフィールを取得
POST /identity-api/user/profile/get認証済みユーザーのプロフィールを取得します。 - アバターのアップロードURLを署名
POST /identity-api/user/profile/sign-avatar-url署名付きアバターアップロードURLを取得します。 - ユーザープロフィールを更新
POST /identity-api/user/profile/update認証済みユーザーのプロフィールを更新します。 - ソーシャルアカウントのブロックを解除
POST /identity-api/user/social-accounts/clear-block投稿を再試行せずにアカウントのクールダウンを解除します。クールダウン中、またはアカウントのクールダウンが三回目に達した場合、エージェント認証情報による操作は拒否されます。どの呼び出し元も、解除は一アカウントにつき10分に一回までです。 - ソーシャルアカウントの接続を解除
POST /identity-api/user/social-accounts/disconnectワークスペースのソーシャルアカウントの接続を解除します。 - 接続済みアカウントの一覧を取得
POST /identity-api/user/social-accounts/listワークスペースに接続されたソーシャルアカウントの一覧を取得します。 - ソーシャルアカウントの自動同期を設定
POST /identity-api/user/social-accounts/set-auto-syncアカウントの自動同期を有効または無効にします。 - ワークスペースを作成
POST /identity-api/workspace/create自身が所有または管理する組織内にワークスペースを作成します。複数組織に所属する場合はorganization_idを指定してください。 - ワークスペースのコンテキストを取得
POST /identity-api/workspace/listワークスペース一覧とアクティブなものを取得します。 - ワークスペースを更新
POST /identity-api/workspace/updateワークスペースの名前またはスラッグを更新します。
メディアとアセット
- アセットを作成
POST /assets-api/createアセットのメタデータを登録します。 - アセットを削除
POST /assets-api/deleteアセットを一件削除します。 - アセットのエクスポートを作成
POST /assets-api/exports/createアセットのエクスポート証跡ジョブを作成します。 - アセットのエクスポート状況を取得
POST /assets-api/exports/status永続的に記録されたアセットのエクスポート状況を取得します。 - アセットのエクスポートを検証
POST /assets-api/exports/verify完全削除の前にアセットのエクスポートを検証します。 - アセットを取得
POST /assets-api/getIDを指定して一つのアセットを取得します。 - アセットのインポート状況を取得
POST /assets-api/imports/status永続的に記録されたメディアのインポート状況を取得します。 - URLからアセットをインポート
POST /assets-api/imports/url明示的に指定された外部メディアの取り込みをキューに登録します。 - アセットを検索
POST /assets-api/list従来と互換性のあるフィルターでアセットを検索します。 - アセットの一覧を取得
POST /assets-api/list-workspaceワークスペースのアセットの一覧を取得します。 - 未登録アセットを削除
POST /assets-api/orphans/delete選択した未登録R2オブジェクトを削除します。 - 未登録アセットの一覧を取得
POST /assets-api/orphans/list未登録のR2オブジェクトの一覧を取得します。 - アセットの完全削除を申請
POST /assets-api/purges/requestオーナー権限とフェンスで保護されたアセットの完全削除を申請します。 - アセットの完全削除を再試行
POST /assets-api/purges/retryフェンスで保護された、再試行可能な完全削除を再試行します。 - アセットストレージの一覧を取得
POST /assets-api/storage/inventory件数を制限した登録済みアセット／保存オブジェクトの一覧を取得します。 - アセットを更新
POST /assets-api/updateアセットのメタデータを更新します。 - アセットのアップロードを完了
POST /assets-api/upload/complete署名済みオブジェクト識別情報と冪等性キーを使用して、アップロード済みワークスペースメディアの登録を完了します。 - アセットのアップロードURLを署名
POST /assets-api/upload/sign対象ワークスペースのメディアオブジェクト用に署名付きアップロードURLを要求します。登録を完了する前にデータをアップロードしてください。
プロジェクトとコンテンツ
- プロジェクトの既定アカウントを取得
POST /studio-api/projects/account-defaults/getプロジェクトの既定アカウントを取得します。 - プロジェクトの既定アカウントを置換
POST /studio-api/projects/account-defaults/replaceプロジェクトの既定アカウントを置換します。 - アカウントをプロジェクトに関連付け
POST /studio-api/projects/accounts/linkソーシャルアカウントをプロジェクトに関連付けます。 - プロジェクトのアカウント一覧を取得
POST /studio-api/projects/accounts/listプロジェクトに関連付けられたアカウントの一覧を取得します。 - プロジェクトとアカウントの関連付けを解除
POST /studio-api/projects/accounts/unlinkソーシャルアカウントとプロジェクトの関連付けを解除します。 - プロジェクトをアーカイブ
POST /studio-api/projects/archiveScheduled Postsを変更せず、プロジェクトをアーカイブします。投稿を停止するには、該当するScheduled Postを別途キャンセルしてください。ワークスペースのオーナーのみ実行できます。expected_lifecycle_versionとidempotency_keyを指定してください。 - アセットをプロジェクトに関連付け
POST /studio-api/projects/assets/linkアセットをプロジェクトに関連付けます。 - プロジェクトのアセット一覧を取得
POST /studio-api/projects/assets/listプロジェクトに関連付けられたアセットの一覧を取得します。 - プロジェクトとアセットの関連付けを解除
POST /studio-api/projects/assets/unlinkアセットとプロジェクトの関連付けを解除します。 - プロジェクトを作成
POST /studio-api/projects/createプロジェクトを作成します。 - プロジェクトのエクスポートを作成
POST /studio-api/projects/export/createプロジェクトのエクスポートを作成します。 - プロジェクトのエクスポート状況を取得
POST /studio-api/projects/export/statusプロジェクトのエクスポート状況を取得します。 - プロジェクトを取得
POST /studio-api/projects/getプロジェクトを取得します。 - プロジェクトのライフサイクル履歴を取得
POST /studio-api/projects/lifecycle/historyプロジェクトのライフサイクル履歴を取得します。 - プロジェクトの一覧を取得
POST /studio-api/projects/listワークスペースのプロジェクト一覧を取得します。 - プロジェクトのプロフィールを取得
POST /studio-api/projects/profile/getプロジェクトのプロフィールを取得します。 - プロジェクトのプロフィールを更新
POST /studio-api/projects/profile/updateプロジェクトのプロフィールを更新します。 - アクティブなプロジェクトを設定
POST /studio-api/projects/set-activeアクティブなプロジェクトを設定します。 - プロジェクトのアーカイブを解除
POST /studio-api/projects/unarchiveアーカイブ済みプロジェクトを再有効化します。投稿の再開や再予約は行いません。投稿はScheduled Postsで管理してください。ワークスペースのオーナーのみ実行できます。expected_lifecycle_versionとidempotency_keyを指定してください。 - プロジェクトを更新
POST /studio-api/projects/updateプロジェクトを更新します。 - 対応が必要な公開結果の一覧を取得
POST /studio-api/publication-attentions/list対応が必要な公開結果を取得します。
予約と公開
- 予約投稿を一括作成
POST /studio-api/scheduled-posts/bulk-create複数の投稿先に予約投稿を作成します。 - 予約投稿をキャンセル
POST /studio-api/scheduled-posts/cancel予約投稿をキャンセルします。 - 予約投稿を作成
POST /studio-api/scheduled-posts/create予約投稿を作成し、最終的な公開結果を確認します。 - 完全な画像投稿を送信
POST /studio-api/scheduled-posts/create-image-url完全な画像URL投稿を一件、永続的に受け付け、最終結果が得られた場合はそれを返します。 - 予約投稿を削除
POST /studio-api/scheduled-posts/delete予約投稿を削除します。 - 予約投稿の適格性を取得
POST /studio-api/scheduled-posts/eligibility予約前に投稿先の適格性を取得します。 - 予約投稿を取得
POST /studio-api/scheduled-posts/get予約投稿を一件取得します。 - 予約投稿の一覧を取得
POST /studio-api/scheduled-posts/list予約投稿の一覧を取得します。 - 予約投稿を今すぐ公開
POST /studio-api/scheduled-posts/publish-now即時公開をリクエストします。 - 予約投稿を再試行
POST /studio-api/scheduled-posts/retry失敗した予約投稿を再試行します。 - 予約投稿を更新
POST /studio-api/scheduled-posts/update予約投稿を更新します。 - 削除申請を撤回
POST /studio-api/scheduled-posts/withdraw-delete停止したInstagram Login削除申請を撤回し、公開済み投稿を保持します。 - Xの投稿クレジットを取得
POST /studio-api/x/usage組織で共有するXクレジットと、任意で指定する最終投稿テキストの消費クレジットを取得します。
分析とインサイト
- ダッシュボードの集計値を取得
POST /analytics-api/dashboard/ops-countsダッシュボードの運用集計値を取得します。 - プロバイダーインサイトをリクエスト
POST /analytics-api/provider-insights/requestプロバイダーを正式な情報源とするインサイトをリクエストします。 - プロバイダーインサイトの状況を取得
POST /analytics-api/provider-insights/statusプロバイダーインサイトリクエストの状況を取得します。 - 投稿コメントの一覧を取得
POST /analytics-api/social/comments/query検出済みのソーシャルコメントを取得します。 - 監視対象投稿の一覧を取得
POST /analytics-api/social/posts/query検出済みソーシャル投稿を取得します。
ソーシャル接続
- Instagram OAuthを開始
POST /oauth-api/instagram/initプロバイダーの同意手続きを開始し、その認可URLを返します。 - Instagram OAuthを更新
POST /oauth-api/instagram/refreshInstagramの接続を更新します。 - Meta OAuthを開始
POST /oauth-api/meta/initプロバイダーの同意手続きを開始し、その認可URLを返します。 - Meta OAuthを更新
POST /oauth-api/meta/refreshMetaの接続を更新します。 - Threads OAuthを確認
POST /oauth-api/threads/checkThreads接続の診断情報を取得します。 - Threads OAuthを開始
POST /oauth-api/threads/initプロバイダーの同意手続きを開始し、その認可URLを返します。 - Threads OAuthを更新
POST /oauth-api/threads/refreshThreadsの接続を更新します。 - YouTube OAuthを開始
POST /oauth-api/youtube/initプロバイダーの同意手続きを開始し、その認可URLを返します。 - YouTube OAuthを更新
POST /oauth-api/youtube/refreshYouTubeの接続を更新します。
バックグラウンド操作
コメントとコミュニティ
- コミュニティアクションを適用
POST /community-engagement-api/actions/apply準備済みアクションを適用します。最終結果はアクションのステータスで確認してください。 - コミュニティアクションを準備
POST /community-engagement-api/actions/prepare最終的に実行するコミュニティアクションを準備します。 - コミュニティアクションの状況を取得
POST /community-engagement-api/actions/statusアクションの最終記録を取得します。キュー登録は成功ではありません。 - コミュニティ機能の対応状況を取得
POST /community-engagement-api/capabilitiesCommunity Engagementの機能対応情報を取得します。 - コミュニティコメントを作成
POST /community-engagement-api/comments/create正規の投稿またはコメントを対象に、指定どおりのコメントを一件キューに登録します。ステータスはプロバイダー側の成功を意味しません。 - コメント送信結果を取得
POST /community-engagement-api/comments/outcome確認済みの送信、復旧の継承関係、検証待ち、未解決の対応事項を取得します。 - コメント送信結果を照合
POST /community-engagement-api/comments/reconcile再送せずにFacebookの不確かな送信結果を検証するか、確認済みの完全一致する代替を一件関連付けます。最終的な証拠は結果で確認してください。 - コミュニティコメントの状況を取得
POST /community-engagement-api/comments/status直接コメント操作の、機密情報を除去した最終結果記録を取得します。 - コミュニティの概要を取得
POST /community-engagement-api/operations/summaryCommunity Engagementの運用概要を取得します。 - コミュニティのレビュー待ち一覧を検索
POST /community-engagement-api/review-queue/queryレビュー可能なコメントを取得します。空のページは成功ではありません。 - コミュニティレビューを送信
POST /community-engagement-api/reviews/submit変更不可の新しいレビューバージョンを送信します。
認証の初期設定
- エージェント認証：config
POST /identity-api/agent-auth/configエージェント認証のconfigプロトコルです。対応するブラウザーログイン手順を使い、認証情報を表示しないでください。 - エージェント認証：request
POST /identity-api/agent-auth/requestエージェント認証のrequestプロトコルです。対応するブラウザーログイン手順を使い、認証情報を表示しないでください。 - エージェント認証：revoke-current
POST /identity-api/agent-auth/revoke-currentエージェント認証のrevoke-currentプロトコルです。対応するブラウザーログイン手順を使用し、認証情報を表示しないでください。 - エージェント認証：session
POST /identity-api/agent-auth/sessionエージェント認証のsessionプロトコルです。対応するブラウザーログイン手順を使用し、認証情報を表示しないでください。