Skip to main content
GET
/
v1
/
flex
/
key
Limits and remaining credit for the calling key
curl --request GET \
  --url https://tokens.flex.ai/v1/flex/key \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://tokens.flex.ai/v1/flex/key"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://tokens.flex.ai/v1/flex/key', 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://tokens.flex.ai/v1/flex/key",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://tokens.flex.ai/v1/flex/key"

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))

}
HttpResponse<String> response = Unirest.get("https://tokens.flex.ai/v1/flex/key")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://tokens.flex.ai/v1/flex/key")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "object": "key",
  "currency": "USD",
  "key_name": "<string>",
  "spend_usd": 123,
  "max_budget_usd": 123,
  "remaining_budget_usd": 123,
  "rate_limit": {
    "rpm": 123,
    "tpm": 123
  },
  "expires_at": "2023-11-07T05:31:56Z",
  "generated_at": "2023-11-07T05:31:56Z"
}
{
"error": {
"message": "<string>",
"type": "invalid_request_error",
"code": "<string>",
"doc_url": "<string>"
}
}
{
"error": {
"message": "<string>",
"type": "invalid_request_error",
"code": "<string>",
"doc_url": "<string>"
}
}
{
"error": {
"message": "<string>",
"type": "invalid_request_error",
"code": "<string>",
"doc_url": "<string>"
}
}
{
"error": {
"message": "<string>",
"type": "invalid_request_error",
"code": "<string>",
"doc_url": "<string>"
}
}

Authorizations

Authorization
string
header
required

Virtual API key. Create one from the FlexAI dashboard. Pass as Authorization: Bearer sk-xxxx.

Response

Successful response

object
enum<string>
required
Available options:
key
currency
enum<string>
required
Available options:
USD
key_name
string | null
required

Masked display name ("sk-...abcd"); never the full key.

spend_usd
number
required
max_budget_usd
number | null
required

Budget ceiling for this key; null when no per-key ceiling is configured.

remaining_budget_usd
number | null
required

max_budget_usd - spend_usd, floored at 0; null when max_budget_usd is null.

rate_limit
object
required
expires_at
string<date-time> | null
required

When this key expires; null means it never expires.

generated_at
string<date-time>
required