# Obtenir les crédits de publication X URL canonique : https://sosoapi.ai/fr/docs/api/studio-api-x-usage Contrat : sha256:563d2d581da0ad29 Lire les crédits de publication X de l’organisation partagés par cet espace de travail. Nécessite workspace_id. Free reçoit 10 crédits une fois ; Pro en reçoit 100 par période de facturation. Un texte coûte 1 crédit ; un texte contenant une URL en coûte 10. Un texte facultatif permet d’en connaître le coût. Lit le quota enregistré sans appeler l’API X. POST /studio-api/x/usage ## Authentification et autorisations - **Types d’identifiants acceptés:** user_session, delegated_oauth, personal_access_token - **Capacité déléguée:** agent:operate - **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:** synchronous_http_response 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)$" }, "text": { "type": "string", "maxLength": 4096 } }, "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": { "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)$" }, "plan": { "type": "string", "enum": [ "free", "founding_pro" ] }, "allowance": { "type": "string", "enum": [ "one_time", "monthly" ] }, "period_start": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "period_end": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "number", "const": 10 }, { "type": "number", "const": 100 } ] }, "reserved": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "consumed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "costs": { "type": "object", "properties": { "text": { "type": "number", "const": 1 }, "with_url": { "type": "number", "const": 10 } }, "required": [ "text", "with_url" ] }, "draft_credits": { "anyOf": [ { "type": "number", "const": 1 }, { "type": "number", "const": 10 } ] } }, "required": [ "workspace_id", "plan", "allowance", "period_start", "period_end", "limit", "reserved", "consumed", "remaining", "costs" ] } ``` ## 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, 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/studio-api/x/usage" \ -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/studio-api/x/usage", { 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 /studio-api/x/usage < request.json ``` Exemple de réponse fictive ```json { "workspace_id": "11111111-1111-4111-8111-111111111111", "plan": "free", "allowance": "one_time", "period_start": "2099-01-15T09:00:00Z", "period_end": null, "limit": 10, "reserved": 0, "consumed": 0, "remaining": 0, "costs": { "text": 1, "with_url": 10 } } ``` ## Outils et guides associés MCP: sosoapi_get_x_usage [Référence API](https://sosoapi.ai/fr/docs/api)