Get an API key

Read one API key by id, including its role bindings, permission mode and explicit permissions. Returns your own keys; organization admins may read any key in the organization. The secret is never returned. An id that does not exist, belongs to another organization, or belongs to another member all answer 404 api_key_not_found, so the response cannot be used to probe for keys.

GET /api/v1/api-keys/{id}

Get an API key

Python

import requests

url = "https://app.langwatch.ai/api/v1/api-keys/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z",
  "roleBindings": [
    {
      "id": "<string>",
      "role": "ADMIN",
      "scopeType": "ORGANIZATION",
      "scopeId": "<string>"
    }
  ],
  "keyType": "personal",
  "assignedToUserId": "<string>",
  "createdByUserId": "<string>",
  "permissionMode": "<string>",
  "permissions": [
    "<string>"
  ],
  "bindings": [
    {
      "role": "ADMIN",
      "scopeType": "ORGANIZATION",
      "scopeId": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Admin API key for organization-level operations (managing projects, API keys). Create one in Settings > API Keys or via POST /api/api-keys. Format: sk-lw-{id}_{secret}.

Path Parameters

id · string · required

Minimum string length: 1

Response

200

application/json

Success

id · string · required

Minimum string length: 1

name · string · required

description · string | null · required

createdAt · string<date-time> · required

expiresAt · string<date-time> | null · required

lastUsedAt · string<date-time> | null · required

revokedAt · string<date-time> | null · required

roleBindings · object[] · required

Show child attributes

keyType · enum<string> · required

Available options: personal, service

assignedToUserId · string | null · required

createdByUserId · string | null · required

permissionMode · string · required

permissions · string[] · required

Pattern: ^[a-z][a-zA-Z0-9_-]*:[a-z][a-zA-Z0-9_-]*$

bindings · object[] · required

Show child attributes