---
title: "Create BBX instance"
method: POST
path: "/bbx/instances"
tags: ["BBX"]
---

# Create BBX instance

`POST /bbx/instances`

## Request

- Base URL: `https://api.distill.io/v2`
- URL: `https://api.distill.io/v2/bbx/instances`
- Auth: one of:
  - API key in cookie `connect.sid`
  - HTTP bearer
  - API key in query parameter `api_key`

Auth: Write — Workspace member with write access or higher.

## Request body

- object
  - `url` string
  - `persistent` boolean

## Response `200`

Success

- object
  - `id` string, required
  - `host` string, required
  - `key` string, required
  - `connectionString` string, required
  - `basePath` string, required
  - `url` string, required
  - `persistent` boolean, required
  - `cdpUrl` string, required
  - `proxyId` string, nullable

## Other responses

- `400`: Validation error
- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/distill/apis/distill-io-api-v2.md) - [All operations](https://skmtc.dev/distill/apis/distill-io-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/distill/apis/distill-io-api-v2/revisions/c55722ccfe14?raw)
