API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

AI Gateway

List gateways

client.AIGateway.List(ctx, params) (*V4PagePaginationArray[AIGatewayListResponse], error)

GET/accounts/{account_id}/ai-gateway/gateways

Get a gateway

client.AIGateway.Get(ctx, id, query) (*AIGatewayGetResponse, error)

GET/accounts/{account_id}/ai-gateway/gateways/{id}

Create a gateway

client.AIGateway.New(ctx, params) (*AIGatewayNewResponse, error)

POST/accounts/{account_id}/ai-gateway/gateways

Update a gateway

client.AIGateway.Update(ctx, id, params) (*AIGatewayUpdateResponse, error)

PUT/accounts/{account_id}/ai-gateway/gateways/{id}

Delete a gateway

client.AIGateway.Delete(ctx, id, body) (*AIGatewayDeleteResponse, error)

DELETE/accounts/{account_id}/ai-gateway/gateways/{id}

AI GatewayEvaluation Types

List evaluator types (deprecated)

client.AIGateway.EvaluationTypes.List(ctx, params) (*V4PagePaginationArray[EvaluationTypeListResponse], error)

GET/accounts/{account_id}/ai-gateway/evaluation-types

AI GatewayCustom Providers

List custom providers

client.AIGateway.CustomProviders.List(ctx, params) (*V4PagePaginationArray[CustomProviderListResponse], error)

GET/accounts/{account_id}/ai-gateway/custom-providers

Get a custom provider

client.AIGateway.CustomProviders.Get(ctx, id, query) (*CustomProviderGetResponse, error)

GET/accounts/{account_id}/ai-gateway/custom-providers/{id}

Create a custom provider

client.AIGateway.CustomProviders.New(ctx, params) (*CustomProviderNewResponse, error)

POST/accounts/{account_id}/ai-gateway/custom-providers

Delete a custom provider

client.AIGateway.CustomProviders.Delete(ctx, id, body) (*CustomProviderDeleteResponse, error)

DELETE/accounts/{account_id}/ai-gateway/custom-providers/{id}

AI GatewayLogs

List Gateway Logs

client.AIGateway.Logs.List(ctx, gatewayID, params) (*V4PagePaginationArray[LogListResponse], error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs

Get Gateway Log Detail

client.AIGateway.Logs.Get(ctx, gatewayID, id, query) (*LogGetResponse, error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}

Patch Gateway Log

client.AIGateway.Logs.Edit(ctx, gatewayID, id, params) (*LogEditResponse, error)

PATCH/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}

Delete Gateway Logs

client.AIGateway.Logs.Delete(ctx, gatewayID, params) (*LogDeleteResponse, error)

DELETE/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs

Get Gateway Log Request

client.AIGateway.Logs.Request(ctx, gatewayID, id, query) (*LogRequestResponse, error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}/request

Get Gateway Log Response

client.AIGateway.Logs.Response(ctx, gatewayID, id, query) (*LogResponseResponse, error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}/response

AI GatewayDatasets

List datasets (deprecated)

