Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
API ReferencePricingDashboard
Account

Update the caller's profile

Requires a signed-in dashboard session token; API keys cannot call this endpoint.

PATCH
/v1/me/profile

Authorization

apiKey
AuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/me/profile" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "email": "string",  "fullName": "string",  "avatarUrl": "string",  "defaultOrganizationId": "string"}

The current principal and the org it acts in GET

Returns the calling principal (API key or user session) and the organization the request acts in. For an API key that org is fixed by the key; for a session it is the active org, and availableOrgs lists every org the user belongs to. Unlike /v1/me this works for API keys and does not onboard.

Overview

Organizations and their members. Most resources are scoped to an org.