Introduction

API endpoint

The API is available at the following base endpoint:

Bearer token

All endpoints require a valid bearer token to be included in the Authorization header of the request. See how you can obtain a bearer token in the get started guide.

Example request

curl --request GET \
  --url https://www.chat-flow.app/api/sentinel/v1/status \
  --header 'accept: application/json' \
  --header 'Authorization: Bearer [YOUR_API_KEY]'

Response format

All responses are returned directly in JSON format. Each endpoint returns its specific response structure as documented in the API Reference.

Example response

{
  "status": "active",
  "api_key": {
    "name": "Production Key"
  },
  "subscription": {
    "plan": "shield",
    "status": "active"
  }
}

If the request fails, the response will include an error field with the error message and a code field with the error code.

Error response

{
  "error": "Invalid API key provided",
  "code": "INVALID_API_KEY"
}