LLM Provider Key Client¶

The LLM Provider Key client provides methods for managing LLM provider API keys in the Opik platform.

class opik.rest_api.llm_provider_key.client.LlmProviderKeyClient(*, client_wrapper: SyncClientWrapper)¶

Bases: object

delete_llm_provider_api_keys_batch(*, ids: Sequence[str], request_options: RequestOptions | None = None) → None¶

Delete LLM Provider’s ApiKeys batch

Parameters:

ids (Sequence[str])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.llm_provider_key.delete_llm_provider_api_keys_batch(ids=[‘ids’], )

find_llm_provider_keys(*, request_options: RequestOptions | None = None) → ProviderApiKeyPagePublic¶

Find LLM Provider’s ApiKeys

Parameters:: request_options (Optional[RequestOptions]) – Request-specific configuration.
Returns:: LLMProviderApiKey resource
Return type:: ProviderApiKeyPagePublic

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.llm_provider_key.find_llm_provider_keys()

store_llm_provider_api_key(*, provider: Literal['openai', 'anthropic', 'gemini', 'openrouter', 'vertex-ai'] | Any, api_key: str, name: str | None = OMIT, headers: Dict[str, str] | None = OMIT, configuration: Dict[str, str] | None = OMIT, base_url: str | None = OMIT, request_options: RequestOptions | None = None) → None¶

Store LLM Provider’s ApiKey

Parameters:

provider (ProviderApiKeyWriteProvider)
api_key (str)
name (Optional[str])
headers (Optional[Dict[str, str]])
configuration (Optional[Dict[str, str]])
base_url (Optional[str])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.llm_provider_key.store_llm_provider_api_key(provider=”openai”, api_key=’api_key’, )

get_llm_provider_api_key_by_id(id: str, *, request_options: RequestOptions | None = None) → ProviderApiKeyPublic¶

Get LLM Provider’s ApiKey by id

Parameters:

id (str)
request_options (Optional[RequestOptions]) – Request-specific configuration.

Returns:

LLMProviderApiKey resource

Return type:

ProviderApiKeyPublic

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.llm_provider_key.get_llm_provider_api_key_by_id(id=’id’, )

update_llm_provider_api_key(id: str, *, api_key: str, name: str | None = OMIT, request_options: RequestOptions | None = None) → None¶

Update LLM Provider’s ApiKey

Parameters:

id (str)
api_key (str)
name (Optional[str])
request_options (Optional[RequestOptions]) – Request-specific configuration.

Return type:

None

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.llm_provider_key.update_llm_provider_api_key(id=’id’, api_key=’api_key’, )

Usage Example¶

import opik

client = opik.Opik()

# Create or update a provider API key
client.rest_client.llm_provider_key.create_or_update_provider_api_key(
    provider="openai",
    api_key="your-api-key"
)

# List provider API keys
keys = client.rest_client.llm_provider_key.get_provider_api_keys(
    page=0,
    size=10
)

# Delete a provider API key
client.rest_client.llm_provider_key.delete_provider_api_key(
    provider="openai"
)