A busca carrega apenas quando você a usa. Explore todas as categorias abaixo.
SosoAPI · Documentação para desenvolvedores
Referência da API
107 operações que você pode chamar pelo app, mais 4 endpoints para login do agente. Abra uma operação para ver campos da requisição, resposta, permissões e chamadas de exemplo.
Contas e workspaces
- Obter contexto da Organization
POST /identity-api/agent/organization-contextConsulte a autoridade atual de Organization, Workspace e Channel. - Criar API key
POST /identity-api/api-keys/createCrie uma API key com as capacidades escolhidas e limites opcionais de Workspace; o segredo é retornado uma vez. Um agente só pode conceder o que sua própria autorização permite, por no máximo 30 dias, e uma autorização pode ter no máximo 25 chaves ativas (API_KEY_GRANT_KEY_LIMIT). - Estender API key
POST /identity-api/api-keys/extendEstenda a validade de uma API key para no máximo 365 dias a partir de agora (30 para uma chave criada por agente); um horário posterior é recusado com API_KEY_LIFETIME_EXCEEDS_CAP. A resposta informa a validade aplicada. - Listar API keys
POST /identity-api/api-keys/listListe metadados de API keys sem segredos; defina include_authority para capacidades e limites de Workspace. - Renovar API key
POST /identity-api/api-keys/renewCrie uma API key sucessora não destrutiva com as mesmas capacidades e limites de Workspace. - Revogar API key
POST /identity-api/api-keys/revokeRevogue uma API key. Um agente só pode revogar chaves que ele criou. - Obter status de cobrança
POST /identity-api/billing/statusConsulte informações de plano, direitos de acesso e cotas. - Obter acesso comercial
POST /identity-api/commercial-access/statusConsulte as informações de acesso comercial do Workspace. - Enviar feedback
POST /identity-api/feedback/submitEnvie feedback do produto com atribuição. - Listar membros do Workspace
POST /identity-api/member/listConsulte membros e convites pendentes. - Listar canais da organização
POST /identity-api/organization/channels/listListe os canais e o estado de associação ao Workspace. - Pré-visualizar movimentação de canal
POST /identity-api/organization/channels/move/previewConfira os impedimentos antes de mover um canal. - Listar conexões da organização
POST /identity-api/organization/connections/listConsulte as conexões de provedores da organização. - Revisar conexão da organização
POST /identity-api/organization/connections/reviewConsulte os recursos exatos do provedor descobertos para revisão. - Listar organizações
POST /identity-api/organization/listListe as organizações visíveis para o usuário autenticado. - Listar notificações da caixa de entrada
POST /identity-api/user/inbox/listConsulte a caixa de entrada do usuário autenticado. - Obter preferências de notificação
POST /identity-api/user/notifications/getConsulte as preferências de entrega de notificações. - Atualizar preferências de notificação
POST /identity-api/user/notifications/updateAtualize as preferências de entrega de notificações. - Obter perfil do usuário
POST /identity-api/user/profile/getConsulte o perfil do usuário autenticado. - Assinar envio de avatar
POST /identity-api/user/profile/sign-avatar-urlObtenha uma URL assinada de envio de avatar. - Atualizar perfil do usuário
POST /identity-api/user/profile/updateAtualize o perfil do usuário autenticado. - Remover bloqueio de conta social
POST /identity-api/user/social-accounts/clear-blockRemova o período de espera de uma conta sem repetir um post. Uma credencial de agente é recusada enquanto o período de espera estiver ativo ou quando a conta atingir seu terceiro período de espera; qualquer chamador pode liberar uma conta no máximo uma vez a cada 10 minutos. - Desconectar conta social
POST /identity-api/user/social-accounts/disconnectDesconecte uma conta social do Workspace. - Listar contas conectadas
POST /identity-api/user/social-accounts/listListe as contas sociais conectadas em um Workspace. - Definir sincronização automática da conta social
POST /identity-api/user/social-accounts/set-auto-syncAtive ou desative a sincronização automática da conta. - Criar Workspace
POST /identity-api/workspace/createCrie um Workspace em uma Organization da qual você seja proprietário ou administrador. Informe organization_id quando participar de várias Organizations. - Obter contexto do Workspace
POST /identity-api/workspace/listListe os Workspaces e o Workspace ativo. - Atualizar Workspace
POST /identity-api/workspace/updateAtualize o nome ou slug do Workspace.
Mídia e ativos
- Criar ativo
POST /assets-api/createRegistre metadados do ativo. - Excluir ativo
POST /assets-api/deleteExclua um ativo. - Criar exportação de ativos
POST /assets-api/exports/createCrie um job de evidências de exportação de ativos. - Obter status de exportação de ativo
POST /assets-api/exports/statusConsulte o status durável de exportação de ativos. - Verificar exportação de ativos
POST /assets-api/exports/verifyVerifique uma exportação de ativos antes de qualquer exclusão definitiva. - Obter ativo
POST /assets-api/getConsulte um ativo pelo ID. - Obter status de importação de ativo
POST /assets-api/imports/statusConsulte o status durável de importação de mídia. - Importar URL de ativo
POST /assets-api/imports/urlColoque na fila a entrada explícita de mídia externa. - Consultar ativos
POST /assets-api/listConsulte ativos com filtros compatíveis com versões anteriores. - Listar ativos
POST /assets-api/list-workspaceListe os ativos do Workspace. - Excluir ativos órfãos
POST /assets-api/orphans/deleteExclua objetos R2 não registrados selecionados. - Listar ativos órfãos
POST /assets-api/orphans/listListe os objetos R2 não registrados. - Solicitar exclusão definitiva de ativos
POST /assets-api/purges/requestSolicite a exclusão definitiva de ativos protegida pela autorização do proprietário. - Tentar novamente a exclusão definitiva de ativos
POST /assets-api/purges/retryRepita uma exclusão definitiva elegível protegida por fencing. - Obter inventário de armazenamento de ativos
POST /assets-api/storage/inventoryConsulte o inventário limitado de registros/objetos armazenados. - Atualizar ativo
POST /assets-api/updateAtualize os metadados do ativo. - Concluir envio de ativo
POST /assets-api/upload/completeConclua o registro do objeto de mídia enviado ao Workspace usando sua identidade de objeto assinada e a chave de idempotência. - Assinar envio de ativo
POST /assets-api/upload/signSolicite uma URL de envio assinada para o objeto de mídia pretendido do Workspace. Envie os bytes antes de concluir o registro.
Projetos e conteúdo
- Obter contas padrão do projeto
POST /studio-api/projects/account-defaults/getConsulte as contas padrão do projeto. - Substituir contas padrão do projeto
POST /studio-api/projects/account-defaults/replaceSubstituir contas padrão do projeto. - Vincular conta ao projeto
POST /studio-api/projects/accounts/linkVincule uma conta social a um projeto. - Listar contas do projeto
POST /studio-api/projects/accounts/listListe as contas vinculadas a um projeto. - Desvincular conta do projeto
POST /studio-api/projects/accounts/unlinkDesvincule uma conta social de um projeto. - Arquivar projeto
POST /studio-api/projects/archiveArquive um projeto sem alterar seus Scheduled Posts. Para interromper um post, cancele esse Scheduled Post separadamente. Somente o proprietário do Workspace; informe expected_lifecycle_version e idempotency_key. - Vincular ativo ao projeto
POST /studio-api/projects/assets/linkVincule um ativo a um projeto. - Listar ativos do projeto
POST /studio-api/projects/assets/listListe os ativos vinculados a um projeto. - Desvincular ativo do projeto
POST /studio-api/projects/assets/unlinkDesvincule um ativo de um projeto. - Criar projeto
POST /studio-api/projects/createCrie um projeto. - Criar exportação de projeto
POST /studio-api/projects/export/createCrie uma exportação de projeto. - Obter status de exportação de projeto
POST /studio-api/projects/export/statusConsulte o status de exportação de projeto. - Obter projeto
POST /studio-api/projects/getConsulte um projeto. - Obter histórico de ciclo de vida do projeto
POST /studio-api/projects/lifecycle/historyConsulte o histórico de ciclo de vida do projeto. - Listar projetos
POST /studio-api/projects/listListe os projetos do Workspace. - Obter perfil do projeto
POST /studio-api/projects/profile/getConsulte o perfil de um projeto. - Atualizar perfil do projeto
POST /studio-api/projects/profile/updateAtualize o perfil de um projeto. - Definir projeto ativo
POST /studio-api/projects/set-activeDefina o projeto ativo. - Desarquivar projeto
POST /studio-api/projects/unarchiveReative um projeto arquivado. Isso não retoma nem reagenda posts; gerencie-os por Scheduled Posts. Somente o proprietário do Workspace; informe expected_lifecycle_version e idempotency_key. - Atualizar projeto
POST /studio-api/projects/updateAtualize um projeto. - Listar publicações que exigem atenção
POST /studio-api/publication-attentions/listConsulte os resultados de publicação que exigem atenção.
Agendamento e publicação
- Criar posts agendados em lote
POST /studio-api/scheduled-posts/bulk-createCrie posts agendados para vários destinos. - Cancelar post agendado
POST /studio-api/scheduled-posts/cancelCancele um post agendado. - Criar post agendado
POST /studio-api/scheduled-posts/createCrie um post agendado e consulte o resultado terminal da publicação. - Enviar um post de imagem completo
POST /studio-api/scheduled-posts/create-image-urlAceite de forma durável um post completo de imagem por URL e retorne seu resultado terminal quando disponível. - Excluir post agendado
POST /studio-api/scheduled-posts/deleteExclua um post agendado. - Obter elegibilidade de post agendado
POST /studio-api/scheduled-posts/eligibilityConsulte a elegibilidade do destino antes de agendar. - Obter post agendado
POST /studio-api/scheduled-posts/getConsulte um post agendado. - Listar posts agendados
POST /studio-api/scheduled-posts/listListar posts agendados. - Publicar post agendado agora
POST /studio-api/scheduled-posts/publish-nowSolicite publicação imediata. - Tentar novamente o post agendado
POST /studio-api/scheduled-posts/retryTente novamente um post agendado que falhou. - Atualizar post agendado
POST /studio-api/scheduled-posts/updateAtualize um post agendado. - Retirar solicitação de exclusão
POST /studio-api/scheduled-posts/withdraw-deleteRetire uma solicitação interrompida de exclusão do Instagram Login e mantenha o post publicado. - Obter créditos de publicação no X
POST /studio-api/x/usageConsulte os créditos X compartilhados da Organization e o custo em créditos do texto final opcional do Post.
Análises e insights
- Obter contagens do painel
POST /analytics-api/dashboard/ops-countsConsulte as contagens operacionais do painel. - Solicitar insights do provedor
POST /analytics-api/provider-insights/requestSolicite insights cuja fonte oficial é o provedor. - Obter status de insights do provedor
POST /analytics-api/provider-insights/statusConsulte o status da solicitação de insights do provedor. - Listar comentários de posts
POST /analytics-api/social/comments/queryConsulte os comentários sociais descobertos. - Listar posts monitorados
POST /analytics-api/social/posts/queryConsulte os posts sociais descobertos.
Conexões sociais
- Iniciar OAuth do Instagram
POST /oauth-api/instagram/initInicie o consentimento do provedor e retorne a URL de autorização nativa. - Renovar OAuth do Instagram
POST /oauth-api/instagram/refreshRenove uma conexão do Instagram. - Iniciar OAuth da Meta
POST /oauth-api/meta/initInicie o consentimento do provedor e retorne a URL de autorização nativa. - Renovar OAuth da Meta
POST /oauth-api/meta/refreshRenove uma conexão da Meta. - Verificar OAuth do Threads
POST /oauth-api/threads/checkConsulte os diagnósticos da conexão do Threads. - Iniciar OAuth do Threads
POST /oauth-api/threads/initInicie o consentimento do provedor e retorne a URL de autorização nativa. - Renovar OAuth do Threads
POST /oauth-api/threads/refreshRenove uma conexão do Threads. - Iniciar OAuth do YouTube
POST /oauth-api/youtube/initInicie o consentimento do provedor e retorne a URL de autorização nativa. - Renovar OAuth do YouTube
POST /oauth-api/youtube/refreshRenove uma conexão do YouTube.
Operações em segundo plano
Comentários e comunidade
- Aplicar ação da comunidade
POST /community-engagement-api/actions/applyAplique uma ação preparada; consulte o status da ação para obter a verdade terminal. - Preparar ação da comunidade
POST /community-engagement-api/actions/preparePrepare uma ação terminal da comunidade. - Obter status de ação da comunidade
POST /community-engagement-api/actions/statusConsulte o comprovante terminal da ação; entrar na fila não é sucesso. - Obter capacidades da comunidade
POST /community-engagement-api/capabilitiesConsulte as informações de capacidades de Community Engagement. - Criar comentário da comunidade
POST /community-engagement-api/comments/createColoque na fila um comentário exato para um destino canônico de post ou comentário; o status não representa sucesso do provedor. - Obter resultado de entrega de comentário
POST /community-engagement-api/comments/outcomeConsulte a entrega confirmada, a linhagem de recuperação, a verificação pendente e o acompanhamento não resolvido. - Reconciliar resultado de entrega de comentário
POST /community-engagement-api/comments/reconcileVerifique uma entrega ambígua do Facebook sem reenviar ou vincule uma substituição exata confirmada. Consulte o resultado para obter prova terminal. - Obter status de comentário da comunidade
POST /community-engagement-api/comments/statusConsulte o comprovante terminal sanitizado de uma ação direta em comentário. - Obter resumo da comunidade
POST /community-engagement-api/operations/summaryConsulte o resumo operacional de Community Engagement. - Consultar fila de revisão da comunidade
POST /community-engagement-api/review-queue/queryConsulte comentários disponíveis para revisão; uma página vazia não é sucesso. - Enviar revisão da comunidade
POST /community-engagement-api/reviews/submitEnvie uma nova versão de revisão imutável.
Inicialização da autenticação
- Autenticação do agente: config
POST /identity-api/agent-auth/configProtocolo config de autenticação do agente. Use o fluxo de login no navegador compatível; nunca exiba credenciais. - Autenticação do agente: request
POST /identity-api/agent-auth/requestProtocolo request de autenticação do agente. Use o fluxo de login no navegador compatível; nunca exiba credenciais. - Autenticação do agente: revoke-current
POST /identity-api/agent-auth/revoke-currentProtocolo revoke-current de autenticação do agente. Use o fluxo de login no navegador compatível; nunca exiba credenciais. - Autenticação do agente: session
POST /identity-api/agent-auth/sessionProtocolo session de autenticação do agente. Use o fluxo de login no navegador compatível; nunca exiba credenciais.