Get the current workspace and credential
curl --request GET \
--url https://api.onlyx.ai/v1/me \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.onlyx.ai/v1/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.onlyx.ai/v1/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"credential": {
"creatorIds": [
"cre_8f2c1a9b0d7e4c3f2a1b"
],
"id": "apk_9a8b7c6d5e4f3a2b1c0d",
"kind": "api_key",
"name": "Reporting script",
"scopes": [
"workspace:read",
"creators:read",
"stats:read"
]
},
"rateLimit": {
"limit": 120,
"windowSeconds": 60
},
"workspace": {
"id": "agc_4f1c9e0b2d7a8c3e5f60",
"name": "Velvet Agency",
"timezone": "Europe/London"
}
}
Get the current workspace and credential
Returns the workspace this API key or access token belongs to, what it is allowed to do (its scopes and, if it is limited to some creators, which ones) and the default rate limit that applies to it. Every valid credential may call this endpoint — workspace:read is granted implicitly — so it is the right first call to check that a key works.
Scope: workspace:read, which every valid credential holds.
Rate limit: the general limit of 120 requests per 60 seconds per credential.
GET
/
v1
/
me
Get the current workspace and credential
curl --request GET \
--url https://api.onlyx.ai/v1/me \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.onlyx.ai/v1/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.onlyx.ai/v1/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"credential": {
"creatorIds": [
"cre_8f2c1a9b0d7e4c3f2a1b"
],
"id": "apk_9a8b7c6d5e4f3a2b1c0d",
"kind": "api_key",
"name": "Reporting script",
"scopes": [
"workspace:read",
"creators:read",
"stats:read"
]
},
"rateLimit": {
"limit": 120,
"windowSeconds": 60
},
"workspace": {
"id": "agc_4f1c9e0b2d7a8c3e5f60",
"name": "Velvet Agency",
"timezone": "Europe/London"
}
}
Authorizations
An API key (onx_sk_…) created in OnlyX under Settings → API & MCP, or an OAuth access token (onx_at_…) issued to a connected app. Send it as Authorization: Bearer <credential>. API keys may also be sent as X-API-Key: <key>.