Skip to main content
GET
List the values one caller-defined metadata key takes

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id
string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1
x-organization-id
string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Query Parameters

key
string
required

The caller-defined metadata key whose values to list. Same alphabet as on managedAgentsStartSession: letters, digits, '_', '.', and '-', up to 64 characters.

valuePrefix
string

Case-sensitive prefix the returned values must start with, up to 512 characters. Omit to list every value up to limit.

limit
integer
default:50

Most distinct values to return. When more match, truncated is true; narrow valuePrefix rather than asking for more.

Required range: 1 <= x <= 200

Response

OK

items
string[]
required

Distinct values for the selected metadata key across visible sessions, sorted.

truncated
boolean

Whether more values match; narrow the prefix to see them.