Skip to main content

Documentation Index

Fetch the complete documentation index at: https://trygradient.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Members

Members are the admin users in your organization who can create assessments, invite candidates, and review scores. Members have one of three roles: owner, admin, or reviewer.
RolePermissions
OwnerFull access. Can manage members, billing, and all settings.
AdminCan create/edit assessments, invite candidates, review scores, manage API keys.
ReviewerRead-only access to assessments, sessions, and scores.

​
List Members

GET /api/members
Requires admin role (owner or admin).
{
  "members": [
    {
      "id": "uuid",
      "email": "alice@company.com",
      "name": "Alice Chen",
      "role": "owner",
      "createdAt": "2025-01-10T09:00:00Z"
    }
  ]
}

​
Invite Member

POST /api/members
Invites a new member to your organization. They’ll receive an email with a magic link to join.
​
email
string
required
Email address of the person to invite
​
role
string
default:"reviewer"
Role to assign: owner, admin, or reviewer
{
  "member": {
    "id": "uuid",
    "email": "bob@company.com",
    "name": null,
    "role": "admin",
    "createdAt": "2025-01-15T10:00:00Z"
  }
}

​
Update Member Role

PATCH /api/members/:id
​
role
string
required
New role: owner, admin, or reviewer
{
  "member": {
    "id": "uuid",
    "email": "bob@company.com",
    "role": "admin"
  }
}

​
Resend Member Invite

POST /api/members/:id/resend
Resends the invitation email to a member who hasn’t yet accepted. 
{
  "success": true
}

​
Remove Member

DELETE /api/members/:id
Removes a member from your organization. You cannot remove yourself.
An organization must always have at least one owner.
{
  "ok": true
}