コストクエリ

POST /cost/query

コストクエリ

cURL

curl --request POST \
  --url https://api.example.com/cost/query \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "fields": [
    "id",
    "llm_id",
    "prompt_token_cost",
    "completion_token_cost",
    "prompt_token_cost_unit",
    "completion_token_cost_unit",
    "effective_date",
    "provider_id"
  ],
  "limit": 10,
  "offset": 0,
  "query": {
    "$expr": {
      "$and": [
        {
          "$literal": "<string>"
        }
      ]
    }
  },
  "sort_by": [
    {
      "field": "<string>"
    }
  ]
}
'

200

{
  "results": [
    {
      "completion_token_cost": 1,
      "completion_token_cost_unit": "USD",
      "effective_date": "2024-01-01T00:00:00Z",
      "id": "2341-asdf-asdf",
      "llm_id": "gpt4",
      "prompt_token_cost": 1,
      "prompt_token_cost_unit": "USD",
      "provider_id": "openai"
    }
  ]
}

承認

Authorization · string · header · 必須

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

ボディ

application/json

project_id · string · 必須

例:

"entity/project"

fields · string[] | null

例:

[
  "id",
  "llm_id",
  "prompt_token_cost",
  "completion_token_cost",
  "prompt_token_cost_unit",
  "completion_token_cost_unit",
  "effective_date",
  "provider_id"
]

limit · integer | null

例:

10

offset · integer | null

例:

0

query · Query · object

Show child attributes

sort_by · SortBy · object[] | null

Show child attributes

レスポンス

200

application/json

正常なレスポンス

results · CostQueryOutput · object[] · 必須

Show child attributes