Skip to main content
GET
/
workspace
Get Workspace Info
curl --request GET \
  --url https://prod-api.ringg.ai/ca/api/v0/workspace \
  --header 'X-API-KEY: <x-api-key>'
{
  "workspace_info": {
    "id": "d079bcb3-72a3-42dc-9586-edf0328e2973",
    "name": "Siddharth @ DesiVocal's Workspace",
    "created_at": "2024-12-16T13:03:29.947147+00:00",
    "credits": 3025,
    "locked_credits": 0,
    "api_key": "7251cb4b--f52b-4b47-a230-f626ecad3e85"
  }
}

Documentation Index

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

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

Use this endpoint as the first health check for a new integration. It verifies that your API key is valid and returns the workspace context Ringg will use for subsequent API calls.

​
When to use

  • Confirm backend connectivity during setup.
  • Display workspace name, credit balance, or locked credits in an internal admin screen.
  • Verify that a copied API key belongs to the expected workspace before storing it.

​
Integration notes

  • Send the API key in the X-API-KEY header.
  • Treat the returned api_key value as sensitive; do not log or expose it in client applications.
  • If this endpoint returns 401, stop the flow and ask an administrator to check or regenerate the API key.

​
Example

curl --request GET "https://prod-api.ringg.ai/ca/api/v0/workspace" \
  --header "X-API-KEY: $RINGG_API_KEY"

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Response

Successful Response: Information about the current workspace.

​
workspace_info
object