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

Store LLM Provider's ApiKey

POST
/v1/private/llm-provider-key
POST
/api/v1/private/llm-provider-key
$curl -X POST http://localhost:5173/api/v1/private/llm-provider-key \
>     -H "Content-Type: application/json" \
>     -d '{
>  "provider": "openai"
>}'
1{}
Store LLM Provider's ApiKey
Was this page helpful?
Previous

Get LLM Provider's ApiKey by id

Next
Built with

Request

This endpoint expects an object.
providerenumRequired
api_keystringOptional
namestringOptional0-150 characters
provider_namestringOptional0-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 stringsOptional
configurationmap from strings to stringsOptional
base_urlstringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"

Response headers

Locationstring

Response

Created

Errors

401
Unauthorized Error
403
Forbidden Error