Global Request Parameters

To ensure consistent behavior across the Supervised AI Testing API, certain parameters and headers are applied globally. These parameters control authentication, data formatting, and pagination across all available endpoints.

Standard Headers

All requests to the API must include the following headers to ensure proper authentication and response handling.

Example Header Configuration:

curl -X GET "https://api.supervised.ai/v1/tests" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -H "X-Request-ID: req_882910"

Global Query Parameters

These parameters can be appended to any GET request to modify the returned data set, particularly when dealing with collections of resources.

Example Pagination Request:

GET /v1/test-suites?limit=10&offset=20&sort=-updated_at

Standard Body Parameters

For write operations (POST, PUT, PATCH), the API expects a JSON-formatted body. While specific endpoints have unique fields, the following structure is commonly supported for metadata and tagging.

Example Request Body:

{
  "name": "Production Validation Test",
  "metadata": {
    "environment": "production",
    "priority": "high"
  },
  "tags": ["regression", "v2-release"]
}

Error Responses

If a global parameter is missing or malformed (e.g., an invalid Authorization header), the API will return a standard error object:

{
  "error": {
    "code": "unauthorized",
    "message": "The provided API key is invalid or expired.",
    "request_id": "req_882910"
  }
}