Update LLM credentials

patch

{protocol}://{base-url}/ai/api/v1/llm_credentials/{llm_credentials_id}

Update LLM credentials.

Path Params

llm_credentials_id

string

required

The ID of the LLM Credentials to use.

Body Params

Schema for updating an llm credentials object.

Note: The creds_type field cannot be changed after creation. To use a different
credentials type, delete the existing credentials and create a new one.

All fields are optional. Only provided fields will be updated.
Set a field to null to clear its value.

name

Display name for this credentials.

provider

LLMProvider | null

The LLM provider these credentials authenticate against.

api_key

API key for LLM providers.

base_url

Custom base URL for OpenAI-compatible providers.

aws_access_key_id

AWS access key ID.

aws_secret_access_key

AWS secret access key.

aws_session_token

AWS session token.

aws_region

AWS region for Bedrock.

azure_endpoint

Azure OpenAI endpoint URL.

api_version

Azure API version.

azure_client_id

Azure AD client ID.

azure_client_secret

Azure AD client secret.

azure_token_url

Azure AD token URL.

gcp_project

Google Cloud project ID.

gcp_location

Google Cloud location.

gcp_service_account

object | null

GCP service account JSON credentials.

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200Successful Response

401Authentication required. No valid session cookie or bearer token provided, or authentication failed.

404Resource not found. The detail field specifies which resource.

422Validation Error

500Internal server error during request processing.