Sign in
AI Gateway Admin

Changed on
patch/ai/providers/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/ai/providers/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Request body

api_keystring nullable

New API key. An empty string removes it, for self-hosted keys only.

base_urlstring nullable

Double-Option: absent = leave unchanged, present-null = clear (revert to the provider's default endpoint), present-value = set. Moving the base URL to another address drops the per-key private-address trust.

default_modelstring nullable

Double-Option: absent = leave unchanged, present-null = clear the pinned model (revert to the per-provider default), present-value = set.

display_namestring nullable
is_activeboolean nullable
trust_private_addressboolean nullable

true trusts the exact private ip:port of the (new) base URL for this key only (requires settings:write); false removes the trust.

Response

Provider key updated

api_key_maskedstring required

Masked API key (only last 4 chars visible)

base_urlstring nullable
created_atstring required
default_modelstring nullable

Model id this provider serves (NULL → per-provider default).

display_namestring required
idinteger required
is_activeboolean required
providerstring required
trusted_private_addressstring nullable

Exact private ip:port this key may reach without that address being in the instance-wide trusted private networks. None when not set.

trusted_private_address_set_atstring nullable

When the per-key trust was set (ISO 8601).

trusted_private_address_set_byinteger nullable

User who set the per-key trust.

updated_atstring required

Changes

  • f8faeee79d2eRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ef9707d8c16eRevision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status