Skip to main content
GET
/
me
Verify User Logged In
curl --request GET \
  --url https://cloud.onyx.app/api/me \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://cloud.onyx.app/api/me"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://cloud.onyx.app/api/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud.onyx.app/api/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://cloud.onyx.app/api/me"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://cloud.onyx.app/api/me")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.onyx.app/api/me")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "email": "<string>",
  "is_active": true,
  "is_superuser": true,
  "is_verified": true,
  "preferences": {
    "chosen_assistants": [
      123
    ],
    "hidden_assistants": [],
    "visible_assistants": [],
    "default_model": "<string>",
    "pinned_assistants": [
      123
    ],
    "shortcut_enabled": true,
    "auto_scroll": true,
    "temperature_override_enabled": true,
    "assistant_specific_configs": {}
  },
  "personalization": {
    "name": "",
    "role": "",
    "use_memories": true,
    "memories": [
      "<string>"
    ]
  },
  "oidc_expiry": "2023-11-07T05:31:56Z",
  "current_token_created_at": "2023-11-07T05:31:56Z",
  "current_token_expiry_length": 123,
  "is_cloud_superuser": false,
  "team_name": "<string>",
  "is_anonymous_user": true,
  "password_configured": true,
  "tenant_info": {
    "invitation": {
      "number_of_users": 123
    },
    "new_tenant": {
      "number_of_users": 123
    }
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Authorization header with Bearer token

Response

Successful Response

id
string
required
email
string
required
is_active
boolean
required
is_superuser
boolean
required
is_verified
boolean
required
role
enum<string>
required

User roles

  • Basic can't perform any admin actions
  • Admin can perform all admin actions
  • Curator can perform admin actions for groups they are curators of
  • Global Curator can perform admin actions for all groups they are a member of
  • Limited can access a limited set of basic api endpoints
  • Slack are users that have used onyx via slack but dont have a web login
  • External permissioned users that have been picked up during the external permissions sync process but don't have a web login
Available options:
limited,
basic,
admin,
curator,
global_curator,
slack_user,
ext_perm_user
preferences
UserPreferences · object
required
personalization
UserPersonalization · object
oidc_expiry
string<date-time> | null
current_token_created_at
string<date-time> | null
current_token_expiry_length
integer | null
is_cloud_superuser
boolean
default:false
team_name
string | null
is_anonymous_user
boolean | null
password_configured
boolean | null
tenant_info
TenantInfo · object | null