API reference
Health, identity and locations
Liveness, the caller's identity and the active locations.
Start here to find out who a token belongs to (GET /v1/me), which organizations and roles it has, and which locations resources can be created in.
GET /health
Liveness check. No authentication.
Auth: none
Response 200
{
ok: true
}GET /v1/me
The caller: the signed-in user (with organizations and roles), or a platform agent key.
Auth: user access token or platform agent key
Response 200
{
type: "agent"
id: string
orgId: string
scopes: ("platform:admin" | "platform:infra" | "platform:analytics" | "org:read" | "org:write" | "audit:read" | "members:read" | "members:write" | "projects:read" | "projects:write" | "deployments:read" | "deployments:write" | "env:read" | "env:write" | "domains:read" | "domains:write" | "resources:read" | "resources:write" | "git:read" | "git:write" | "logs:read" | "analytics:read" | "knowledge:read" | "knowledge:write" | "connectors:read" | "connectors:write" | "chat:use" | "mcp:connect" | "agents:read" | "agents:write" | "agents:run" | "mail:read" | "mail:send" | "mail:admin" | "calendar:read" | "calendar:write" | "contacts:read" | "contacts:write")[]
name?: string
} | {
userId: string
email: string
name?: string
orgs: {
id: string
slug: string
name?: string
kind: "platform" | "customer"
role: "owner" | "admin" | "developer" | "viewer"
teams?: string[]
}[]
isPlatformAdmin: boolean
type: string
}GET /v1/locations
Active locations, for location pickers. Any authenticated caller.
Auth: user access token or platform agent key
Response 200
{
locations: {
locationId: string
label: string
isDefault: boolean
regions: string[]
region?: string
}[]
}