gateway-policies

Get a gateway policy

Changed on

Returns a single gateway policy by id. Cross-org access is rejected with 404

Spend tracking: spend-cap policies include current_spend_usd for the active window so callers can read per-policy cost without hitting a separate endpoint. Guard policies leave it null.

get/api/v1/platform/gateway-policies/{id}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/platform/gateway-policies/{id}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

idstring uuid required

Policy ID

Response

OK

actionstring
configobject
created_atstring
created_bystring
current_spend_usdnumber

CurrentSpendUSD is the spend in the policy's current window. Set for any spend_cap policy regardless of enabled state — disabled policies still surface usage so users can see what would have been counted. Nil for non-spend_cap policies or when the spend lookup failed.

descriptionstring
enabledboolean
idstring
is_system_generatedboolean
namestring
organization_idstring
parent_policy_idstring

ParentPolicyID is set on materialized children of a default_spend_cap to the default's id. An explicit Update or a Create with the same matchers clears the link and takes ownership of the materialized row. Delete on the parent cascade-soft-deletes children still attached.

policy_typestring
priorityinteger
updated_atstring

Changes