Check Client

The Check client provides methods for checking system status and access in the Opik platform.

class opik.rest_api.check.client.CheckClient(*, client_wrapper: SyncClientWrapper)

Bases: object

access(*, request: Dict[str, Any | None], request_options: RequestOptions | None = None) → None

Check user access to workspace

Parameters:

• request (AuthDetailsHolder)

• 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.check.access(request={‘key’: ‘value’ }, )

get_workspace_name(*, request_options: RequestOptions | None = None) → WorkspaceNameHolder

User’s default workspace name

Parameters:

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

Returns:

Authentication resource

Return type:

WorkspaceNameHolder

Examples

from Opik import OpikApi client = OpikApi(api_key=”YOUR_API_KEY”, workspace_name=”YOUR_WORKSPACE_NAME”, ) client.check.get_workspace_name()

Usage Example

import opik

client = opik.Opik()

# Check access to the workspace
client.rest_client.check.access(request={})

# Get workspace name
workspace_info = client.rest_client.check.get_workspace_name()

# Get bootstrap info
bootstrap_info = client.rest_client.check.bootstrap()