> ## 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.

# Get Workspace Info

> Retrieves information about your current workspace.

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

```bash theme={null}
curl --request GET "https://prod-api.ringg.ai/ca/api/v0/workspace" \
  --header "X-API-KEY: $RINGG_API_KEY"
```


## OpenAPI

````yaml get /workspace
openapi: 3.0.0
info:
  title: Ringg AI API Documentation
  description: >-
    This is the documentation for the Ringg AI APIs. The Ringg AI API follows
    RESTful principles, making it intuitive and easy to integrate with your
    applications. All API requests should be made to the base URL. The API
    accepts and returns data in JSON format. Ensure your requests include the
    appropriate Content-Type header for POST and PATCH requests.
  version: 2.0.0
servers:
  - url: https://prod-api.ringg.ai/ca/api/v0
security: []
tags:
  - name: workspace
    description: Endpoints for managing your workspace.
  - name: agent
    description: Endpoints for managing assistants (agents).
  - name: calling
    description: Endpoints for making and managing calls.
  - name: campaign
    description: Endpoints for managing campaigns.
  - name: analytics
    description: Endpoints for accessing call analytics and performance metrics.
  - name: termination
    description: Endpoints for terminating active calls using different methods.
  - name: knowledgebase
    description: Endpoints for managing knowledge bases.
paths:
  /workspace:
    get:
      tags:
        - workspace
      summary: Get Workspace Info
      description: Retrieves information about your current workspace.
      operationId: getWorkspaceInfo
      parameters:
        - name: X-API-KEY
          in: header
          description: (Required) Your Ringg AI API key.
          required: true
          schema:
            type: string
            example: 7251cb4b-3373-43a4-844c-b27a1d45e0c9
      responses:
        '200':
          description: 'Successful Response: Information about the current workspace.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace_info:
                    type: object
                    properties:
                      id:
                        type: string
                        example: d079bcb3-72a3-42dc-9586-edf0328e2973
                      name:
                        type: string
                        example: Siddharth @ DesiVocal's Workspace
                      created_at:
                        type: string
                        format: date-time
                        example: '2024-12-16T13:03:29.947147+00:00'
                      credits:
                        type: integer
                        example: 3025
                      locked_credits:
                        type: integer
                        example: 0
                      api_key:
                        type: string
                        example: 7251cb4b--f52b-4b47-a230-f626ecad3e85
        '401':
          description: Unauthorized - Invalid or missing API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: 401 Unauthorized
                      message:
                        type: string
                        example: Invalid credentials
        '500':
          description: Internal Server Error - Something went wrong on our end.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        example: 500 Internal Server Error
                      message:
                        type: string
                        example: An unexpected error occurred on the server.

````