# Ler a cobertura de fontes do Listening URL canônica: https://sosoapi.ai/pt-br/docs/api/listening-api-capabilities Contrato: sha256:ab393e91e9b7f18a Ler a cobertura das fontes compatíveis com Listening, as regras de consulta literal e os limites de coleta; somente metadados. Exige agent:research. POST /listening-api/capabilities ## Autenticação e permissões - **Classes de credenciais aceitas:** user_session, delegated_oauth, personal_access_token - **Capacidade delegada:** agent:research - **Função mínima no workspace:** viewer - **Escopo de acesso:** Recursos que este usuário tem autorização para acessar - **Consentimento para todos os workspaces obrigatório:** Não - **Altera o estado:** Não - **Quando a operação estiver concluída:** dados do Listening autorizados atualmente; a amostra pública indexada é parcial e não é uma menção verificada à conta Um token só pode usar os direitos do seu proprietário. Cada requisição verifica participação no workspace, propriedade de recursos, workspaces selecionados e capacidades concedidas. Os perfis core e full mudam as ferramentas exibidas; não concedem acesso. ## Campos da requisição ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "workspace_id" ], "additionalProperties": false } ``` ## Resposta e conclusão Códigos HTTP de sucesso: 200 Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado. ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "source": { "type": "string", "const": "hacker_news" }, "query_mode": { "type": "string", "const": "literal_phrase" }, "include_mode": { "type": "string", "const": "all_literal_substrings" }, "exclude_mode": { "type": "string", "const": "any_literal_substring" }, "item_types": { "type": "array", "prefixItems": [ { "type": "string", "const": "story" }, { "type": "string", "const": "comment" } ], "items": false, "minItems": 2, "maxItems": 2 }, "coverage": { "type": "string", "const": "partial_indexed_sample" }, "exhaustive": { "type": "boolean", "const": false }, "limits": { "type": "object", "properties": { "streams_per_workspace": { "type": "number", "const": 5 }, "minimum_cadence_minutes": { "type": "number", "const": 30 }, "lookback_days": { "type": "number", "const": 7 }, "content_retention_days": { "type": "number", "const": 7 }, "results_per_run": { "type": "number", "const": 20 }, "provider_gets_per_run": { "type": "number", "const": 21 }, "workspace_provider_gets_per_day": { "type": "number", "const": 500 }, "shared_searches_per_hour": { "type": "number", "const": 5000 } }, "required": [ "streams_per_workspace", "minimum_cadence_minutes", "lookback_days", "content_retention_days", "results_per_run", "provider_gets_per_run", "workspace_provider_gets_per_day", "shared_searches_per_hour" ] } }, "required": [ "source", "query_mode", "include_mode", "exclude_mode", "item_types", "coverage", "exhaustive", "limits" ] } ``` ## Erros e repetições seguras Confira o status HTTP e o corpo da resposta. Um erro de validação 400 pode conter ZodError; erros do handler usam os campos error, message e code. Guarde request_id ou x-request-id para diagnóstico, sem credenciais. Corrija erros de acesso 401/403 antes de tentar novamente e siga Retry-After para 429. Se uma gravação for incerta ou retornar 5xx, consulte primeiro o resultado existente. Reutilize uma chave de idempotência somente quando houver suporte; o comportamento de repetição varia por operação e não garante entrega exatamente uma vez. ## Exemplos Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API. Defina SOSOAPI_ACCESS_TOKEN no servidor como uma credencial aceita por esta operação e mantenha-a fora do código do navegador. Para agentes de IA, use sosoapi auth login para entrar pelo navegador e deixe a CLI renovar suas credenciais. request.json ```json { "workspace_id": "11111111-1111-4111-8111-111111111111" } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/listening-api/capabilities" \ -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ --data-binary @request.json ``` JavaScript ```js // Server-side JavaScript. Do not print tokens or credential-bearing responses. const token = process.env.SOSOAPI_ACCESS_TOKEN; if (!token) throw new Error("Set an accepted credential for this operation"); const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/listening-api/capabilities", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_id": "11111111-1111-4111-8111-111111111111" }) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /listening-api/capabilities < request.json ``` Exemplo de resposta sintética ```json { "source": "hacker_news", "query_mode": "literal_phrase", "include_mode": "all_literal_substrings", "exclude_mode": "any_literal_substring", "item_types": [ "story", "comment" ], "coverage": "partial_indexed_sample", "exhaustive": false, "limits": { "streams_per_workspace": 5, "minimum_cadence_minutes": 30, "lookback_days": 7, "content_retention_days": 7, "results_per_run": 20, "provider_gets_per_run": 21, "workspace_provider_gets_per_day": 500, "shared_searches_per_hour": 5000 } } ``` ## Ferramentas e guias relacionados MCP: sosoapi_listening_capabilities [Referência da API](https://sosoapi.ai/pt-br/docs/api)