List virtual keys

Returns the virtual keys the caller can see. A credential that names a project (a project key, or an API key with X-Project-Id) sees the keys scoped to that project, to its team, or to the whole organization. An API key that names no project sees every key in its organization it holds virtualKeys:view on. Newest first, paged by cursor; a page can hold fewer rows than the limit before the walk is done.

GET /api/gateway/v1/virtual-keys

List virtual keys

Python

import requests

url = "https://app.langwatch.ai/api/gateway/v1/virtual-keys"

headers = {"X-Auth-Token": "<api-key>"}

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

print(response.text)

200

{
  "data": [
    {
      "id": "<string>",
      "organization_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "status": "active",
      "purpose": "user",
      "display_prefix": "<string>",
      "principal_user_id": "<string>",
      "trace_project_id": "<string>",
      "trace_project_archived": true,
      "external_id": "<string>",
      "metadata": {},
      "scopes": [
        {
          "scope_type": "organization",
          "scope_id": "<string>"
        }
      ],
      "routing_policy_id": "<string>",
      "routing_mode": "none",
      "config": "<unknown>",
      "revision": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "last_used_at": "2023-11-07T05:31:56Z",
      "revoked_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Query Parameters

cursor · string

Maximum string length: 500

limit · integer · default: 50

Required range: x <= 200

external_id · string

Exact match on the resource's external_id.

Maximum string length: 128

Response

200

application/json

Success

data · object[] · required

Show child attributes

next_cursor · string | null · required

Pass back as cursor for the next page. Null means the walk is exhausted.