v5

OpenAPI 3.1.02026-08-025631,1012.8 MB

Retriever API Keys

List Retriever API Keys

List all API keys for this retriever.

**Fields:**
- key_id: Public identifier for the key
- key_prefix: First 10 characters + "..." for identification (e.g., "ret_sk_abc...")
- name: Human-friendly label
- created_at: When the key was created
- last_used_at: When the key was last used (if ever)
- status: ACTIVE, REVOKED, or EXPIRED
- expires_at: Expiration timestamp (if set)

**Note:**
- Plaintext key is NEVER returned in list responses
- Only shown once in creation response
- Use key_prefix to identify keys in the UI

get/v1/retrievers/{retriever_id}/api-keys

Path parameters

retriever_idstring required

Query parameters

include_revokedboolean

Include revoked and expired keys in the response

Response

Successful Response

totalinteger

Total number of keys (including revoked if requested).

Example response

{
  "results": [
    {
      "created_at": "2025-01-01T00:00:00Z",
      "created_by": "usr_admin",
      "description": "Service account for ingestion",
      "internal_id": "int_x1y2z3",
      "key_hash": "2c26b46b68ffc68ff99b453c1d304134",
      "key_id": "key_a1b2c3d4e5f6g7h",
      "key_prefix": "sk_abc123...",
      "name": "backend-service",
      "organization_id": "org_demo123",
      "permissions": [
        "read",
        "write"
      ],
      "scopes": [],
      "status": "active",
      "user_id": "usr_a1b2c3d4e5f6g7h"
    }
  ]
}