---
title: "Check whether a BYOK key is configured for this workspace."
method: GET
path: "/v1/workspace/byok-key/status"
tags: ["workspace"]
---

# Check whether a BYOK key is configured for this workspace.

`GET /v1/workspace/byok-key/status`

## Request

- Base URL: `https://api.andish.ru` (the document declares no server; this is the origin it was published from)
- URL: `https://api.andish.ru/v1/workspace/byok-key/status`
- Auth: none declared

ADR-049: returns is_set + provider type + model — enables the frontend to render the correct UI state per provider without additional fetches. Plaintext key is NEVER returned. Requires 'admin' scope.

## Response `200`

BYOK configuration status. Plaintext never returned.

- ByokKeyStatusResponse: Response for GET /v1/workspace/byok-key/status. ADR-049: expands from {is_set: bool} to include provider type and model so that the frontend can render the correct UI state per provider. Plaintext key is NEVER returned — only presence flag + provider metadata.
  - `is_set` boolean, required: True when a BYOK key (or Ollama config) is configured for this workspace. Plaintext key is never returned by this endpoint.
  - `provider` 'openrouter_byok' | 'polza_byok' | 'ollama_byok', nullable: The configured BYOK provider type. Null when is_set=false. One of: 'openrouter_byok', 'polza_byok', 'ollama_byok'.
  - `model` string, nullable: The model override stored with the BYOK key. Null when is_set=false or no model override was specified. Plaintext key is never returned — only the model identifier.

## Other responses

- `403`: Insufficient scope — requires 'admin'.

---

[API](https://skmtc.dev/andish/apis/mnemo-api.md) · [All operations](https://skmtc.dev/andish/apis/mnemo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/andish/apis/mnemo-api/revisions/d5449f23414c?raw)