For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • POSTDelete LLM Provider's ApiKeys
        • GETFind LLM Provider's ApiKeys
        • POSTStore LLM Provider's ApiKey
        • GETGet LLM Provider's ApiKey by id
        • PATCHUpdate LLM Provider's ApiKey
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceLlm Provider Key

Get LLM Provider's ApiKey by id

GET
/v1/private/llm-provider-key/:id
GET
/api/v1/private/llm-provider-key/:id
$curl http://localhost:5173/api/v1/private/llm-provider-key/id
1{
2  "provider": "openai",
3  "id": "string",
4  "api_key": "string",
5  "name": "string",
6  "provider_name": "ollama",
7  "headers": {},
8  "configuration": {},
9  "base_url": "string",
10  "created_at": "2024-01-15T09:30:00Z",
11  "created_by": "string",
12  "last_updated_at": "2024-01-15T09:30:00Z",
13  "last_updated_by": "string",
14  "read_only": true
15}
Get LLM Provider's ApiKey by id
Was this page helpful?
Previous

Update LLM Provider's ApiKey

Next
Built with

Path parameters

idstringRequiredformat: "uuid"

Response

LLMProviderApiKey resource
providerenum
idstringRead-onlyformat: "uuid"
api_keystring
namestring0-150 characters
provider_namestring0-150 characters

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.

headersmap from strings to strings
configurationmap from strings to strings
base_urlstringformat: "(?s)^\s*(\S.*\S|\S)\s*$"
created_atdatetimeRead-only
created_bystringRead-only
last_updated_atdatetimeRead-only
last_updated_bystringRead-only
read_onlybooleanRead-only

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

Errors

404
Not Found Error