---
title: Workspace API
description: "Use the AI Inbx workspace API. Browse endpoints, request parameters, response schemas, and code examples for your integration."
sidebar:
  label: Overview
---

{/* Generated by scripts/openapi.ts from the shared API contract. */}

The workspace a request acts in: its name, and the defaults new domains start with.

## Endpoints

| Method | Operation | Path |
| --- | --- | --- |
| `GET` | [List workspaces](/api/endpoints/workspace/list-workspaces) | `/workspaces` |
| `GET` | [Retrieve the workspace](/api/endpoints/workspace/retrieve-workspace) | `/workspace` |
| `PATCH` | [Update the workspace](/api/endpoints/workspace/update-workspace) | `/workspace` |

## Request essentials [#request-essentials]

Use `https://api.aiinbx.com/api/v2` as the base URL and send your API key in `Authorization: Bearer <key>`. Keep credentials on your server.

See [Authentication](/authentication) for scopes, [Conventions](/reference/conventions) for pagination and idempotency, and [Errors](/reference/errors) for recovery guidance. Each endpoint page includes its parameters, response schemas, and copyable curl, JavaScript, and Python examples.