Skip to Content
Référence APIIntroduction

Référence API

L’API Skoup suit REST : des URL orientées ressources prévisibles, des corps JSON en requête et en réponse, les verbes et codes HTTP standard. Chaque objet porte un id préfixé et un nom d’object.

  • Authentification — Clés Bearer (skoup_live_… / skoup_test_…) et scopes.
  • Mode test — Les clés de test travaillent sur un bac à sable ; les écritures sont annulées.
  • Erreurs — { error: { type, code, message, param, doc_url, request_id } }.
  • Pagination — Curseurs limit + starting_after, { object: "list", data, has_more }.
  • Idempotence — Idempotency-Key sur chaque POST, rejoué pendant 24 h.
  • Limites & quotas — En-têtes de réponse X-RateLimit-* et Skoup-Quota-*.
  • IDs d’objets — IDs préfixés (br_, task_, alrt_…), chaînes opaques.

Télécharger la spec OpenAPI — Document OpenAPI 3.1 de l’API publique — à importer dans Postman, Insomnia ou un générateur de client.

URL de base · https://api.skoup.ai/v1
curl https://api.skoup.ai/v1/brands \ -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"

Ressources

Alerts

Brands

Competitors

Events

Markets

Metrics

Products

Queries

Readiness

Revenue

Samplings

Tasks

Webhook endpoints

Last updated on