Update LLM Provider's ApiKey | Opik Documentation

PATCH/v1/private/llm-provider-key/{id}Update LLM Provider's ApiKey

Update LLM Provider's ApiKey. api_key and auth_config are mutually exclusive: setting a valid auth_config on a provider that holds a static api_key clears the stored key; send auth_config as an empty object to clear the recipe and switch back to a static key

Parameters

idstring · uuidpathrequired

Request body

application/json

objectProviderApiKeyUpdate

api_keystring

auth_configobject

Dynamic token auth recipe. Send the '__SECRET__' sentinel as a credential value to keep the stored secret; send an empty object to clear the auth config.

Show child attributes

credentialsarray of object

Fields sent to the token URL. Values flagged as secret are write-only: they read back as the '__SECRET__' sentinel

maxItems 20 · minItems 0

Show child attributes

maxItems 20 · minItems 0

Show array items

Fields sent to the token URL. Values flagged as secret are write-only: they read back as the '__SECRET__' sentinel

keystringrequired

maxLength 250 · minLength 0

secretboolean

Secret values are encrypted at rest and never read back; once true it cannot be unset

valuestring

maxLength 2000 · minLength 0

expires_fieldstring

Field holding the token lifetime in seconds in the reply; dot-path for nested replies

maxLength 250 · minLength 0

fallback_ttl_secondsinteger · int64

Lifetime in seconds assumed when the reply doesn't state one, capped at one year; 0 disables caching for such replies. A reply-stated lifetime always wins

maximum 31536000 · minimum 0

send_asstring

How credentials are sent: form body (default), JSON body, or basic auth (id/secret in an HTTP Basic header, remaining fields in the form body)

one of "form", "json", "basic"

token_fieldstring

Field holding the token in the reply; dot-path for nested replies

maxLength 250 · minLength 0

token_urlstring

Auth service URL the credentials are sent to

base_urlstring

configurationobject

headersobject

namestring

maxLength 150 · minLength 0

provider_namestring

Provider name - can be set to migrate legacy custom LLM or Bedrock providers to the new multi-provider format. Once set, it cannot be changed. Should only be set for custom LLM and Bedrock providers.

maxLength 150 · minLength 0

Example request

{
  "api_key": "",
  "auth_config": {
    "credentials": [
      {
        "key": "string",
        "secret": "",
        "value": "string"
      }
    ],
    "expires_field": "expires_in",
    "fallback_ttl_seconds": 0,
    "send_as": "basic",
    "token_field": "access_token",
    "token_url": "https://developer.api.example.com/authentication/v1/token"
  },
  "base_url": "string",
  "configuration": {
    "additionalProp1": "string"
  },
  "headers": {
    "additionalProp1": "string"
  },
  "name": "string",
  "provider_name": "ollama"
}

Responses

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

idrequiredpath parameter

curl -X PATCH 'https://www.comet.com/opik/api/v1/private/llm-provider-key/00000000-0000-0000-0000-000000000000' \
  -H 'Content-Type: application/json' \
  -d '{"api_key":"","auth_config":{"credentials":[{"key":"string","secret":"","value":"string"}],"expires_field":"expires_in","fallback_ttl_seconds":0,"send_as":"basic","token_field":"access_token","token_url":"https://developer.api.example.com/authentication/v1/token"},"base_url":"string","configuration":{"additionalProp1":"string"},"headers":{"additionalProp1":"string"},"name":"string","provider_name":"ollama"}'

const response = await fetch('https://www.comet.com/opik/api/v1/private/llm-provider-key/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"api_key":"","auth_config":{"credentials":[{"key":"string","secret":"","value":"string"}],"expires_field":"expires_in","fallback_ttl_seconds":0,"send_as":"basic","token_field":"access_token","token_url":"https://developer.api.example.com/authentication/v1/token"},"base_url":"string","configuration":{"additionalProp1":"string"},"headers":{"additionalProp1":"string"},"name":"string","provider_name":"ollama"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/llm-provider-key/00000000-0000-0000-0000-000000000000', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"api_key\":[REDACTED]" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://www.comet.com/opik/api/v1/private/llm-provider-key/00000000-0000-0000-0000-000000000000",
    headers={"Content-Type": "application/json"},
    data='{"api_key":"","auth_config":{"credentials":[{"key":"string","secret":"","value":"string"}],"expires_field":"expires_in","fallback_ttl_seconds":0,"send_as":"basic","token_field":"access_token","token_url":"https://developer.api.example.com/authentication/v1/token"},"base_url":"string","configuration":{"additionalProp1":"string"},"headers":{"additionalProp1":"string"},"name":"string","provider_name":"ollama"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"api_key":"","auth_config":{"credentials":[{"key":"string","secret":"","value":"string"}],"expires_field":"expires_in","fallback_ttl_seconds":0,"send_as":"basic","token_field":"access_token","token_url":"https://developer.api.example.com/authentication/v1/token"},"base_url":"string","configuration":{"additionalProp1":"string"},"headers":{"additionalProp1":"string"},"name":"string","provider_name":"ollama"}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://www.comet.com/opik/api/v1/private/llm-provider-key/00000000-0000-0000-0000-000000000000", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/llm-provider-key/00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"api_key\":[REDACTED]");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/llm-provider-key/00000000-0000-0000-0000-000000000000"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"api_key\":[REDACTED]"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://www.comet.com/opik/api/v1/private/llm-provider-key/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"api_key\":\"\",\"auth_config\":{\"credentials\":[{\"key\":\"string\",\"secret\":\"\",\"value\":\"string\"}],\"expires_field\":\"expires_in\",\"fallback_ttl_seconds\":0,\"send_as\":\"basic\",\"token_field\":\"access_token\",\"token_url\":\"https://developer.api.example.com/authentication/v1/token\"},\"base_url\":\"string\",\"configuration\":{\"additionalProp1\":\"string\"},\"headers\":{\"additionalProp1\":\"string\"},\"name\":\"string\",\"provider_name\":\"ollama\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://www.comet.com/opik/api/v1/private/llm-provider-key/00000000-0000-0000-0000-000000000000");
request.Content = new StringContent("{\"api_key\":\"\",\"auth_config\":{\"credentials\":[{\"key\":\"string\",\"secret\":\"\",\"value\":\"string\"}],\"expires_field\":\"expires_in\",\"fallback_ttl_seconds\":0,\"send_as\":\"basic\",\"token_field\":\"access_token\",\"token_url\":\"https://developer.api.example.com/authentication/v1/token\"},\"base_url\":\"string\",\"configuration\":{\"additionalProp1\":\"string\"},\"headers\":{\"additionalProp1\":\"string\"},\"name\":\"string\",\"provider_name\":\"ollama\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}