Create gateway token key

Create gateway token key within the authenticated Telnyx account. Foreign and unknown resource IDs return the same 404 response. The token secret is returned only on the original create response. A replay returns metadata without the secret. Provisioning is advisory; ready is not a guarantee of inference availability.

POST /llm_token_gateway/token_keys

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const TokenKey = await client.llmTokenGateway.tokenKeys.create({
  name: 'name',
  token_group_id: 'token_group_id',
  'Idempotency-Key': 'idempotency-key',
});

console.log(TokenKey.data);

200

{
  "data": {
    "record_type": "token_key",
    "id": "11111111-1111-4111-8111-111111111111",
    "created_at": "2026-10-07T08:00:00Z",
    "updated_at": "2026-10-07T08:00:00Z",
    "version": 1,
    "name": "support-backend",
    "token_group_id": "11111111-1111-4111-8111-111111111111",
    "token_user_id": null,
    "max_budget": 1000,
    "budget_duration": "1d",
    "tpm_limit": 10000000,
    "rpm_limit": 6000,
    "allowed_models": null,
    "expires_at": null,
    "blocked": false,
    "required_end_user_id": false,
    "spend": 0,
    "reserved_spend": 0,
    "budget_started_at": null,
    "resets_at": null,
    "max_parallel_requests": 5,
    "provisioning": "ready"
  }
}

Authorizations

Authorization · string · header · required

Management-only Telnyx account credential.

Headers

Idempotency-Key · string · required

24h, scoped by account+method+path. Same key/body returns same outcome; changed body 409; in-progress 409 with Retry-After. Token-create replay returns 200 metadata WITHOUT secret.

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9_-]+$

Body

application/json

name · string · required

Required string length: 1 - 256

Pattern: ^[^\u0000-\u001f\u007f]+$

token_group_id · string<uuid> · required

max_parallel_requests · integer | null

Optional maximum concurrent reserved/dispatched cache misses across replicas. Null means no concurrency cap. Cache hits do not consume slots; unknown usage retains its budget hold without a slot.

Required range: 1 <= x <= 1000

token_user_id · string<uuid> | null

max_budget · number | null

Omitted or null defaults to the maximum (1000 USD) (on a blocked key, null is kept until the key is unblocked); a value below the minimum (0.000001 USD) or above the maximum is rejected with 400 limit_out_of_range; a malformed value (negative, wrong type or precision) is 400 invalid_request. Block the key (blocked: true) to deny it; blocking is always accepted. The default budget is lifetime unless budget_duration is set. Budgets and spend are an enforcement guard computed at one flat placeholder rate for every Telnyx-hosted model (rate_version telnyx-reference-v1: 5 USD per million input and 15 USD per million output tokens), not the customer's bill; Telnyx Inference usage is billed separately at the model's actual price.

Required range: 0.000001 <= x <= 1000Must be a multiple of 0.000001

budget_duration · enum<string> | null

Available options: 1d, 7d, 30d, null

tpm_limit · integer | null

Omitted or null defaults to the maximum (10000000) (on a blocked key, null is kept until the key is unblocked); a value below the minimum (1) or above the maximum is rejected with 400 limit_out_of_range; a malformed value (negative, wrong type or precision) is 400 invalid_request. Block the key (blocked: true) to deny it; blocking is always accepted.

Required range: 1 <= x <= 10000000

rpm_limit · integer | null

Omitted or null defaults to the maximum (6000) (on a blocked key, null is kept until the key is unblocked); a value below the minimum (1) or above the maximum is rejected with 400 limit_out_of_range; a malformed value (negative, wrong type or precision) is 400 invalid_request. Block the key (blocked: true) to deny it; blocking is always accepted.

Required range: 1 <= x <= 6000

allowed_models · string[] | null

Maximum array length: 1000

Required string length: 1 - 256

Pattern: ^[^\u0000-\u001f\u007f]+$

expires_at · string<date-time> | null

blocked · boolean

required_end_user_id · boolean · default: false

Require a nonempty caller-asserted end-user ID; not proof of identity.

Response

200

application/json

Idempotency replay: metadata only; lost create response requires revoke/new create.

data · object · required

Show child attributes