Find LLM Provider's ApiKeys | Opik Documentation

GET/v1/private/llm-provider-keyFind LLM Provider's ApiKeys

Find LLM Provider's ApiKeys

Responses

objectProviderApiKeyPage_Public

contentarray of object

Show child attributes

Show array items

api_keystring

auth_configobject

Dynamic token auth recipe. When set, Opik fetches a short-lived bearer from the configured auth service instead of using a static api_key. Only supported for custom providers. Secret credential values read back masked.

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

pattern (?s)^\s*(\S.*\S|\S)\s*$

configurationobject

created_atstring · date-time

created_bystring

headersobject

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

namestring

maxLength 150 · minLength 0

providerstringrequired

one of "openai", "anthropic", "gemini", "openrouter", "vertex-ai", "bedrock", "ollama", "custom-llm", "opik-free"

provider_namestring

Provider name - required for custom LLM and Bedrock providers to uniquely identify them (e.g., 'ollama', 'vllm', 'Bedrock us-east-1'). Must not be blank for custom and Bedrock providers. Should not be set for standard providers (OpenAI, Anthropic, etc.). This requirement is conditional and validation is enforced programmatically.

maxLength 150 · minLength 0

read_onlyboolean

If true, this provider is system-managed and cannot be edited or deleted

sizeinteger · int32

sortableByarray of string

Show child attributes

totalinteger · int64

Example response

{
  "content": [
    {
      "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"
      },
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "headers": {
        "additionalProp1": "string"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "name": "string",
      "provider": "anthropic",
      "provider_name": "ollama",
      "read_only": true
    }
  ],
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}

Examples

curl -X GET 'http://localhost:5173/api/v1/private/llm-provider-key'

const response = await fetch('http://localhost:5173/api/v1/private/llm-provider-key', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/llm-provider-key', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/llm-provider-key")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "http://localhost:5173/api/v1/private/llm-provider-key", nil)
	if err != nil {
		panic(err)
	}
	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");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/llm-provider-key"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/llm-provider-key")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
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.Get, "http://localhost:5173/api/v1/private/llm-provider-key");
using var response = await client.SendAsync(request);

{
  "content": [
    {
      "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"
      },
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "headers": {
        "additionalProp1": "string"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "name": "string",
      "provider": "anthropic",
      "provider_name": "ollama",
      "read_only": true
    }
  ],
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}