# API reference

- [API reference](https://sosoapi.ai/docs/api): Every public SosoAPI operation, with schemas, permissions and examples.
- [Get dashboard counts](https://sosoapi.ai/docs/api/analytics-api-dashboard-ops-counts): HTTP API: Get dashboard counts. Read dashboard operational counts.
- [Request provider insights](https://sosoapi.ai/docs/api/analytics-api-provider-insights-request): HTTP API: Request provider insights. Request provider-authoritative insights.
- [Get provider insight status](https://sosoapi.ai/docs/api/analytics-api-provider-insights-status): HTTP API: Get provider insight status. Read provider insight request status.
- [List post comments](https://sosoapi.ai/docs/api/analytics-api-social-comments-query): HTTP API: List post comments. Read discovered social comments.
- [List monitored posts](https://sosoapi.ai/docs/api/analytics-api-social-posts-query): HTTP API: List monitored posts. Read discovered social posts.
- [Create asset](https://sosoapi.ai/docs/api/assets-api-create): HTTP API: Create asset. Register asset metadata.
- [Delete asset](https://sosoapi.ai/docs/api/assets-api-delete): HTTP API: Delete asset. Delete one asset.
- [Create asset export](https://sosoapi.ai/docs/api/assets-api-exports-create): HTTP API: Create asset export. Create an asset export evidence job.
- [Get asset export status](https://sosoapi.ai/docs/api/assets-api-exports-status): HTTP API: Get asset export status. Read durable asset export status.
- [Verify asset export](https://sosoapi.ai/docs/api/assets-api-exports-verify): HTTP API: Verify asset export. Verify an asset export before any purge.
- [Get asset](https://sosoapi.ai/docs/api/assets-api-get): HTTP API: Get asset. Read one asset by ID.
- [Get asset import status](https://sosoapi.ai/docs/api/assets-api-imports-status): HTTP API: Get asset import status. Read durable media import status.
- [Import asset URL](https://sosoapi.ai/docs/api/assets-api-imports-url): HTTP API: Import asset URL. Queue explicit external media intake.
- [Query assets](https://sosoapi.ai/docs/api/assets-api-list): HTTP API: Query assets. Query assets with legacy-compatible filters.
- [List assets](https://sosoapi.ai/docs/api/assets-api-list-workspace): HTTP API: List assets. List Workspace assets.
- [Delete orphan assets](https://sosoapi.ai/docs/api/assets-api-orphans-delete): HTTP API: Delete orphan assets. Delete selected unregistered R2 objects.
- [List orphan assets](https://sosoapi.ai/docs/api/assets-api-orphans-list): HTTP API: List orphan assets. List unregistered R2 objects.
- [Request asset purge](https://sosoapi.ai/docs/api/assets-api-purges-request): HTTP API: Request asset purge. Request owner-fenced asset purge.
- [Retry asset purge](https://sosoapi.ai/docs/api/assets-api-purges-retry): HTTP API: Retry asset purge. Retry an eligible fenced purge.
- [Get asset storage inventory](https://sosoapi.ai/docs/api/assets-api-storage-inventory): HTTP API: Get asset storage inventory. Read bounded registered/object storage inventory.
- [Update asset](https://sosoapi.ai/docs/api/assets-api-update): HTTP API: Update asset. Update asset metadata.
- [Complete an asset upload](https://sosoapi.ai/docs/api/assets-api-upload-complete): HTTP API: Complete an asset upload. Complete registration of the uploaded Workspace media object using its signed object identity and idempotency key.
- [Sign an asset upload](https://sosoapi.ai/docs/api/assets-api-upload-sign): HTTP API: Sign an asset upload. Request a signed upload URL for the intended Workspace media object. Upload the bytes before completing registration.
- [Agent authentication: config](https://sosoapi.ai/docs/api/identity-api-agent-auth-config): HTTP API: Agent authentication: config. Agent authentication config protocol. Use the supported browser sign-in flow; never display credentials.
- [Agent authentication: request](https://sosoapi.ai/docs/api/identity-api-agent-auth-request): HTTP API: Agent authentication: request. Agent authentication request protocol. Use the supported browser sign-in flow; never display credentials.
- [Agent authentication: revoke-current](https://sosoapi.ai/docs/api/identity-api-agent-auth-revoke-current): HTTP API: Agent authentication: revoke-current. Agent authentication revoke-current protocol. Use the supported browser sign-in flow; never display credentials.
- [Agent authentication: session](https://sosoapi.ai/docs/api/identity-api-agent-auth-session): HTTP API: Agent authentication: session. Agent authentication session protocol. Use the supported browser sign-in flow; never display credentials.
- [Apply community action](https://sosoapi.ai/docs/api/community-engagement-api-actions-apply): HTTP API: Apply community action. Apply a prepared action; inspect action status for terminal truth.
- [Prepare community action](https://sosoapi.ai/docs/api/community-engagement-api-actions-prepare): HTTP API: Prepare community action. Prepare a terminal community action.
- [Get community action status](https://sosoapi.ai/docs/api/community-engagement-api-actions-status): HTTP API: Get community action status. Read terminal action receipt; enqueue is not success.
- [Get community capabilities](https://sosoapi.ai/docs/api/community-engagement-api-capabilities): HTTP API: Get community capabilities. Read Community Engagement capability facts.
- [Create community comment](https://sosoapi.ai/docs/api/community-engagement-api-comments-create): HTTP API: Create community comment. Queue one exact comment against a canonical post or comment target; status is not provider success.
- [Get comment delivery outcome](https://sosoapi.ai/docs/api/community-engagement-api-comments-outcome): HTTP API: Get comment delivery outcome. Read confirmed delivery, recovery lineage, pending verification and unresolved follow-up.
- [Reconcile comment delivery outcome](https://sosoapi.ai/docs/api/community-engagement-api-comments-reconcile): HTTP API: Reconcile comment delivery outcome. Verify an ambiguous Facebook delivery without resending, or link one confirmed exact replacement. Inspect outcome for terminal proof.
- [Get community comment status](https://sosoapi.ai/docs/api/community-engagement-api-comments-status): HTTP API: Get community comment status. Read the sanitized terminal receipt for a direct comment action.
- [Get community summary](https://sosoapi.ai/docs/api/community-engagement-api-operations-summary): HTTP API: Get community summary. Read Community Engagement operational summary.
- [Query community review queue](https://sosoapi.ai/docs/api/community-engagement-api-review-queue-query): HTTP API: Query community review queue. Read reviewable comments; an empty page is not success.
- [Submit community review](https://sosoapi.ai/docs/api/community-engagement-api-reviews-submit): HTTP API: Submit community review. Submit a new immutable review version.
- [Get Organization context](https://sosoapi.ai/docs/api/identity-api-agent-organization-context): HTTP API: Get Organization context. Read live Organization, Workspace, and Channel authority.
- [Create API key](https://sosoapi.ai/docs/api/identity-api-api-keys-create): HTTP API: Create API key. Create 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](https://sosoapi.ai/docs/api/identity-api-api-keys-extend): HTTP API: Extend API key. Extend 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](https://sosoapi.ai/docs/api/identity-api-api-keys-list): HTTP API: List API keys. List API-key metadata without secrets; set include_authority for capabilities and Workspace limits.
- [Renew API key](https://sosoapi.ai/docs/api/identity-api-api-keys-renew): HTTP API: Renew API key. Create a non-destructive successor API key with the same capabilities and Workspace limits.
- [Revoke API key](https://sosoapi.ai/docs/api/identity-api-api-keys-revoke): HTTP API: Revoke API key. Revoke an API key. An agent can revoke only keys it created.
- [Get billing status](https://sosoapi.ai/docs/api/identity-api-billing-status): HTTP API: Get billing status. Read billing plan, entitlement, and quota facts.
- [Get commercial access](https://sosoapi.ai/docs/api/identity-api-commercial-access-status): HTTP API: Get commercial access. Read Workspace commercial access facts.
- [Submit feedback](https://sosoapi.ai/docs/api/identity-api-feedback-submit): HTTP API: Submit feedback. Submit product feedback with attribution.
- [List Workspace members](https://sosoapi.ai/docs/api/identity-api-member-list): HTTP API: List Workspace members. Read members and pending invites.
- [List organization channels](https://sosoapi.ai/docs/api/identity-api-organization-channels-list): HTTP API: List organization channels. List channels and Workspace attachment state.
- [Preview channel move](https://sosoapi.ai/docs/api/identity-api-organization-channels-move-preview): HTTP API: Preview channel move. Preview blockers before moving a channel.
- [List organization connections](https://sosoapi.ai/docs/api/identity-api-organization-connections-list): HTTP API: List organization connections. Read organization provider connections.
- [Review organization connection](https://sosoapi.ai/docs/api/identity-api-organization-connections-review): HTTP API: Review organization connection. Read the exact provider resources discovered for review.
- [List organizations](https://sosoapi.ai/docs/api/identity-api-organization-list): HTTP API: List organizations. List organizations visible to the authenticated user.
- [List inbox notifications](https://sosoapi.ai/docs/api/identity-api-user-inbox-list): HTTP API: List inbox notifications. Read the authenticated user inbox.
- [Get notification preferences](https://sosoapi.ai/docs/api/identity-api-user-notifications-get): HTTP API: Get notification preferences. Read notification delivery preferences.
- [Update notification preferences](https://sosoapi.ai/docs/api/identity-api-user-notifications-update): HTTP API: Update notification preferences. Update notification delivery preferences.
- [Get user profile](https://sosoapi.ai/docs/api/identity-api-user-profile-get): HTTP API: Get user profile. Read the authenticated user profile.
- [Sign avatar upload](https://sosoapi.ai/docs/api/identity-api-user-profile-sign-avatar-url): HTTP API: Sign avatar upload. Get a signed avatar upload URL.
- [Update user profile](https://sosoapi.ai/docs/api/identity-api-user-profile-update): HTTP API: Update user profile. Update the authenticated user profile.
- [Clear social account block](https://sosoapi.ai/docs/api/identity-api-user-social-accounts-clear-block): HTTP API: Clear social account block. Clear 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](https://sosoapi.ai/docs/api/identity-api-user-social-accounts-disconnect): HTTP API: Disconnect social account. Disconnect a Workspace social account.
- [List connected accounts](https://sosoapi.ai/docs/api/identity-api-user-social-accounts-list): HTTP API: List connected accounts. List connected social accounts in a Workspace.
- [Set social account auto-sync](https://sosoapi.ai/docs/api/identity-api-user-social-accounts-set-auto-sync): HTTP API: Set social account auto-sync. Enable or disable account auto-sync.
- [Create Workspace](https://sosoapi.ai/docs/api/identity-api-workspace-create): HTTP API: Create Workspace. Create a Workspace in an Organization you own or administer. Pass organization_id when you belong to multiple Organizations.
- [Get Workspace context](https://sosoapi.ai/docs/api/identity-api-workspace-list): HTTP API: Get Workspace context. List Workspaces and the active Workspace.
- [Update Workspace](https://sosoapi.ai/docs/api/identity-api-workspace-update): HTTP API: Update Workspace. Update Workspace name or slug.
- [Get job status](https://sosoapi.ai/docs/api/jobs-api-get): HTTP API: Get job status. Read one job status by ID.
- [List jobs](https://sosoapi.ai/docs/api/jobs-api-list): HTTP API: List jobs. Read recent jobs owned by the authenticated user.
- [Start Instagram OAuth](https://sosoapi.ai/docs/api/oauth-api-instagram-init): HTTP API: Start Instagram OAuth. Start provider consent and return the native authorization URL.
- [Refresh Instagram OAuth](https://sosoapi.ai/docs/api/oauth-api-instagram-refresh): HTTP API: Refresh Instagram OAuth. Refresh an Instagram connection.
- [Start Meta OAuth](https://sosoapi.ai/docs/api/oauth-api-meta-init): HTTP API: Start Meta OAuth. Start provider consent and return the native authorization URL.
- [Refresh Meta OAuth](https://sosoapi.ai/docs/api/oauth-api-meta-refresh): HTTP API: Refresh Meta OAuth. Refresh a Meta connection.
- [Check Threads OAuth](https://sosoapi.ai/docs/api/oauth-api-threads-check): HTTP API: Check Threads OAuth. Read Threads connection diagnostics.
- [Start Threads OAuth](https://sosoapi.ai/docs/api/oauth-api-threads-init): HTTP API: Start Threads OAuth. Start provider consent and return the native authorization URL.
- [Refresh Threads OAuth](https://sosoapi.ai/docs/api/oauth-api-threads-refresh): HTTP API: Refresh Threads OAuth. Refresh a Threads connection.
- [Start YouTube OAuth](https://sosoapi.ai/docs/api/oauth-api-youtube-init): HTTP API: Start YouTube OAuth. Start provider consent and return the native authorization URL.
- [Refresh YouTube OAuth](https://sosoapi.ai/docs/api/oauth-api-youtube-refresh): HTTP API: Refresh YouTube OAuth. Refresh a YouTube connection.
- [Get project account defaults](https://sosoapi.ai/docs/api/studio-api-projects-account-defaults-get): HTTP API: Get project account defaults. Read project account defaults.
- [Replace project account defaults](https://sosoapi.ai/docs/api/studio-api-projects-account-defaults-replace): HTTP API: Replace project account defaults. Replace project account defaults.
- [Link project account](https://sosoapi.ai/docs/api/studio-api-projects-accounts-link): HTTP API: Link project account. Link a social account to a project.
- [List project accounts](https://sosoapi.ai/docs/api/studio-api-projects-accounts-list): HTTP API: List project accounts. List accounts linked to a project.
- [Unlink project account](https://sosoapi.ai/docs/api/studio-api-projects-accounts-unlink): HTTP API: Unlink project account. Unlink a social account from a project.
- [Archive project](https://sosoapi.ai/docs/api/studio-api-projects-archive): HTTP API: Archive project. Archive 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](https://sosoapi.ai/docs/api/studio-api-projects-assets-link): HTTP API: Link project asset. Link an asset to a project.
- [List project assets](https://sosoapi.ai/docs/api/studio-api-projects-assets-list): HTTP API: List project assets. List assets linked to a project.
- [Unlink project asset](https://sosoapi.ai/docs/api/studio-api-projects-assets-unlink): HTTP API: Unlink project asset. Unlink an asset from a project.
- [Create project](https://sosoapi.ai/docs/api/studio-api-projects-create): HTTP API: Create project. Create a project.
- [Create project export](https://sosoapi.ai/docs/api/studio-api-projects-export-create): HTTP API: Create project export. Create a project export.
- [Get project export status](https://sosoapi.ai/docs/api/studio-api-projects-export-status): HTTP API: Get project export status. Read project export status.
- [Get project](https://sosoapi.ai/docs/api/studio-api-projects-get): HTTP API: Get project. Read a project.
- [Get project lifecycle history](https://sosoapi.ai/docs/api/studio-api-projects-lifecycle-history): HTTP API: Get project lifecycle history. Read project lifecycle history.
- [List projects](https://sosoapi.ai/docs/api/studio-api-projects-list): HTTP API: List projects. List Workspace projects.
- [Get project profile](https://sosoapi.ai/docs/api/studio-api-projects-profile-get): HTTP API: Get project profile. Read a project profile.
- [Update project profile](https://sosoapi.ai/docs/api/studio-api-projects-profile-update): HTTP API: Update project profile. Update a project profile.
- [Set active project](https://sosoapi.ai/docs/api/studio-api-projects-set-active): HTTP API: Set active project. Set the active project.
- [Unarchive project](https://sosoapi.ai/docs/api/studio-api-projects-unarchive): HTTP API: Unarchive project. Reactivate 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](https://sosoapi.ai/docs/api/studio-api-projects-update): HTTP API: Update project. Update a project.
- [List publication attentions](https://sosoapi.ai/docs/api/studio-api-publication-attentions-list): HTTP API: List publication attentions. Read publication outcomes requiring attention.
- [Bulk create scheduled posts](https://sosoapi.ai/docs/api/studio-api-scheduled-posts-bulk-create): HTTP API: Bulk create scheduled posts. Create scheduled posts for multiple destinations.
- [Cancel scheduled post](https://sosoapi.ai/docs/api/studio-api-scheduled-posts-cancel): HTTP API: Cancel scheduled post. Cancel a scheduled post.
- [Create scheduled post](https://sosoapi.ai/docs/api/studio-api-scheduled-posts-create): HTTP API: Create scheduled post. Create a scheduled post and inspect terminal publication outcome.
- [Submit a complete image post](https://sosoapi.ai/docs/api/studio-api-scheduled-posts-create-image-url): HTTP API: Submit a complete image post. Accept one complete image URL post durably and return its terminal result when available.
- [Delete scheduled post](https://sosoapi.ai/docs/api/studio-api-scheduled-posts-delete): HTTP API: Delete scheduled post. Delete a scheduled post.
- [Get scheduled post eligibility](https://sosoapi.ai/docs/api/studio-api-scheduled-posts-eligibility): HTTP API: Get scheduled post eligibility. Read destination eligibility before scheduling.
- [Get scheduled post](https://sosoapi.ai/docs/api/studio-api-scheduled-posts-get): HTTP API: Get scheduled post. Read one scheduled post.
- [List scheduled posts](https://sosoapi.ai/docs/api/studio-api-scheduled-posts-list): HTTP API: List scheduled posts. List scheduled posts.
- [Publish scheduled post now](https://sosoapi.ai/docs/api/studio-api-scheduled-posts-publish-now): HTTP API: Publish scheduled post now. Request immediate publication.
- [Retry scheduled post](https://sosoapi.ai/docs/api/studio-api-scheduled-posts-retry): HTTP API: Retry scheduled post. Retry a failed scheduled post.
- [Update scheduled post](https://sosoapi.ai/docs/api/studio-api-scheduled-posts-update): HTTP API: Update scheduled post. Update a scheduled post.
- [Withdraw deletion request](https://sosoapi.ai/docs/api/studio-api-scheduled-posts-withdraw-delete): HTTP API: Withdraw deletion request. Withdraw a stopped Instagram Login deletion request and retain the published post.
- [Get X publishing credits](https://sosoapi.ai/docs/api/studio-api-x-usage): HTTP API: Get X publishing credits. Read shared Organization X credits and the credit cost of optional final Post text.