Skip to main content
PUT
/
v1
/
gateways
/
{gateway_id}
/
consumers
/
{id}
Update a consumer
curl --request PUT \
  --url https://agentgateway-admin.dev.neuraltrust.ai/v1/gateways/{gateway_id}/consumers/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "fail_mode": "<string>",
  "fallback": {
    "budget": {
      "max_attempts": 123,
      "max_total_latency_ms": 123
    },
    "chain": [
      "<string>"
    ],
    "enabled": true,
    "triggers": [
      "<string>"
    ]
  },
  "headers": {},
  "lb_config": {
    "algorithm": "<string>",
    "embedding_config": {
      "auth": {
        "api_key": "<string>",
        "header_name": "<string>",
        "header_value": "<string>",
        "param_location": "<string>",
        "param_name": "<string>",
        "param_value": "<string>"
      },
      "model": "<string>",
      "provider": "<string>"
    },
    "enabled": true,
    "members": [
      {
        "models": [
          "<string>"
        ],
        "registry_id": "<string>"
      }
    ],
    "pool_alias": "<string>"
  },
  "model_policies": [
    {
      "allowed": [
        "<string>"
      ],
      "default": "<string>",
      "registry_id": "<string>"
    }
  ],
  "name": "<string>",
  "routing_mode": "<string>",
  "toolkit": [
    {
      "expose_as": "<string>",
      "prompt": "<string>",
      "registry_id": "<string>",
      "resource": "<string>",
      "tool": "<string>"
    }
  ],
  "type": "<string>"
}
'
{
  "active": true,
  "auth_ids": [
    "<string>"
  ],
  "created_at": "<string>",
  "fail_mode": "<string>",
  "fallback": {
    "budget": {
      "max_attempts": 123,
      "max_total_latency_ms": 123
    },
    "chain": [
      "<string>"
    ],
    "enabled": true,
    "triggers": [
      "<string>"
    ]
  },
  "gateway_id": "<string>",
  "headers": {},
  "id": "<string>",
  "lb_config": {
    "algorithm": "<string>",
    "embedding_config": {
      "auth": {
        "api_key": "<string>",
        "header_name": "<string>",
        "header_value": "<string>",
        "param_location": "<string>",
        "param_name": "<string>",
        "param_value": "<string>"
      },
      "model": "<string>",
      "provider": "<string>"
    },
    "enabled": true,
    "members": [
      {
        "models": [
          "<string>"
        ],
        "registry_id": "<string>"
      }
    ],
    "pool_alias": "<string>"
  },
  "model_policies": [
    {
      "allowed": [
        "<string>"
      ],
      "default": "<string>",
      "registry_id": "<string>"
    }
  ],
  "name": "<string>",
  "registry_ids": [
    "<string>"
  ],
  "registry_weights": [
    {
      "registry_id": "<string>",
      "weight": 123
    }
  ],
  "role_ids": [
    "<string>"
  ],
  "routing_mode": "<string>",
  "slug": "<string>",
  "toolkit": [
    {
      "expose_as": "<string>",
      "prompt": "<string>",
      "registry_id": "<string>",
      "resource": "<string>",
      "tool": "<string>"
    }
  ],
  "type": "<string>",
  "updated_at": "<string>"
}

Authorizations

Authorization
string
header
required

Path Parameters

gateway_id
string<uuid>
required

Gateway id

id
string<uuid>
required

Consumer id

Body

application/json

Consumer fields to update

active
boolean
fail_mode
string
fallback
object
headers
object
lb_config
object
model_policies
object[]
name
string
routing_mode
string
toolkit
object[]
type
string

Response

OK

active
boolean
auth_ids
string[]
created_at
string
fail_mode
string
fallback
object
gateway_id
string
headers
object
id
string
lb_config
object
model_policies
object[]
name
string
registry_ids
string[]
registry_weights
object[]
role_ids
string[]
routing_mode
string
slug
string
toolkit
object[]
type
string
updated_at
string