Request Parameters & Headers
HTTP Headers
All requests to the Supervised AI Testing API must include the following headers to ensure proper authentication and data handling.
| Header | Required | Description |
| :--- | :--- | :--- |
| Authorization | Yes | API access token. Format: Bearer <YOUR_API_KEY>. |
| Content-Type | Yes | The media type of the resource. Set to application/json. |
| X-Project-ID | No | Specific project identifier if working across multiple Supervised AI environments. |
Example Header Configuration
GET /v1/models/model_8821/tests HTTP/1.1
Host: api.supervisedai.com
Authorization: Bearer sa_live_xxxxxxxxxxxx
Content-Type: application/json
Path Variables
Path variables are used to identify specific resources within the testing infrastructure, such as models, datasets, or specific test runs.
| Variable | Type | Description |
| :--- | :--- | :--- |
| model_id | String | The unique identifier for the supervised model being tested. |
| test_suite_id | String | The ID of the specific suite containing the test cases. |
| execution_id | String | The unique ID generated for a specific API test execution run. |
Usage Example
https://api.supervisedai.com/v1/models/{model_id}/suites/{test_suite_id}
Query Parameters
Query parameters allow you to filter results, manage pagination, and toggle specific testing behaviors like verbose logging or asynchronous processing.
Pagination & Filtering
| Parameter | Type | Default | Description |
| :--- | :--- | :--- | :--- |
| limit | Integer | 20 | Number of test results to return per page (Max: 100). |
| offset | Integer | 0 | Number of items to skip before starting to return results. |
| status | String | all | Filter by test status: passed, failed, pending, or error. |
Execution Control
| Parameter | Type | Default | Description |
| :--- | :--- | :--- | :--- |
| async | Boolean | false | If true, the API returns an execution_id immediately and processes the test in the background. |
| verbose | Boolean | false | If true, includes detailed trace logs and raw model outputs in the response. |
| version | String | latest | Specifies the version of the model deployment to target. |
Example Request with Query Parameters
curl -X GET "https://api.supervisedai.com/v1/test-results?status=failed&limit=10&verbose=true" \
-H "Authorization: Bearer YOUR_API_KEY"
Internal Configuration Parameters
The following parameters are used for internal routing and environment staging. While public users can view these in certain log outputs, they should not be modified unless directed by the Supervised AI support team.
internal_node_id: (Internal) Routes requests to specific testing clusters.debug_trace_enabled: (Internal) Used for platform-level debugging; overrides standardverboseflags.