> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/llms.txt.

# Get LLM Provider's ApiKey by id

GET http://localhost:5173/api/v1/private/llm-provider-key/{id}

Get LLM Provider's ApiKey by id

Reference: https://www.comet.com/docs/opik/reference/rest-api/llm-provider-key/get-llm-provider-api-key-by-id

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Path parameters

- `id` (string, required)

## Response

### 200

LLMProviderApiKey resource

- `provider` (enum, required)
  - Allowed values: `openai`, `anthropic`, `gemini`, `openrouter`, `vertex-ai`, `bedrock`, `ollama`, `custom-llm`, `opik-free`
- `id` (string, optional)
- `api_key` (string, optional)
- `name` (string, optional)
- `provider_name` (string, optional) — 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.
- `headers` (map from string to string, optional)
- `configuration` (map from string to string, optional)
- `base_url` (string, optional)
- `auth_config` (ProviderAuthConfig_Public, optional) — 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.
- `created_at` (datetime, optional)
- `created_by` (string, optional)
- `last_updated_at` (datetime, optional)
- `last_updated_by` (string, optional)
- `read_only` (boolean, optional) — If true, this provider is system-managed and cannot be edited or deleted

## Errors

### 404 Not Found Error

Not found

- `code` (integer, optional)
- `message` (string, optional)
- `details` (string, optional)

## Types

### ProviderAuthConfig_Public

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.

- `token_url` (string, optional) — Auth service URL the credentials are sent to
- `send_as` (enum, optional) — 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)
  - Allowed values: `form`, `json`, `basic`
- `credentials` (list of Credential_Public, optional) — Fields sent to the token URL. Values flagged as secret are write-only: they read back as the '__SECRET__' sentinel
- `token_field` (string, optional) — Field holding the token in the reply; dot-path for nested replies
- `expires_field` (string, optional) — Field holding the token lifetime in seconds in the reply; dot-path for nested replies
- `fallback_ttl_seconds` (long, optional) — 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

### Credential_Public

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

- `key` (string, required)
- `value` (string, optional)
- `secret` (boolean, optional) — Secret values are encrypted at rest and never read back; once true it cannot be unset

## Examples

**Response**

```json
{
  "provider": "openai",
  "id": "string",
  "api_key": "string",
  "name": "string",
  "provider_name": "ollama",
  "headers": {},
  "configuration": {},
  "base_url": "string",
  "auth_config": {
    "token_url": "https://developer.api.example.com/authentication/v1/token",
    "send_as": "form",
    "credentials": [
      {
        "key": "string",
        "value": "string",
        "secret": true
      }
    ],
    "token_field": "access_token",
    "expires_field": "expires_in",
    "fallback_ttl_seconds": 1
  },
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "last_updated_by": "string",
  "read_only": true
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/llm-provider-key/id"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/llm-provider-key/id';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5173/api/v1/private/llm-provider-key/id"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/v1/private/llm-provider-key/id")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://localhost:5173/api/v1/private/llm-provider-key/id")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:5173/api/v1/private/llm-provider-key/id');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/llm-provider-key/id");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/llm-provider-key/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```