Edit an LLM provider

Replace an LLM provider. Sending a blank credential keeps the stored one; sending a nonblank credential rotates it.

PUT /llmProvider/{llmProviderId}

Edit an LLM provider

cURL

curl --request PUT \
  --url https://api.qovery.com/llmProvider/{llmProviderId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "",
  "credential": "",
  "region": "eu-west-1"
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "type": "CLAUDE",
  "has_credential": true,
  "scope": "ORGANIZATION",
  "owner_user_sub": "<string>",
  "owner_name": "<string>",
  "region": "<string>"
}

Authorizations

bearerAuthApiKeyAuth

Authorization · string · header · required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

llmProviderId · string<uuid> · required

LLM Provider ID

Body

application/json

name · string · required

LLM provider name, unique per scope owner within the organization

Minimum string length: 1

type · enum<string> · required

The LLM vendor this provider authenticates against. Matches the type an agentic workflow's inline model already uses.

Available options: CLAUDE, BEDROCK

description · string · default: ""

credential · string · default: "" · write-only

The provider credential. Encrypted at rest and never returned by the API. Blank means unchanged: on create no credential is stored, on edit the stored one is kept. Sending a nonblank value rotates it.

scope · enum<string>

Cannot be changed after creation. On create, omitting it means ORGANIZATION, which requires the MANAGE_INFRASTRUCTURE permission; creating a USER provider requires CREATE_PROJECT. On edit, omitting it leaves the provider's scope unchanged, and stating a scope that differs from the provider's is refused with 400.

Available options: ORGANIZATION, USER

region · string | null

On edit, omitting it or sending null clears the stored region. This differs from credential, where a blank value keeps the stored one. AWS region the Bedrock client calls, for example us-east-1 or eu-west-1; model availability differs by region. Only allowed for a BEDROCK provider. Any sent string, blank included, must match the pattern. Null keeps the engine default region.

Pattern: ^[a-z]{2}(-gov)?-[a-z]+-[0-9]+$

Example:

"eu-west-1"

Response

200

application/json

LLM provider edited

id · string<uuid> · required · read-only

created_at · string<date-time> · required · read-only

updated_at · string<date-time> · required · read-only

name · string · required

description · string · required

type · enum<string> · required

The LLM vendor this provider authenticates against. Matches the type an agentic workflow's inline model already uses.

Available options: CLAUDE, BEDROCK

has_credential · boolean · required

Whether a credential is stored. The credential itself is never returned.

scope · enum<string> · required

ORGANIZATION: usable by every member who can edit an agentic workflow. USER: personal to the member who created it; only that member can edit it.

Available options: ORGANIZATION, USER

owner_user_sub · string | null

Identity of the owning member. Null for an ORGANIZATION provider.

owner_name · string | null

Display name of the owning member. Null for an ORGANIZATION provider.

region · string | null

AWS region of a BEDROCK provider. Null when unset or for CLAUDE.