Search loads only when you use it. Browse all categories below.
SosoAPI · Developer docs
API reference
107 operations you can call from your application, plus 4 endpoints for agent sign-in. Open an operation to see its request fields, response, permissions and example calls.
Accounts and workspaces
- Get Organization context
POST /identity-api/agent/organization-contextRead live Organization, Workspace, and Channel authority. - Create API key
POST /identity-api/api-keys/createCreate an API key with chosen capabilities and optional Workspace limits; the secret is returned once. An agent can grant only what its own authorization holds, for at most 30 days, and one authorization can hold at most 25 active keys (API_KEY_GRANT_KEY_LIMIT). - Extend API key
POST /identity-api/api-keys/extendExtend an API key expiry to at most 365 days from now (30 for a key an agent created); a later time is refused with API_KEY_LIFETIME_EXCEEDS_CAP. The response carries the expiry applied. - List API keys
POST /identity-api/api-keys/listList API-key metadata without secrets; set include_authority for capabilities and Workspace limits. - Renew API key
POST /identity-api/api-keys/renewCreate a non-destructive successor API key with the same capabilities and Workspace limits. - Revoke API key
POST /identity-api/api-keys/revokeRevoke an API key. An agent can revoke only keys it created. - Get billing status
POST /identity-api/billing/statusRead billing plan, entitlement, and quota facts. - Get commercial access
POST /identity-api/commercial-access/statusRead Workspace commercial access facts. - Submit feedback
POST /identity-api/feedback/submitSubmit product feedback with attribution. - List Workspace members
POST /identity-api/member/listRead members and pending invites. - List organization channels
POST /identity-api/organization/channels/listList channels and Workspace attachment state. - Preview channel move
POST /identity-api/organization/channels/move/previewPreview blockers before moving a channel. - List organization connections
POST /identity-api/organization/connections/listRead organization provider connections. - Review organization connection
POST /identity-api/organization/connections/reviewRead the exact provider resources discovered for review. - List organizations
POST /identity-api/organization/listList organizations visible to the authenticated user. - List inbox notifications
POST /identity-api/user/inbox/listRead the authenticated user inbox. - Get notification preferences
POST /identity-api/user/notifications/getRead notification delivery preferences. - Update notification preferences
POST /identity-api/user/notifications/updateUpdate notification delivery preferences. - Get user profile
POST /identity-api/user/profile/getRead the authenticated user profile. - Sign avatar upload
POST /identity-api/user/profile/sign-avatar-urlGet a signed avatar upload URL. - Update user profile
POST /identity-api/user/profile/updateUpdate the authenticated user profile. - Clear social account block
POST /identity-api/user/social-accounts/clear-blockClear an account cooldown without retrying a post. An agent credential is refused while the cooldown is still active or once the account reached its third cooldown; any caller can clear an account at most once every 10 minutes. - Disconnect social account
POST /identity-api/user/social-accounts/disconnectDisconnect a Workspace social account. - List connected accounts
POST /identity-api/user/social-accounts/listList connected social accounts in a Workspace. - Set social account auto-sync
POST /identity-api/user/social-accounts/set-auto-syncEnable or disable account auto-sync. - Create Workspace
POST /identity-api/workspace/createCreate a Workspace in an Organization you own or administer. Pass organization_id when you belong to multiple Organizations. - Get Workspace context
POST /identity-api/workspace/listList Workspaces and the active Workspace. - Update Workspace
POST /identity-api/workspace/updateUpdate Workspace name or slug.
Media and assets
- Create asset
POST /assets-api/createRegister asset metadata. - Delete asset
POST /assets-api/deleteDelete one asset. - Create asset export
POST /assets-api/exports/createCreate an asset export evidence job. - Get asset export status
POST /assets-api/exports/statusRead durable asset export status. - Verify asset export
POST /assets-api/exports/verifyVerify an asset export before any purge. - Get asset
POST /assets-api/getRead one asset by ID. - Get asset import status
POST /assets-api/imports/statusRead durable media import status. - Import asset URL
POST /assets-api/imports/urlQueue explicit external media intake. - Query assets
POST /assets-api/listQuery assets with legacy-compatible filters. - List assets
POST /assets-api/list-workspaceList Workspace assets. - Delete orphan assets
POST /assets-api/orphans/deleteDelete selected unregistered R2 objects. - List orphan assets
POST /assets-api/orphans/listList unregistered R2 objects. - Request asset purge
POST /assets-api/purges/requestRequest owner-fenced asset purge. - Retry asset purge
POST /assets-api/purges/retryRetry an eligible fenced purge. - Get asset storage inventory
POST /assets-api/storage/inventoryRead bounded registered/object storage inventory. - Update asset
POST /assets-api/updateUpdate asset metadata. - Complete an asset upload
POST /assets-api/upload/completeComplete registration of the uploaded Workspace media object using its signed object identity and idempotency key. - Sign an asset upload
POST /assets-api/upload/signRequest a signed upload URL for the intended Workspace media object. Upload the bytes before completing registration.
Projects and content
- Get project account defaults
POST /studio-api/projects/account-defaults/getRead project account defaults. - Replace project account defaults
POST /studio-api/projects/account-defaults/replaceReplace project account defaults. - Link project account
POST /studio-api/projects/accounts/linkLink a social account to a project. - List project accounts
POST /studio-api/projects/accounts/listList accounts linked to a project. - Unlink project account
POST /studio-api/projects/accounts/unlinkUnlink a social account from a project. - Archive project
POST /studio-api/projects/archiveArchive a project without changing its Scheduled Posts. To stop a post, cancel that Scheduled Post separately. Workspace owner only; pass expected_lifecycle_version and an idempotency_key. - Link project asset
POST /studio-api/projects/assets/linkLink an asset to a project. - List project assets
POST /studio-api/projects/assets/listList assets linked to a project. - Unlink project asset
POST /studio-api/projects/assets/unlinkUnlink an asset from a project. - Create project
POST /studio-api/projects/createCreate a project. - Create project export
POST /studio-api/projects/export/createCreate a project export. - Get project export status
POST /studio-api/projects/export/statusRead project export status. - Get project
POST /studio-api/projects/getRead a project. - Get project lifecycle history
POST /studio-api/projects/lifecycle/historyRead project lifecycle history. - List projects
POST /studio-api/projects/listList Workspace projects. - Get project profile
POST /studio-api/projects/profile/getRead a project profile. - Update project profile
POST /studio-api/projects/profile/updateUpdate a project profile. - Set active project
POST /studio-api/projects/set-activeSet the active project. - Unarchive project
POST /studio-api/projects/unarchiveReactivate an archived project. This does not resume or reschedule posts; manage those through Scheduled Posts. Workspace owner only; pass expected_lifecycle_version and an idempotency_key. - Update project
POST /studio-api/projects/updateUpdate a project. - List publication attentions
POST /studio-api/publication-attentions/listRead publication outcomes requiring attention.
Scheduling and publishing
- Bulk create scheduled posts
POST /studio-api/scheduled-posts/bulk-createCreate scheduled posts for multiple destinations. - Cancel scheduled post
POST /studio-api/scheduled-posts/cancelCancel a scheduled post. - Create scheduled post
POST /studio-api/scheduled-posts/createCreate a scheduled post and inspect terminal publication outcome. - Submit a complete image post
POST /studio-api/scheduled-posts/create-image-urlAccept one complete image URL post durably and return its terminal result when available. - Delete scheduled post
POST /studio-api/scheduled-posts/deleteDelete a scheduled post. - Get scheduled post eligibility
POST /studio-api/scheduled-posts/eligibilityRead destination eligibility before scheduling. - Get scheduled post
POST /studio-api/scheduled-posts/getRead one scheduled post. - List scheduled posts
POST /studio-api/scheduled-posts/listList scheduled posts. - Publish scheduled post now
POST /studio-api/scheduled-posts/publish-nowRequest immediate publication. - Retry scheduled post
POST /studio-api/scheduled-posts/retryRetry a failed scheduled post. - Update scheduled post
POST /studio-api/scheduled-posts/updateUpdate a scheduled post. - Withdraw deletion request
POST /studio-api/scheduled-posts/withdraw-deleteWithdraw a stopped Instagram Login deletion request and retain the published post. - Get X publishing credits
POST /studio-api/x/usageRead shared Organization X credits and the credit cost of optional final Post text.
Analytics and insights
- Get dashboard counts
POST /analytics-api/dashboard/ops-countsRead dashboard operational counts. - Request provider insights
POST /analytics-api/provider-insights/requestRequest provider-authoritative insights. - Get provider insight status
POST /analytics-api/provider-insights/statusRead provider insight request status. - List post comments
POST /analytics-api/social/comments/queryRead discovered social comments. - List monitored posts
POST /analytics-api/social/posts/queryRead discovered social posts.
Social connections
- Start Instagram OAuth
POST /oauth-api/instagram/initStart provider consent and return the native authorization URL. - Refresh Instagram OAuth
POST /oauth-api/instagram/refreshRefresh an Instagram connection. - Start Meta OAuth
POST /oauth-api/meta/initStart provider consent and return the native authorization URL. - Refresh Meta OAuth
POST /oauth-api/meta/refreshRefresh a Meta connection. - Check Threads OAuth
POST /oauth-api/threads/checkRead Threads connection diagnostics. - Start Threads OAuth
POST /oauth-api/threads/initStart provider consent and return the native authorization URL. - Refresh Threads OAuth
POST /oauth-api/threads/refreshRefresh a Threads connection. - Start YouTube OAuth
POST /oauth-api/youtube/initStart provider consent and return the native authorization URL. - Refresh YouTube OAuth
POST /oauth-api/youtube/refreshRefresh a YouTube connection.
Background operations
Comments and community
- Apply community action
POST /community-engagement-api/actions/applyApply a prepared action; inspect action status for terminal truth. - Prepare community action
POST /community-engagement-api/actions/preparePrepare a terminal community action. - Get community action status
POST /community-engagement-api/actions/statusRead terminal action receipt; enqueue is not success. - Get community capabilities
POST /community-engagement-api/capabilitiesRead Community Engagement capability facts. - Create community comment
POST /community-engagement-api/comments/createQueue one exact comment against a canonical post or comment target; status is not provider success. - Get comment delivery outcome
POST /community-engagement-api/comments/outcomeRead confirmed delivery, recovery lineage, pending verification and unresolved follow-up. - Reconcile comment delivery outcome
POST /community-engagement-api/comments/reconcileVerify an ambiguous Facebook delivery without resending, or link one confirmed exact replacement. Inspect outcome for terminal proof. - Get community comment status
POST /community-engagement-api/comments/statusRead the sanitized terminal receipt for a direct comment action. - Get community summary
POST /community-engagement-api/operations/summaryRead Community Engagement operational summary. - Query community review queue
POST /community-engagement-api/review-queue/queryRead reviewable comments; an empty page is not success. - Submit community review
POST /community-engagement-api/reviews/submitSubmit a new immutable review version.
Authentication bootstrap
- Agent authentication: config
POST /identity-api/agent-auth/configAgent authentication config protocol. Use the supported browser sign-in flow; never display credentials. - Agent authentication: request
POST /identity-api/agent-auth/requestAgent authentication request protocol. Use the supported browser sign-in flow; never display credentials. - Agent authentication: revoke-current
POST /identity-api/agent-auth/revoke-currentAgent authentication revoke-current protocol. Use the supported browser sign-in flow; never display credentials. - Agent authentication: session
POST /identity-api/agent-auth/sessionAgent authentication session protocol. Use the supported browser sign-in flow; never display credentials.