Workspace & Account Management

Authenticate every request with Authorization: Bearer clr_live_YOUR_API_KEY.

List workspaces

GET /workspaces List workspaces through the Claro Public API. Required scope: objects

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/workspaces" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/workspaces"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/workspaces`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Create workspace

POST /workspaces Create workspace through the Claro Public API. Required scope: objects

Request body

Content type: application/json (required)

Request example

{
  "name": "Procurement",
  "domain": "example.com",
  "max_members": 20,
  "max_pro_users": 5
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/workspaces" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Procurement",
  "domain": "example.com",
  "max_members": 20,
  "max_pro_users": 5
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/workspaces"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "name": "Procurement",
  "domain": "example.com",
  "max_members": 20,
  "max_pro_users": 5
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/workspaces`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Procurement",
    "domain": "example.com",
    "max_members": 20,
    "max_pro_users": 5
  }),
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

201 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Get workspace

GET /workspaces/{id} Get workspace through the Claro Public API. Required scope: objects

Parameters

Name	Location	Type	Required
`id`	path	string	Yes

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/workspaces/$ID" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
id = "YOUR_ID"
url = f"https://platform.getclaro.ai/api/public/v1/workspaces/{id}"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const id = "YOUR_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/workspaces/${id}`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Update workspace

PUT /workspaces/{id} Update workspace through the Claro Public API. Required scope: objects

Parameters

Name	Location	Type	Required
`id`	path	string	Yes

Request body

Content type: application/json (required)

Request example

{
  "name": "Global procurement",
  "max_members": 30
}

Example request

curl -X PUT "https://platform.getclaro.ai/api/public/v1/workspaces/$ID" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Global procurement",
  "max_members": 30
}'

import json
import requests
id = "YOUR_ID"
url = f"https://platform.getclaro.ai/api/public/v1/workspaces/{id}"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "name": "Global procurement",
  "max_members": 30
}''')
response = requests.put(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const id = "YOUR_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/workspaces/${id}`, {
  method: "PUT",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Global procurement",
    "max_members": 30
  }),
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Delete workspace

DELETE /workspaces/{id} Delete workspace through the Claro Public API. Required scope: objects

Parameters

Name	Location	Type	Required
`id`	path	string	Yes

Example request

curl -X DELETE "https://platform.getclaro.ai/api/public/v1/workspaces/$ID" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
id = "YOUR_ID"
url = f"https://platform.getclaro.ai/api/public/v1/workspaces/{id}"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.delete(url, headers=headers)
response.raise_for_status()
print(response.text)

const id = "YOUR_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/workspaces/${id}`, {
  method: "DELETE",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

List workspace members

GET /workspaces/{id}/members List workspace members through the Claro Public API. Required scope: objects

Parameters

Name	Location	Type	Required
`id`	path	string	Yes

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/workspaces/$ID/members" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
id = "YOUR_ID"
url = f"https://platform.getclaro.ai/api/public/v1/workspaces/{id}/members"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const id = "YOUR_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/workspaces/${id}/members`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Add workspace members

POST /workspaces/{id}/members Add workspace members through the Claro Public API. Required scope: objects

Parameters

Name	Location	Type	Required
`id`	path	string	Yes

Request body

Content type: application/json (required)

Request example

{
  "invitee_emails": [
    "buyer@example.com"
  ],
  "role": "MEMBER"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/workspaces/$ID/members" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "invitee_emails": [
    "buyer@example.com"
  ],
  "role": "MEMBER"
}'

import json
import requests
id = "YOUR_ID"
url = f"https://platform.getclaro.ai/api/public/v1/workspaces/{id}/members"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "invitee_emails": [
    "buyer@example.com"
  ],
  "role": "MEMBER"
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const id = "YOUR_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/workspaces/${id}/members`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "invitee_emails": [
      "buyer@example.com"
    ],
    "role": "MEMBER"
  }),
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

201 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Update workspace member role

PUT /workspaces/{id}/members/{userId} Update workspace member role through the Claro Public API. Required scope: objects

Parameters

Name	Location	Type	Required
`id`	path	string	Yes
`userId`	path	string	Yes

Request body

Content type: application/json (required)

Request example

{
  "role": "ADMIN"
}

Example request

curl -X PUT "https://platform.getclaro.ai/api/public/v1/workspaces/$ID/members/$USER_ID" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "role": "ADMIN"
}'

import json
import requests
id = "YOUR_ID"
user_id = "YOUR_USER_ID"
url = f"https://platform.getclaro.ai/api/public/v1/workspaces/{id}/members/{user_id}"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "role": "ADMIN"
}''')
response = requests.put(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const id = "YOUR_ID";
const userId = "YOUR_USER_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/workspaces/${id}/members/${userId}`, {
  method: "PUT",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "role": "ADMIN"
  }),
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Remove workspace member

