cURL
curl --request GET \
--url "https://api.rafflesia.ai/v1/models/usage?timezone=UTC&bound_to_timeframe=true&expand=["time_series"]" \
--header "Authorization: Bearer $RAFFLESIA_API_KEY"{
"has_more": true,
"next_cursor": "<string>",
"$schema": "https://example.com/schemas/ModelUsage.json",
"summary": [
{
"cost": 1,
"cost_discount": 1,
"cost_subtotal": 1,
"cost_total": 1,
"currency": "<string>",
"endpoint_id": "<string>",
"percent_discount": 50,
"quantity": 1,
"unit": "<string>",
"unit_price": 1,
"auth_method": "<string>",
"auth_method_structured": {
"detail": "<string>",
"api_key_id": "<string>",
"login_username": "<string>"
}
}
],
"time_series": [
{
"bucket": "<string>",
"results": [
{
"cost": 1,
"cost_discount": 1,
"cost_subtotal": 1,
"cost_total": 1,
"currency": "<string>",
"endpoint_id": "<string>",
"percent_discount": 50,
"quantity": 1,
"unit": "<string>",
"unit_price": 1,
"auth_method": "<string>",
"auth_method_structured": {
"detail": "<string>",
"api_key_id": "<string>",
"login_username": "<string>"
}
}
]
}
]
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}Returns time-series and summary usage grouped by endpoint price, discount, and optional authentication identity.
GET
/
v1
/
models
/
usage
cURL
curl --request GET \
--url "https://api.rafflesia.ai/v1/models/usage?timezone=UTC&bound_to_timeframe=true&expand=["time_series"]" \
--header "Authorization: Bearer $RAFFLESIA_API_KEY"{
"has_more": true,
"next_cursor": "<string>",
"$schema": "https://example.com/schemas/ModelUsage.json",
"summary": [
{
"cost": 1,
"cost_discount": 1,
"cost_subtotal": 1,
"cost_total": 1,
"currency": "<string>",
"endpoint_id": "<string>",
"percent_discount": 50,
"quantity": 1,
"unit": "<string>",
"unit_price": 1,
"auth_method": "<string>",
"auth_method_structured": {
"detail": "<string>",
"api_key_id": "<string>",
"login_username": "<string>"
}
}
],
"time_series": [
{
"bucket": "<string>",
"results": [
{
"cost": 1,
"cost_discount": 1,
"cost_subtotal": 1,
"cost_total": 1,
"currency": "<string>",
"endpoint_id": "<string>",
"percent_discount": 50,
"quantity": 1,
"unit": "<string>",
"unit_price": 1,
"auth_method": "<string>",
"auth_method_structured": {
"detail": "<string>",
"api_key_id": "<string>",
"login_username": "<string>"
}
}
]
}
]
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}{
"ok": true,
"provenance": {
"created_at": "<string>",
"operation": "<string>",
"request_id": "<string>",
"server_version": "<string>",
"cache_hit": true,
"database_snapshots": [
{
"name": "<string>",
"version": "<string>",
"digest": "<string>",
"kind": "<string>"
}
],
"generated_object_ids": [
"<string>"
],
"input_hash": "<string>",
"parameters_hash": "<string>",
"tool_versions": [
{
"name": "<string>",
"version": "<string>",
"path": "<string>"
}
]
},
"warnings": [
{
"code": "<string>",
"message": "<string>",
"details": {}
}
],
"$schema": "https://example.com/schemas/ExecutionEnvelopeExecutionErrorData.json",
"data": {},
"error": {
"code": "<string>",
"doc_url": "<string>",
"is_retryable": true,
"message": "<string>",
"type": "invalid_request_error",
"details": {},
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"url": "<string>",
"ctx": {},
"input": "<unknown>"
}
],
"param": "<string>",
"request_id": "<string>"
},
"evidence": {
"warnings_count": 123,
"duration_ms": 123,
"input_refs": [
"<string>"
],
"object_refs": [
"<string>"
],
"output_refs": [
"<string>"
],
"row_count": 123
}
}Authorizations
A Rafflesia API key, sent as Authorization: Bearer <key>.
Query Parameters
Maximum number of items to return. The actual maximum depends on query type and expansions.
Required range:
x >= 1Example:
50
Pagination cursor from the previous response. Encodes the page number.
Example:
"Mg=="
Start date in ISO8601 format (for example, '2025-01-01T00:00:00Z' or '2025-01-01'). Defaults to 24 hours ago.
Example:
"2025-01-01T00:00:00Z"
Exclusive end date in ISO8601 format (for example, '2025-02-01T00:00:00Z' or '2025-02-01'). Defaults to the current time.
Example:
"2025-02-01T00:00:00Z"
Timezone used for date aggregation and boundaries. Response timestamps are UTC.
Example:
"UTC"
Aggregation timeframe for time-series data. When omitted it is selected from the date span: minute below 2 hours, hour below 2 days, day below 64 days, week below 183 days, otherwise month.
Available options:
minute, hour, day, week, month Example:
"day"
Whether to align start and exclusive end to timeframe boundaries. Set false to use the exact dates supplied.
Available options:
true, false Example:
"true"
Filter by 1-50 endpoint IDs. Accepts repeated or comma-separated values.
Example:
["rafflesia/homology"]
Filter by 1-50 API key IDs. Accepts repeated or comma-separated values.
Example:
["key_abc123"]
Filter by 1-50 team-member login usernames. Accepts repeated or comma-separated values.
Example:
["alice"]
Data to include. At least one of time_series or summary is required; auth_method and auth_method_structured add authentication attribution.
Example:
["time_series", "auth_method"]
Response
OK
Whether more results are available; derived from next_cursor.
Cursor for the next page of results, or null when there are no more pages.
A URL to the JSON Schema for this object.
Example:
"https://example.com/schemas/ModelUsage.json"
Aggregate statistics when expand includes 'summary'.
Show child attributes
Show child attributes
Time-series usage grouped by bucket when expand includes 'time_series'.
Show child attributes
Show child attributes
⌘I