Cost Query

POST /cost/query

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"
  ],
  "query": {
    "$expr": {
      "$and": [
        {
          "$literal": "<string>"
        }
      ]
    }
  },
  "sort_by": [
    {
      "field": "<string>"
    }
  ],
  "limit": 10,
  "offset": 0
}
'

import requests

url = "https://api.example.com/cost/query"

payload = {
    "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"],
    "query": { "$expr": { "$and": [{ "$literal": "<string>" }] } },
    "sort_by": [{ "field": "<string>" }],
    "limit": 10,
    "offset": 0
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
    ],
    query: {$expr: {$and: [{$literal: '<string>'}]}},
    sort_by: [{field: '<string>'}],
    limit: 10,
    offset: 0
  })
};

fetch('https://api.example.com/cost/query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/cost/query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ],
    'query' => [
        '$expr' => [
                '$and' => [
                                [
                                                                '$literal' => '<string>'
                                ]
                ]
        ]
    ],
    'sort_by' => [
        [
                'field' => '<string>'
        ]
    ],
    'limit' => 10,
    'offset' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/cost/query"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"fields\": [\n    \"id\",\n    \"llm_id\",\n    \"prompt_token_cost\",\n    \"completion_token_cost\",\n    \"prompt_token_cost_unit\",\n    \"completion_token_cost_unit\",\n    \"effective_date\",\n    \"provider_id\"\n  ],\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"limit\": 10,\n  \"offset\": 0\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/cost/query")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"fields\": [\n    \"id\",\n    \"llm_id\",\n    \"prompt_token_cost\",\n    \"completion_token_cost\",\n    \"prompt_token_cost_unit\",\n    \"completion_token_cost_unit\",\n    \"effective_date\",\n    \"provider_id\"\n  ],\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"limit\": 10,\n  \"offset\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/cost/query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"fields\": [\n    \"id\",\n    \"llm_id\",\n    \"prompt_token_cost\",\n    \"completion_token_cost\",\n    \"prompt_token_cost_unit\",\n    \"completion_token_cost_unit\",\n    \"effective_date\",\n    \"provider_id\"\n  ],\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"limit\": 10,\n  \"offset\": 0\n}"

response = http.request(request)
puts response.read_body

200

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

HTTPBasicHTTPBearer

Authorization · string · header · required

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

Body

application/json

project_id · string · required

Example:

"entity/project"

fields · string[] | null

Example:

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

query · Query · object | null

Show child attributes

sort_by · SortBy · object[] | null

Show child attributes

limit · integer | null

Example:

10

offset · integer | null

Example:

0

Response

200

application/json

Successful Response

results · CostQueryOutput · object[] · required

Show child attributes