Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Body

application/json

Parameters required to create a new GatewayConfig.

name
string
required

The human-readable name for the GatewayConfig. Must be unique within your account.

endpoint
string
required

The target endpoint URL (e.g., 'https://api.anthropic.com').

auth_mechanism
object
required

How credentials should be applied to proxied requests. Specify the type ('header', 'bearer') and optional key field.

description
string | null

Optional description for this gateway configuration.

custom_headers
object[] | null

Additional headers applied to proxied requests after the auth mechanism. At most 8 entries.

Response

GatewayConfig created successfully.

A GatewayConfig defines a configuration for proxying API requests through the agent gateway. It specifies the target endpoint and how credentials should be applied.

id
string
required

The unique identifier of the GatewayConfig.

name
string
required

The human-readable name of the GatewayConfig. Unique per account (or globally for system configs).

endpoint
string
required

The target endpoint URL (e.g., 'https://api.anthropic.com').

auth_mechanism
object
required

How credentials should be applied to proxied requests.

create_time_ms
integer<int64>
required

Creation time of the GatewayConfig (Unix timestamp in milliseconds).

account_id
string | null

The account ID that owns this config.

description
string | null

Optional description for this gateway configuration.

custom_headers
object[] | null

Additional headers applied to proxied requests after the auth mechanism. Secret-backed entries reference the secret by 'sec_' id; values are never returned.