Aller au contenu
KelkiDéveloppeurs

Compte

Plan, plafonds et consommation du compte partenaire.

Adresse de base : https://kelki.ai/api/v1.

GET /account

Lire le compte, le plan et les plafonds

Authentification : clé API (Authorization: Bearer kk_…) ou jeton OAuth 2.0 (portée catalog.read).

Réponses

CodeDescriptionContenu
200

Le compte.

application/json Account
401

Identifiants absents, invalides, expirés ou révoqués.

application/problem+json Problem

Exemple de réponse

{
  "id": "acc_01JC00000000000000000000CC",
  "name": "Conciergerie Exemple",
  "mode": "test",
  "plan": "standard",
  "live_enabled": false,
  "limits": {
    "requests_per_minute": 120,
    "requests_per_day": 20000,
    "live_requests_per_day": 50,
    "agent_messages_per_day": 500,
    "webhook_endpoints": 5
  },
  "credential": {
    "type": "api_key",
    "prefix": "kk_test_Ab12Cd34",
    "scopes": [
      "catalog.read",
      "requests.read",
      "requests.write",
      "agent"
    ]
  }
}

GET /account/usage

Consommation par jour

Authentification : clé API (Authorization: Bearer kk_…) ou jeton OAuth 2.0 (portée catalog.read).

Paramètres

NomOùRequisTypeDescription
fromqueryouistring (date)
toqueryouistring (date)

Réponses

CodeDescriptionContenu
200

Compteurs par jour (au plus 92 jours).

application/json UsageList
400

Requête mal formée (JSON invalide, paramètre inconnu, corps trop gros).

application/problem+json Problem
401

Identifiants absents, invalides, expirés ou révoqués.

application/problem+json Problem

Exemple de réponse

{
  "object": "list",
  "has_more": false,
  "next_cursor": null,
  "data": [
    {
      "date": "2026-11-11",
      "calls": 412,
      "rate_limited": 0,
      "errors": 3,
      "drafts_created": 9,
      "requests_transmitted": 7,
      "requests_sold": 4,
      "callbacks_confirmed": 2,
      "agent_messages": 31
    }
  ]
}

Schémas

Account

ChampTypeRequisDescription
idstringoui
namestringoui

Nom affiché dans les e-mails envoyés aux personnes. Fixé par Kelki.

modestringoui

valeurs : test, live

planstringoui
live_enabledbooleanoui
limitsobjectoui
credentialobjectoui

Problem

Détails d'un problème (RFC 9457), avec des membres d'extension.

ChampTypeRequisDescription
typestring (uri)oui

URI stable du type de problème ; elle mène à sa documentation.

titlestringoui
statusintegeroui

min. 400 · max. 599

detailstringnon
instancestring (uri-reference)non
codestringoui

Code stable, lisible par une machine.

valeurs : invalid_json, invalid_parameter, payload_too_large, unsupported_media_type, invalid_credentials, expired_token, insufficient_scope, live_not_enabled, account_suspended, country_not_available, trade_not_available, not_found, invalid_state, idempotency_in_progress, idempotency_key_reused, validation_failed, consent_missing, consent_version_outdated, contact_limit_reached, duplicate_request, rate_limited, quota_exceeded, agent_paused, live_creation_paused, service_unavailable, internal_error

request_idstringoui
errorstableau de FieldErrornon

UsageList

Type : ListMeta et object

FieldError

ChampTypeRequisDescription
pointerstringoui

JSON Pointer (RFC 6901) du champ en cause.

detailstringoui
allowedtableau de stringnon

Valeurs acceptées, quand la liste est fermée.

ListMeta

ChampTypeRequisDescription
objectstringoui

valeur : list

has_morebooleanoui
next_cursorstring | nulloui