workspaces

Check Openai Key Status

Check if workspace has valid OpenAI API key.

Issue #181: OpenAI API key guidance in context creation.

Returns status about whether workspace has an enabled OpenAI API key, and whether current user has permissions to configure it.

Args: workspace_id: Workspace ID request: HTTP request db: Database session

Returns: OpenAIKeyStatusResponse with has_key, can_configure, external_keys_url

Raises: HTTPException 403: User not member of workspace

get/api/v1/workspaces/{workspace_id}/openai-key-status

Request

  • Base URL: https://memory.kagura-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://memory.kagura-ai.com/api/v1/workspaces/{workspace_id}/openai-key-status
  • Auth: none declared

Path parameters

workspace_idstring uuid required

Response

Successful Response

has_keyboolean required

Whether workspace has OpenAI API key

can_configureboolean required

Whether current user can configure keys

external_keys_urlstring required

URL to external keys configuration page

embedding_availableboolean

Whether embeddings can actually be generated for this workspace — own key OR the platform credential. Use this for availability warnings; use has_key only to describe the workspace's own keys.

Changes

No recorded changes to this operation across all 2 revisions of this API.