Set RPM / TPM rate limits on a key

PATCH /v1/keys/{id}/limits

Set RPM / TPM rate limits on a key

cURL

curl --request PATCH \
  --url https://api.example.com/v1/keys/{id}/limits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rpmLimit": 60,
  "tpmLimit": 100000
}
'

import requests

url = "https://api.example.com/v1/keys/{id}/limits"

payload = {
    "rpmLimit": 60,
    "tpmLimit": 100000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({rpmLimit: 60, tpmLimit: 100000})
};

fetch('https://api.example.com/v1/keys/{id}/limits', 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/v1/keys/{id}/limits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'rpmLimit' => 60,
    'tpmLimit' => 100000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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/v1/keys/{id}/limits"

	payload := strings.NewReader("{\n  \"rpmLimit\": 60,\n  \"tpmLimit\": 100000\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://api.example.com/v1/keys/{id}/limits")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rpmLimit\": 60,\n  \"tpmLimit\": 100000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/keys/{id}/limits")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rpmLimit\": 60,\n  \"tpmLimit\": 100000\n}"

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

200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "rpmLimit": 60,
  "tpmLimit": 100000
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Body

application/json

rpmLimit · number | null

Max requests per minute. null or 0 = unlimited.

Example:

60

tpmLimit · number | null

Max tokens per minute. null or 0 = unlimited.

Example:

100000

Response

200

application/json

Updated rate limits

id · string · required

Example:

"550e8400-e29b-41d4-a716-446655440000"

rpmLimit · number | null · required

Example:

60

tpmLimit · number | null · required

Example:

100000