How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenRelay Account API

The signed-in user: profile, memberships, and first-time onboarding.

OpenRelay Account API is one of 19 APIs that OpenRelay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 7 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against 3 base URLs: https://api.openrelay.inc, https://api.beta.openrelay.inc, http://localhost:8083.

7 operations 7 paths 11 schemas 3 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.openrelay.inc
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

OpenRelay Account API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiKey).

  • apiKey — OpenRelay API key. Send it as Authorization: Bearer vl….

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 3 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Account 7

The signed-in user: profile, memberships, and first-time onboarding.

GET
/v1/me
Current user profile and org memberships
getMe → 200401
GET
/v1/me/invites
Pending org invites addressed to the signed-in user's email
listMyInvites → 200401
POST
/v1/me/invites/{orgId}/accept
Accept a pending org invite (session only)
acceptOrgInvite 1 param → 200401404409410
POST
/v1/me/invites/{orgId}/decline
Decline a pending org invite (session only)
declineOrgInvite 1 param → 204401
PATCH
/v1/me/profile
Update the caller's profile
updateProfile body → 200401403
POST
/v1/onboarding/bootstrap
Create the caller's profile and first org (idempotent)
bootstrap body → 200401
GET
/v1/whoami
The current principal and the org it acts in
whoami → 200401

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Whoami (8 properties), MyInvite (6 properties), UserProfile (5 properties), OrgMembership (4 properties). Each schema is shown below with its type and property counts.

AcceptInviteResult
object
2 properties 2 required
Whoami
object
8 properties 2 required
OrgMembership
object
4 properties 4 required
UserProfile
object
5 properties 2 required
UpdateProfileRequest
object
3 properties
Me
object
2 properties 2 required
BootstrapResult
object
2 properties 2 required
Error
object
2 properties 1 required
BootstrapRequest
object
1 property
MyInvite
object
6 properties 3 required
OrgFeatures
object
Per-org feature entitlements the dashboard gates its UI on.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openrelay-account-api-openapi.yml Raw ↑

Other APIs OpenRelay publishes across the network.

OpenRelay Inference API
OpenRelay API Keys API
OpenRelay Batches API
OpenRelay Billing API
OpenRelay Catalog API
OpenRelay Clusters API
OpenRelay Files API
OpenRelay Internal API
OpenRelay Organizations API
OpenRelay Provider API
OpenRelay Registry Credentials API
OpenRelay Runners API
Where this information came from

This is an independent, third-party profile of OpenRelay Account API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.