Query parameters
-
workspace_uuid
string | null
Responses
-
200 application/json
OK
-
400 application/json
Bad Request
-
401 application/json
Unauthorized
-
403 application/json
Forbidden
-
404 application/json
Not Found
-
409 application/json
Conflict
-
422 application/json
Unprocessable Entity
-
429 application/json
Too Many Requests
-
500 application/json
Internal Server Error
-
503 application/json
Service Unavailable
GET
/v1/usage/
curl \
--request GET 'https://api.aymara.ai/v1/usage/' \
--header "x-api-key: $API_KEY"
Response examples (200)
{
"billing_cycles": [
{
"billing_cycle_uuid": "string",
"billing_cycle_start_date": "2025-05-04",
"billing_cycle_end_date": "2025-05-04",
"paid_amount_usd": 42.0,
"score_runs": [
{
"score_run_uuid": "string",
"score_run_status": "record_created",
"test": {
"test_uuid": "string",
"test_name": "string",
"test_status": "record_created",
"test_type": "string",
"organization_name": "string",
"num_test_questions": 42,
"created_at": "2025-05-04T09:42:00Z",
"updated_at": "2025-05-04T09:42:00Z",
"test_system_prompt": "string",
"test_policy": "string",
"knowledge_base": "string",
"additional_instructions": "string",
"is_jailbreak": false,
"modality": "text",
"test_examples": [
{
"example_uuid": "string",
"example_text": "string",
"explanation": "string",
"example_type": "good"
}
]
},
"created_at": "2025-05-04T09:42:00Z",
"updated_at": "2025-05-04T09:42:00Z",
"remaining_score_runs": 42,
"price": 42.0,
"price_adjustment_note": "string",
"created_by": {
"email": "string",
"organization": {
"org_uuid": "string",
"name": "string"
},
"is_admin": true,
"is_impersonating": true,
"feature_flags": {
"enable_dashboard": true
}
},
"score_run_examples": [
{
"example_uuid": "string",
"question_text": "string",
"answer_text": "string",
"explanation": "string",
"example_type": "pass"
}
],
"pass_rate": 42.0
}
]
}
],
"free_score_runs": [
{
"score_run_uuid": "string",
"score_run_status": "record_created",
"test": {
"test_uuid": "string",
"test_name": "string",
"test_status": "record_created",
"test_type": "string",
"organization_name": "string",
"num_test_questions": 42,
"created_at": "2025-05-04T09:42:00Z",
"updated_at": "2025-05-04T09:42:00Z",
"test_system_prompt": "string",
"test_policy": "string",
"knowledge_base": "string",
"additional_instructions": "string",
"is_jailbreak": false,
"modality": "text",
"test_examples": [
{
"example_uuid": "string",
"example_text": "string",
"explanation": "string",
"example_type": "good"
}
]
},
"created_at": "2025-05-04T09:42:00Z",
"updated_at": "2025-05-04T09:42:00Z",
"remaining_score_runs": 42,
"price": 42.0,
"price_adjustment_note": "string",
"created_by": {
"email": "string",
"organization": {
"org_uuid": "string",
"name": "string"
},
"is_admin": true,
"is_impersonating": true,
"feature_flags": {
"enable_dashboard": true
}
},
"score_run_examples": [
{
"example_uuid": "string",
"question_text": "string",
"answer_text": "string",
"explanation": "string",
"example_type": "pass"
}
],
"pass_rate": 42.0
}
],
"test_type_displays": {
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
Response examples (400)
{
"error": {
"code": "auth.invalid_key",
"message": "string",
"details": {}
},
"request_id": ""
}
Response examples (401)
{
"error": {
"code": "auth.invalid_key",
"message": "string",
"details": {}
},
"request_id": ""
}
Response examples (403)
{
"error": {
"code": "auth.invalid_key",
"message": "string",
"details": {}
},
"request_id": ""
}
Response examples (404)
{
"error": {
"code": "auth.invalid_key",
"message": "string",
"details": {}
},
"request_id": ""
}
Response examples (409)
{
"error": {
"code": "auth.invalid_key",
"message": "string",
"details": {}
},
"request_id": ""
}
Response examples (422)
{
"error": {
"code": "auth.invalid_key",
"message": "string",
"details": {}
},
"request_id": ""
}
Response examples (429)
{
"error": {
"code": "auth.invalid_key",
"message": "string",
"details": {}
},
"request_id": ""
}
Response examples (500)
{
"error": {
"code": "auth.invalid_key",
"message": "string",
"details": {}
},
"request_id": ""
}
Response examples (503)
{
"error": {
"code": "auth.invalid_key",
"message": "string",
"details": {}
},
"request_id": ""
}