# Lire la couverture des sources Listening URL canonique : https://sosoapi.ai/fr/docs/api/listening-api-capabilities Contrat : sha256:ab393e91e9b7f18a Lire la couverture des sources Listening prises en charge, les règles de recherche littérale et les limites de collecte ; métadonnées uniquement. Exige agent:research. POST /listening-api/capabilities ## Authentification et autorisations - **Types d’identifiants acceptés:** user_session, delegated_oauth, personal_access_token - **Capacité déléguée:** agent:research - **Rôle minimal dans l’espace de travail:** viewer - **Périmètre d’accès:** Ressources auxquelles cet utilisateur est autorisé à accéder - **Consentement pour tous les espaces requis:** Non - **Modifie l’état:** Non - **Lorsque l’opération est terminée:** données Listening actuellement autorisées ; l’échantillon public indexé est partiel et ne constitue pas une mention de compte vérifiée Un jeton ne peut utiliser que les droits de son propriétaire. Chaque requête vérifie l’appartenance à l’espace, la propriété des ressources, les espaces sélectionnés et les capacités accordées. Les profils core et full modifient les outils affichés ; ils n’accordent aucun accès. ## Champs de requête ```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 } ``` ## Réponse et achèvement Statuts HTTP de réussite : 200 Une réponse HTTP réussie peut signifier qu’une requête est acceptée plutôt que terminée. Pour le travail en arrière-plan, conservez l’identifiant renvoyé et suivez la même opération jusqu’à sa fin. Une publication programmée ou acceptée n’est publiée que lorsque la plateforme le confirme ; une expiration côté client ne détermine pas le résultat. ```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" ] } ``` ## Erreurs et nouvelles tentatives sûres Vérifiez le statut HTTP et le corps de réponse. Une erreur de validation 400 peut contenir un ZodError ; les erreurs des gestionnaires utilisent les champs error, message et code. Conservez request_id ou x-request-id pour le diagnostic, sans identifiants secrets. Corrigez les erreurs d’accès 401/403 avant de réessayer et respectez Retry-After pour 429. Si une écriture est incertaine ou renvoie 5xx, lisez d’abord le résultat existant. Réutilisez une clé d’idempotence uniquement lorsque c’est pris en charge ; le comportement des nouvelles tentatives varie selon l’opération et ne garantit pas une diffusion exactement une fois. ## Exemples Ces exemples utilisent des valeurs fictives vérifiées contre les schémas. Remplacez les identifiants par ceux que vous êtes autorisé à utiliser, les médias par des ressources prêtes et les dates par l’heure confirmée. Vérifiez l’éligibilité du compte avant toute écriture. Cette page n’envoie aucune requête API. Définissez SOSOAPI_ACCESS_TOKEN sur votre serveur avec un identifiant accepté par cette opération et gardez-le hors du code navigateur. Pour un agent IA, utilisez sosoapi auth login pour vous connecter dans le navigateur et laissez la CLI actualiser ses identifiants. 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 ``` Exemple de réponse fictive ```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 } } ``` ## Outils et guides associés MCP : sosoapi_listening_capabilities [Référence API](https://sosoapi.ai/fr/docs/api)