Read tenant-scoped hosted Model API settlement evidence
GET
/
api
/
v1
/
model-api-usage
Read tenant-scoped hosted Model API settlement evidence
curl --request GET \
--url http://127.0.0.1:18000/api/v1/model-api-usage \
--header 'Authorization: Bearer <token>'import requests
url = "http://127.0.0.1:18000/api/v1/model-api-usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://127.0.0.1:18000/api/v1/model-api-usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://127.0.0.1:18000/api/v1/model-api-usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"bucket_seconds": 43230,
"currency": "USD",
"evidence": {
"available": [
"requests"
],
"content_recorded": false,
"latest_request_at": "2023-11-07T05:31:56Z",
"reconciliation_complete": true,
"request_scope": "funded_supplier_attempts",
"source": "model_api_usage_reservations+model_api_usage_ledger",
"token_usage_complete": true,
"unavailable": [
"errors"
]
},
"models": [
{
"latest_request_at": "2023-11-07T05:31:56Z",
"product_id": "<string>",
"usage": {
"confirmed_no_charge_requests": 1,
"in_flight_requests": 1,
"input_tokens": 1,
"output_tokens": 1,
"pending_reconciliation_requests": 1,
"settled_requests": 1,
"settled_spend_microusd": 1,
"settlement_entries": 1,
"token_usage_samples": 1,
"transmitted_requests": 1
}
}
],
"series": [
{
"started_at": "2023-11-07T05:31:56Z",
"usage": {
"confirmed_no_charge_requests": 1,
"in_flight_requests": 1,
"input_tokens": 1,
"output_tokens": 1,
"pending_reconciliation_requests": 1,
"settled_requests": 1,
"settled_spend_microusd": 1,
"settlement_entries": 1,
"token_usage_samples": 1,
"transmitted_requests": 1
}
}
],
"summary": {
"confirmed_no_charge_requests": 1,
"in_flight_requests": 1,
"input_tokens": 1,
"output_tokens": 1,
"pending_reconciliation_requests": 1,
"settled_requests": 1,
"settled_spend_microusd": 1,
"settlement_entries": 1,
"token_usage_samples": 1,
"transmitted_requests": 1
},
"window_end": "2023-11-07T05:31:56Z",
"window_start": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"category": "<string>",
"remediation": "<string>",
"request_id": "<string>",
"retryable": true
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Lookback window for funded supplier attempts.
Required range:
60 <= x <= 2592000Time-series bucket size; the response is limited to 500 buckets.
Required range:
60 <= x <= 86400Exact public Model API product ID. Omit to include all hosted products for the authenticated tenant.
Maximum string length:
256Response
Success
Required range:
60 <= x <= 86400Allowed value:
"USD"Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum array length:
500Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Read tenant-scoped hosted Model API settlement evidence
curl --request GET \
--url http://127.0.0.1:18000/api/v1/model-api-usage \
--header 'Authorization: Bearer <token>'import requests
url = "http://127.0.0.1:18000/api/v1/model-api-usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://127.0.0.1:18000/api/v1/model-api-usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://127.0.0.1:18000/api/v1/model-api-usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"bucket_seconds": 43230,
"currency": "USD",
"evidence": {
"available": [
"requests"
],
"content_recorded": false,
"latest_request_at": "2023-11-07T05:31:56Z",
"reconciliation_complete": true,
"request_scope": "funded_supplier_attempts",
"source": "model_api_usage_reservations+model_api_usage_ledger",
"token_usage_complete": true,
"unavailable": [
"errors"
]
},
"models": [
{
"latest_request_at": "2023-11-07T05:31:56Z",
"product_id": "<string>",
"usage": {
"confirmed_no_charge_requests": 1,
"in_flight_requests": 1,
"input_tokens": 1,
"output_tokens": 1,
"pending_reconciliation_requests": 1,
"settled_requests": 1,
"settled_spend_microusd": 1,
"settlement_entries": 1,
"token_usage_samples": 1,
"transmitted_requests": 1
}
}
],
"series": [
{
"started_at": "2023-11-07T05:31:56Z",
"usage": {
"confirmed_no_charge_requests": 1,
"in_flight_requests": 1,
"input_tokens": 1,
"output_tokens": 1,
"pending_reconciliation_requests": 1,
"settled_requests": 1,
"settled_spend_microusd": 1,
"settlement_entries": 1,
"token_usage_samples": 1,
"transmitted_requests": 1
}
}
],
"summary": {
"confirmed_no_charge_requests": 1,
"in_flight_requests": 1,
"input_tokens": 1,
"output_tokens": 1,
"pending_reconciliation_requests": 1,
"settled_requests": 1,
"settled_spend_microusd": 1,
"settlement_entries": 1,
"token_usage_samples": 1,
"transmitted_requests": 1
},
"window_end": "2023-11-07T05:31:56Z",
"window_start": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>",
"category": "<string>",
"remediation": "<string>",
"request_id": "<string>",
"retryable": true
}
}