> ## Documentation Index > Fetch the complete documentation index at: https://docs.enginy.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get workspace > Retrieve the API key's workspace: its capacity (identity slots in use and available, monthly credits), how it is billed (`billing`: self-serve or Sales-led), the organization it belongs to (if any) and the caller's role there, where its users open the app (Enginy's app or a white-label custom domain), and how it gets more capacity (`upsell`). Upsell only: these links add credits or upgrade; this API offers no downgrade or cancellation. A workspace of an organization (agency, reseller, white-label partner, enterprise) can also be topped up by its organization admins with the `/v1/organization` endpoints. > **Required scope:** `WORKSPACE_READ` > > **Rate limit:** 100 requests per minute ## OpenAPI ````yaml https://openapi.enginy.ai/definitions.json get /v1/workspace openapi: 3.1.0 info: title: Enginy API version: 1.0.0 description: Public API for Enginy platform servers: - url: https://openapi.enginy.ai description: Configured server security: [] tags: - name: AI Variables description: >- Manage AI variables and discover the entity fields you can reference in prompts and entity requests. - name: Inbox description: >- Inbox endpoints for listing contact threads, reading thread messages, managing tags, and sending manual replies. - name: Workspace description: >- The API key's workspace: its capacity, its organization, where its users open the app and where an admin buys more. - name: Organization description: >- For organizations (agencies, resellers, white-label partners, enterprises) and their client workspaces only. Create client workspaces, distribute credits and identity slots between them, and buy or request more capacity. Upsell and management only: no endpoint lowers the contracted quota. Clients billed through self-serve billing keep their own plan. Requires an organization role. - name: Workflows description: >- Build, validate, publish, run, and inspect advanced (graph) workflows, plus the block/condition catalog needed to author a workflow plan. paths: /v1/workspace: get: tags: - Workspace summary: Get workspace description: >- Retrieve the API key's workspace: its capacity (identity slots in use and available, monthly credits), how it is billed (`billing`: self-serve or Sales-led), the organization it belongs to (if any) and the caller's role there, where its users open the app (Enginy's app or a white-label custom domain), and how it gets more capacity (`upsell`). Upsell only: these links add credits or upgrade; this API offers no downgrade or cancellation. A workspace of an organization (agency, reseller, white-label partner, enterprise) can also be topped up by its organization admins with the `/v1/organization` endpoints. > **Required scope:** `WORKSPACE_READ` > > **Rate limit:** 100 requests per minute responses: '200': description: The workspace content: application/json: schema: type: object properties: status: type: string enum: - success message: type: string data: type: object properties: id: type: number name: type: string createdAt: type: string format: date-time appUrl: type: string description: Where the workspace's users open the app. host: type: object properties: kind: type: string enum: - enginy - white-label domain: type: - string - 'null' description: The white-label custom domain, or `null`. required: - kind - domain identities: type: object properties: used: type: number description: Identities holding a slot. max: type: number available: type: number required: - used - max - available credits: type: object properties: monthlyPlanCredits: type: number monthlyAddonCredits: type: number required: - monthlyPlanCredits - monthlyAddonCredits organization: type: - object - 'null' properties: id: type: number name: type: string type: type: string enum: - AGENCY - RESELLER - WHITE_LABEL - ENTERPRISE purchaseMode: type: string enum: - self-serve - request callerRole: type: - string - 'null' enum: - ORGANIZATION_MANAGER - ORGANIZATION_ADMIN - null description: >- The caller's organization role; `null` when they have none. required: - id - name - type - purchaseMode - callerRole description: >- The organization the workspace belongs to, or `null` for a standalone workspace. billing: type: object properties: authority: type: string enum: - SALES_LED - PARTNER - STRIPE_PLG description: >- Who owns the workspace billing: `STRIPE_PLG` is self-serve (Stripe, in the app); `SALES_LED` and `PARTNER` are billed by Enginy Sales on a contract or the organization deal. model: type: string enum: - self-serve - sales-led required: - authority - model caller: type: object properties: userId: type: - number - 'null' isWorkspaceAdmin: type: boolean canPurchase: type: boolean description: Whether the caller may buy credits or identities. required: - userId - isWorkspaceAdmin - canPurchase upsell: type: object properties: path: type: string enum: - self-serve-billing - purchase - request description: >- How the workspace gets more capacity. `self-serve-billing`: an admin upgrades the plan or adds credits in the app's billing (an organization cannot move capacity to it). `purchase`: an admin buys more in the app (Sales-led, billed to the contract or the organization deal), or its organization admins allocate more with `PUT /v1/organization/clients/{clientId}/capacity`. `request`: its organization (enterprise) admins are asked; they allocate or request more from Enginy. creditsUrl: type: string description: >- Where an admin adds credits, on the workspace app host. upgradePlanUrl: type: - string - 'null' description: >- Where an admin upgrades a self-serve plan; `null` unless the workspace is self-serve. required: - path - creditsUrl - upgradePlanUrl required: - id - name - createdAt - appUrl - host - identities - credits - organization - billing - caller - upsell required: - status - message - data '404': description: Workspace not found security: - apiKey: [] components: securitySchemes: apiKey: type: apiKey in: header name: x-api-key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.