Get Workspace Info
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/workspace \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/workspace"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/workspace', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"workspace_info": {
"id": "00000000-0000-4000-8000-000000000112",
"name": "Acme Lending",
"created_at": "2024-12-16T13:03:29.947147+00:00",
"credits": 3025,
"locked_credits": 0
}
}{
"message": "Invalid credentials"
}{
"message": "An unexpected error occurred. Please try again later."
}Get Workspace Info
Get the workspace that owns your API key, with its name, ID and credit balance; use it as the first request to confirm a key works and points where expected.
GET
/
workspace
Get Workspace Info
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/workspace \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/workspace"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/workspace', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"workspace_info": {
"id": "00000000-0000-4000-8000-000000000112",
"name": "Acme Lending",
"created_at": "2024-12-16T13:03:29.947147+00:00",
"credits": 3025,
"locked_credits": 0
}
}{
"message": "Invalid credentials"
}{
"message": "An unexpected error occurred. Please try again later."
}Notes
- A
401means the key is wrong or was regenerated. Get the current key from the workspace owner (API key). - Check
namebefore storing a key: each workspace and each Ringg Space has its own key.
Was this page helpful?