# briq API V1 API

**Canonical:** https://apis.io/apis/briq-cloud/briq-api-v1-api/  
**Provider:** briq — https://apis.io/providers/briq-cloud/  
**Base URL:** https://api.briq.cloud  
**Documentation:** https://briq.cloud/docs/api/reference

briq API V1 API is one of 2 APIs that [briq](https://apis.io/providers/briq-cloud/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Services and sandboxes for AI agents.

## Operations (60 of 69)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/auth/providers` | Social sign-in providers this deployment offers |
| GET | `/v1/me` | Current user and teams |
| PATCH | `/v1/me` | Update the current user (name) |
| POST | `/v1/teams` | Create a team |
| PATCH | `/v1/teams/{id}` | Rename a team, change the region new briqs run in, or the display currency |
| DELETE | `/v1/teams/{id}` | Delete a team (owner; not personal; no live briqs) |
| GET | `/v1/teams/{id}/members` | Members and pending invitations |
| PATCH | `/v1/teams/{id}/members/{userId}` | Change a member role (owner) |
| DELETE | `/v1/teams/{id}/members/{userId}` | Remove a member, or leave (your own id). Returns the live keys they created, for the team to review: keys are the team’s and stay. |
| POST | `/v1/teams/{id}/invites` | Invite someone by email (owner or admin) |
| DELETE | `/v1/teams/{id}/invites/{inviteId}` | Revoke a pending invitation |
| GET | `/v1/invites/{token}` | Look up an invitation by its link token (no auth) |
| POST | `/v1/invites/{token}/accept` | Join the team an invitation is for (signed in as the invited address) |
| GET | `/v1/secrets` | List the team secrets: names, hosts and where they go. Never a value. |
| POST | `/v1/secrets` | Add a team secret. Briqs name it as { secret: NAME, scope: "team" } and get a placeholder; the credential gateway puts the value in, to these hosts only. |
| PATCH | `/v1/secrets/{id}` | Rotate a team secret, or change its hosts or locations. Session only. |
| DELETE | `/v1/secrets/{id}` | Delete a team secret. Briqs that named it keep a placeholder that opens nothing. |
| GET | `/v1/agents` | Keys and connected MCP clients of the team |
| PATCH | `/v1/agents/{id}` | Rename an agent or change its policy. Session only. |
| DELETE | `/v1/agents/{id}` | Revoke an agent: a key stops working, a connected client loses its tokens. Session only. |
| GET | `/v1/connect/client` | The MCP client asking to connect, as the consent page shows it |
| POST | `/v1/connect` | Approve an MCP client for a team with a policy. The page then accepts the OAuth consent, which binds the client to this grant. |
| GET | `/v1/connect/device` | The device code an agent showed you, and the client it was issued to |
| POST | `/v1/connect/device` | Approve a device code for a team with a policy. The agent polling for it then gets tokens bound to this grant. |
| POST | `/v1/connect/device/deny` | Refuse a device code: the agent polling for it gets access_denied |
| GET | `/v1/billing` | The team's plan, subscription and payment options |
| POST | `/v1/billing/checkout` | Subscribe to a plan (a Checkout), or change or cancel the subscription (the portal) |
| POST | `/v1/billing/topup` | A Checkout to buy credits (euro cents, before tax) |
| POST | `/v1/billing/card` | A Checkout to save a card: pay as you go, charged past the credits |
| GET | `/v1/billing/checkout/{id}` | A Checkout of the team, for the payment page: Stripe's form and what it pays for |
| POST | `/v1/billing/checkout/{id}/prepare` | Who is buying, just before paying: sets the invoice's VAT mention |
| POST | `/v1/billing/portal` | Stripe's billing portal: invoices, payment method, billing details |
| POST | `/v1/billing/sync` | Apply a finished Checkout now, without waiting for the webhook |
| POST | `/v1/support` | Write to the briq team |
| POST | `/v1/briqs` | Run a briq from an image spec or a recipe |
| GET | `/v1/briqs` | List briqs |
| GET | `/v1/briqs/{id}` | Briq status |
| DELETE | `/v1/briqs/{id}` | Destroy a briq |
| PATCH | `/v1/briqs/{id}` | Resize a briq: another size, a bigger volume |
| POST | `/v1/briqs/{id}/exec` | Run a command inside a briq |
| GET | `/v1/briqs/{id}/execs` | List a briq's async execs |
| GET | `/v1/briqs/{id}/execs/{execId}` | Check an async exec |
| DELETE | `/v1/briqs/{id}/execs/{execId}` | Stop an async exec |
| POST | `/v1/briqs/{id}/execs/{execId}/input` | Write to a running exec |
| GET | `/v1/briqs/{id}/logs` | Fetch logs |
| POST | `/v1/briqs/{id}/expose` | Publish a briq on its HTTPS URL |
| POST | `/v1/briqs/{id}/stop` | stop a briq |
| POST | `/v1/briqs/{id}/start` | start a briq |
| POST | `/v1/briqs/{id}/sleep` | Change when a briq goes to sleep |
| POST | `/v1/briqs/{id}/fork` | Fork a briq: a new briq that starts from a copy of its disk |
| POST | `/v1/briqs/{id}/files` | Write a file into a briq (base64, max 1 MB) |
| PUT | `/v1/briqs/{id}/files` | Write a file into a briq, the raw bytes as the body (max 1 MB) |
| GET | `/v1/briqs/{id}/files` | Read a file from a briq (base64) |
| GET | `/v1/stacks` | List stacks |
| POST | `/v1/stacks` | Create a stack |
| GET | `/v1/stacks/{id}` | Get a stack with its briqs |
| DELETE | `/v1/stacks/{id}` | Destroy every briq of a stack |
| POST | `/v1/stacks/up` | Bring a stack up from a stack file (briq.yaml) |
| POST | `/v1/stacks/{id}/fork` | Fork every briq of a stack into a new stack |
| GET | `/v1/pricing` | Prices per size (euro cents per hour) and display exchange rates |

…and 9 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/briq-cloud/openapi/_original/briq-cloud-v1-openapi.json
- **JSONSchema** — https://artifacts.apis.io/briq-cloud/json-schema/briq-cloud-briq-schema.json
- **JSONSchema** — https://artifacts.apis.io/briq-cloud/json-schema/briq-cloud-run-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/briq-cloud/json-schema/briq-cloud-stack-up-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/briq-cloud/json-schema/briq-cloud-stack-up-result-schema.json
- **JSONSchema** — https://artifacts.apis.io/briq-cloud/json-schema/briq-cloud-stack-fork-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/briq-cloud/json-schema/briq-cloud-key-policy-schema.json

## Other briq APIs (1)

- [briq API](https://apis.io/apis/briq-cloud/briq-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/briq-cloud/briq-api-v1-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/briq-cloud/.