DELETE /workspaces/{id}/members/{userId} Remove workspace member through the Claro Public API. Required scope: objects

Parameters

Name	Location	Type	Required
`id`	path	string	Yes
`userId`	path	string	Yes

Example request

curl -X DELETE "https://platform.getclaro.ai/api/public/v1/workspaces/$ID/members/$USER_ID" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
id = "YOUR_ID"
user_id = "YOUR_USER_ID"
url = f"https://platform.getclaro.ai/api/public/v1/workspaces/{id}/members/{user_id}"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.delete(url, headers=headers)
response.raise_for_status()
print(response.text)

const id = "YOUR_ID";
const userId = "YOUR_USER_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/workspaces/${id}/members/${userId}`, {
  method: "DELETE",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Get current identity

GET /me Get current identity through the Claro Public API. Required scope: objects

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/me" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/me"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/me`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Get credit balance

GET /account/credits Get credit balance through the Claro Public API. Required scope: objects

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/account/credits" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/account/credits"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/account/credits`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Get subscription

GET /account/subscription Get subscription through the Claro Public API. Required scope: objects

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/account/subscription" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/account/subscription"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/account/subscription`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Get account limits

GET /account/limits Get account limits through the Claro Public API. Required scope: objects

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/account/limits" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/account/limits"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/account/limits`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Get credit summary

GET /account/credits/summary Get credit summary through the Claro Public API. Required scope: objects

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/account/credits/summary" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/account/credits/summary"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/account/credits/summary`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

List credit transactions

GET /account/credits/transactions List credit transactions through the Claro Public API. Required scope: objects

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/account/credits/transactions" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/account/credits/transactions"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/account/credits/transactions`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Get credit usage analytics

GET /account/credits/usage Get credit usage analytics through the Claro Public API. Required scope: objects

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/account/credits/usage" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/account/credits/usage"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/account/credits/usage`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

​List workspaces

​Example request

​Responses

​Create workspace

​Request body

​Example request

​Responses

​Get workspace

​Parameters

​Example request

​Responses

​Update workspace

​Parameters

​Request body

​Example request

​Responses

​Delete workspace

​Parameters

​Example request

​Responses

​List workspace members

​Parameters

​Example request

​Responses

​Add workspace members

​Parameters

​Request body

​Example request

​Responses

​Update workspace member role

​Parameters

​Request body

​Example request

​Responses

​Remove workspace member

​Parameters

​Example request

​Responses

​Get current identity

​Example request

​Responses

​Get credit balance

​Example request

​Responses

​Get subscription

​Example request

​Responses

​Get account limits

​Example request

​Responses

​Get credit summary

​Example request

​Responses

​List credit transactions

​Example request

​Responses

​Get credit usage analytics

​Example request

​Responses

List workspaces

Example request

Responses

Create workspace

Request body

Example request

Responses

Get workspace

Parameters

Example request

Responses

Update workspace

Parameters

Request body

Example request

Responses

Delete workspace

Parameters

Example request

Responses

List workspace members

Parameters

Example request

Responses

Add workspace members

Parameters

Request body

Example request

Responses

Update workspace member role

Parameters

Request body

Example request

Responses

Remove workspace member

Parameters

Example request

Responses

Get current identity

Example request

Responses

Get credit balance

Example request

Responses

Get subscription

Example request

Responses

Get account limits

Example request

Responses

Get credit summary

Example request

Responses

List credit transactions

Example request

Responses

Get credit usage analytics

Example request

Responses