client.AIGateway.Datasets.List(ctx, gatewayID, params) (*V4PagePaginationArray[DatasetListResponse], error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets

Get a dataset (deprecated)

client.AIGateway.Datasets.Get(ctx, gatewayID, id, query) (*DatasetGetResponse, error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets/{id}

Create a dataset (deprecated)

client.AIGateway.Datasets.New(ctx, gatewayID, params) (*DatasetNewResponse, error)

POST/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets

Update a dataset (deprecated)

client.AIGateway.Datasets.Update(ctx, gatewayID, id, params) (*DatasetUpdateResponse, error)

PUT/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets/{id}

Delete a dataset (deprecated)

client.AIGateway.Datasets.Delete(ctx, gatewayID, id, body) (*DatasetDeleteResponse, error)

DELETE/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/datasets/{id}

AI GatewayEvaluations

List evaluations (deprecated)

client.AIGateway.Evaluations.List(ctx, gatewayID, params) (*V4PagePaginationArray[EvaluationListResponse], error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations

Get an evaluation (deprecated)

client.AIGateway.Evaluations.Get(ctx, gatewayID, id, query) (*EvaluationGetResponse, error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations/{id}

Create an evaluation (deprecated)

client.AIGateway.Evaluations.New(ctx, gatewayID, params) (*EvaluationNewResponse, error)

POST/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations

Delete an evaluation (deprecated)

client.AIGateway.Evaluations.Delete(ctx, gatewayID, id, body) (*EvaluationDeleteResponse, error)

DELETE/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/evaluations/{id}

AI GatewayDynamic Routing

List dynamic routes

client.AIGateway.DynamicRouting.List(ctx, gatewayID, params) (*DynamicRoutingListResponse, error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes

Get a dynamic route

client.AIGateway.DynamicRouting.Get(ctx, gatewayID, id, query) (*DynamicRoutingGetResponse, error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}

Create a dynamic route

client.AIGateway.DynamicRouting.New(ctx, gatewayID, params) (*DynamicRoutingNewResponse, error)

POST/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes

Rename a dynamic route

client.AIGateway.DynamicRouting.Update(ctx, gatewayID, id, params) (*DynamicRoutingUpdateResponse, error)

PATCH/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}

Delete a dynamic route

client.AIGateway.DynamicRouting.Delete(ctx, gatewayID, id, body) (*DynamicRoutingDeleteResponse, error)

DELETE/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}

List dynamic route deployments

client.AIGateway.DynamicRouting.ListDeployments(ctx, gatewayID, id, query) (*DynamicRoutingListDeploymentsResponse, error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/deployments

Deploy a dynamic route version

client.AIGateway.DynamicRouting.NewDeployment(ctx, gatewayID, id, params) (*DynamicRoutingNewDeploymentResponse, error)

POST/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/deployments

List dynamic route versions

client.AIGateway.DynamicRouting.ListVersions(ctx, gatewayID, id, query) (*DynamicRoutingListVersionsResponse, error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions

Create a dynamic route version

client.AIGateway.DynamicRouting.NewVersion(ctx, gatewayID, id, params) (*DynamicRoutingNewVersionResponse, error)

POST/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions

Get a dynamic route version

client.AIGateway.DynamicRouting.GetVersion(ctx, gatewayID, id, versionID, query) (*DynamicRoutingGetVersionResponse, error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions/{version_id}

AI GatewayProvider Configs

List provider keys

client.AIGateway.ProviderConfigs.List(ctx, gatewayID, params) (*V4PagePaginationArray[ProviderConfigListResponse], error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs

Store a provider key

client.AIGateway.ProviderConfigs.New(ctx, gatewayID, params) (*ProviderConfigNewResponse, error)

POST/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/provider_configs

AI GatewayURLs

Get Gateway URL

client.AIGateway.URLs.Get(ctx, gatewayID, provider, query) (*string, error)

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/url/{provider}

AI GatewayBilling

Get credit balance

client.AIGateway.Billing.CreditBalance(ctx, query) (*BillingCreditBalanceResponse, error)

GET/accounts/{account_id}/ai-gateway/billing/credit-balance

Get usage history

client.AIGateway.Billing.UsageHistory(ctx, params) (*BillingUsageHistoryResponse, error)

GET/accounts/{account_id}/ai-gateway/billing/usage-history

Get invoice history

client.AIGateway.Billing.InvoiceHistory(ctx, params) (*BillingInvoiceHistoryResponse, error)

GET/accounts/{account_id}/ai-gateway/billing/invoice-history

Get invoice preview

client.AIGateway.Billing.InvoicePreview(ctx, query) (*BillingInvoicePreviewResponse, error)

GET/accounts/{account_id}/ai-gateway/billing/invoice-preview

AI GatewayBillingTopup

Create a top-up

client.AIGateway.Billing.Topup.New(ctx, params) (*BillingTopupNewResponse, error)

POST/accounts/{account_id}/ai-gateway/billing/topup

Check top-up status

client.AIGateway.Billing.Topup.Status(ctx, params) (*BillingTopupStatusResponse, error)

POST/accounts/{account_id}/ai-gateway/billing/topup/status

AI GatewayBillingTopupConfig

Get auto top-up configuration

client.AIGateway.Billing.Topup.Config.Get(ctx, query) (*BillingTopupConfigGetResponse, error)

GET/accounts/{account_id}/ai-gateway/billing/topup/config

Set auto top-up configuration

client.AIGateway.Billing.Topup.Config.New(ctx, params) (*BillingTopupConfigNewResponse, error)

POST/accounts/{account_id}/ai-gateway/billing/topup/config

Delete auto top-up configuration

client.AIGateway.Billing.Topup.Config.Delete(ctx, body) (*BillingTopupConfigDeleteResponse, error)

DELETE/accounts/{account_id}/ai-gateway/billing/topup/config

AI GatewayBillingSpending Limit

Get spending limit (deprecated)

client.AIGateway.Billing.SpendingLimit.Get(ctx, query) (*BillingSpendingLimitGetResponse, error)

GET/accounts/{account_id}/ai-gateway/billing/spending-limit

Set spending limit (deprecated)

Deprecated

client.AIGateway.Billing.SpendingLimit.New(ctx, params) (*BillingSpendingLimitNewResponse, error)

POST/accounts/{account_id}/ai-gateway/billing/spending-limit

Delete spending limit (deprecated)

client.AIGateway.Billing.SpendingLimit.Delete(ctx, body) (*BillingSpendingLimitDeleteResponse, error)

DELETE/accounts/{account_id}/ai-gateway/billing/spending-limit