Yard Docs
Sign in
On this page

API reference

Yard's HTTP API, generated from its OpenAPI document; authenticating with API keys, scopes, limits and errors.

Updated November 1, 2026 · 2 min read

Everything the web app does goes through the same HTTP API, and you can call it too. The reference below is generated from the API's own OpenAPI document every time the site is built, so it lists exactly the routes the API serves.

Base address

Every route lives under /v1 on the API's origin, for example https://api.useyard.app/v1/health. Requests and answers are JSON.

Authenticating

From a script or another service, use an API key in the Authorization header:

Shell
curl -H "Authorization: Bearer $YARD_API_KEY" https://api.useyard.app/v1/orgs
  • Personal keys (yard_pk_…) act as you, with the role you have now in each organization. Create them under Account settings, API keys.
  • Organization keys (yard_ok_…) act for one organization only, with at most the role they were created with. Organization admins create them under Settings, API keys.

A key is shown once when it is created; only a hash is stored. Keys can expire, be rotated (the old secret keeps working for a grace period) and be revoked. The yard CLI gets its own key when you run yard login.

Scopes

Scope Allows
read GET requests.
write Every other method.
runners Managing runners (/v1/orgs/{org}/runners).

Some things can never be done with a key, whatever its scopes: managing keys, sessions, passwords, passkeys and two-step sign-in, agent sign-ins, connecting GitHub and approving a CLI sign-in. Sign in to the app for those. An organization key also cannot reach a person's own settings.

Limits

Each key may make 600 requests a minute. Over that the API answers 429.

Errors

A failed request answers with a status and a JSON body with a human-readable error and a stable code, for example {"error": "This API key needs the \write` scope for this.", "code": "key_scope"}`.

  • 401: not signed in, or the key is unknown, revoked or expired.
  • 402: plan_required, the organization's plan has no room for this: a new editor, a viewer on Solo, or a change by someone who is read-only while the organization is over its seats. The body names the plan that fits in plan (Plans and billing).
  • 403: signed in, but not allowed (a missing scope, a role too low).
  • 404: not found, also when something exists in an organization you cannot see.

Health

GET /v1/health

Liveness and version

200 The API is up: Health

Auth

POST /v1/auth/signup

Create an account

Request body: SignUpBody

200 OK: UserResponse

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/signin

Sign in with email and password (may ask for a second step)

Request body: SignInBody

200 OK: UserResponse | TwoFactorChallenge

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/signout

End the current session

200 OK: Ok

GET /v1/auth/me

The signed-in user and their organizations

200 OK: Me

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/auth/me

Update the profile

Request body: UpdateProfileBody

200 OK: UserResponse

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/me/onboarding

Mark the steps a new account is shown once as finished or skipped

200 OK: UserResponse

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/auth/me/preferences

Settings kept on the signed-in account (layout, files, canvas, default context)

200 OK: PreferencesResponse

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/auth/me/preferences

Change settings kept on the account (each section given is merged field by field)

Request body: UpdatePreferencesBody

200 OK: PreferencesResponse

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/auth/email-preferences

Which optional emails the signed-in person gets

200 OK: EmailPreferences

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/auth/email-preferences

Turn optional emails on or off

Request body: UpdateEmailPreferencesBody

200 OK: EmailPreferences

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/email/unsubscribe

Turn one category of optional email off from the link in the email (no sign-in; RFC 8058 one-click)

Query parameters

NameTypeDescription
ustring
cEmailCategory
tstring

200 OK: EmailUnsubscribed

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/verify

Verify the email with the 6-digit code

Request body: VerifyBody

200 OK: UserResponse

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/verify/resend

Send a new verification code

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/auth/password

Change the password

Request body: ChangePasswordBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/auth/providers

Ways to sign in besides a password, and whether sign-up asks for early access

200 OK: AuthProviders

POST /v1/auth/github/url

Where to send the browser to sign in with GitHub

Request body: GithubSigninBody

200 OK: InstallUrl

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/auth/github/signup

What GitHub said about someone signing up through it

Query parameters

NameTypeDescription
ticketstring

200 OK: GithubSignupPending

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/github/signup

Create an account from a GitHub sign-in

Request body: GithubSignupBody

200 OK: UserResponse

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/2fa/totp/setup

Start adding an authenticator app

200 OK: TotpSetup

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/2fa/totp/enable

Confirm the authenticator app with a code; returns recovery codes once

Request body: TotpCodeBody

200 OK: RecoveryCodes

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/2fa/totp/disable

Stop asking for authenticator codes

Request body: TotpCodeBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/2fa/verify

Finish signing in with an authenticator, email or recovery code

Request body: TwoFactorVerifyBody

200 OK: UserResponse

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/2fa/email/send

Mail a sign-in code for a half-done sign-in

Request body: TwoFactorEmailSendBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/2fa/email/setup

Start using email codes: mails a code to confirm

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/2fa/email/enable

Confirm email codes with the mailed code

Request body: TotpCodeBody

200 OK: UserResponse

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/2fa/email/disable

Stop asking for email codes; needs the password

Request body: EmailFactorDisableBody

200 OK: UserResponse

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/auth/2fa/preferred

Choose the second step sign-in starts with

Request body: TwoFactorPreferredBody

200 OK: UserResponse

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/auth/passkeys

The caller's passkeys

200 OK

NameTypeDescription
passkeysPasskey[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/passkeys/register/options

Options for creating a passkey

200 OK: object

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/passkeys/register/verify

Save a new passkey

Request body: PasskeyRegisterBody

200 OK: Passkey

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/auth/passkeys/{id}

Remove a passkey

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/passkeys/login/options

Options for signing in with a passkey

Request body: PasskeyLoginOptionsBody

200 OK: object

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/auth/passkeys/login/verify

Sign in with a passkey

Request body: PasskeyLoginBody

200 OK: UserResponse

Errors: 400, 401, 403, 404, 409, 429 with an error body

Orgs

GET /v1/orgs

Organizations the caller belongs to

200 OK

NameTypeDescription
orgsOrg[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs

Create an organization

Request body: CreateOrgBody

200 OK: Org

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}

One organization

Path parameters

NameTypeDescription
orgstringOrganization id or slug

200 OK: Org

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/orgs/{org}

Update organization settings

Path parameters

NameTypeDescription
orgstringOrganization id or slug

Request body: UpdateOrgBody

200 OK: Org

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}

Delete an organization

Path parameters

NameTypeDescription
orgstringOrganization id or slug

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/members

Members of an organization

Path parameters

NameTypeDescription
orgstringOrganization id or slug

200 OK

NameTypeDescription
membersMember[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/orgs/{org}/members/{userId}

Change a member's role

Path parameters

NameTypeDescription
orgstringOrganization id or slug
userIdstring

Request body: UpdateMemberBody

200 OK: Member

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/members/{userId}

Remove a member, or leave

Path parameters

NameTypeDescription
orgstringOrganization id or slug
userIdstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

API keys

GET /v1/me/api-keys

The caller's personal API keys

200 OK

NameTypeDescription
keysApiKey[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/api-keys

Create a personal API key; the secret is shown once

Request body: CreateApiKeyBody

200 OK: CreatedApiKey

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/me/api-keys/{id}

Revoke a personal API key

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/api-keys/{id}/rotate

Give a personal API key a new secret; the old one works for a grace period

Path parameters

NameTypeDescription
idstring

Request body: RotateApiKeyBody

200 OK: CreatedApiKey

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/api-keys

The organization's API keys (org admins)

Path parameters

NameTypeDescription
orgstring

200 OK

NameTypeDescription
keysApiKey[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/api-keys

Create an organization API key (org admins); the secret is shown once

Path parameters

NameTypeDescription
orgstring

Request body: CreateApiKeyBody

200 OK: CreatedApiKey

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/api-keys/{id}

Revoke an organization API key (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/api-keys/{id}/rotate

Give an organization API key a new secret (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

Request body: RotateApiKeyBody

200 OK: CreatedApiKey

Errors: 400, 401, 403, 404, 409, 429 with an error body

CLI sign-in

POST /v1/cli/login/start

Start signing the yard CLI in: a code to confirm in the browser

Request body: CliLoginStartBody

200 OK: CliLoginStart

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/cli/login/poll

Whether the person confirmed the code; the key, once

Request body

NameTypeDescription
deviceTokenstring

200 OK: CliLoginPoll

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/cli/login/{code}

A pending CLI sign-in, to confirm

Path parameters

NameTypeDescription
codestring

200 OK: CliLoginRequest

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/cli/login/{code}/approve

Confirm a CLI sign-in: mints a personal key for that CLI

Path parameters

NameTypeDescription
codestring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/cli/login/{code}/deny

Refuse a CLI sign-in

Path parameters

NameTypeDescription
codestring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/cli/logout

Revoke the API key this request is made with (yard logout)

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

Invites

GET /v1/orgs/{org}/invites

Pending invites

Path parameters

NameTypeDescription
orgstring

200 OK

NameTypeDescription
invitesInvite[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/invites

Invite by email, or create a shareable link

Path parameters

NameTypeDescription
orgstring

Request body: CreateInviteBody

200 OK: CreatedInvite

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/invites/{id}

Revoke an invite

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/invites/{token}

What an invite link grants (public)

Path parameters

NameTypeDescription
tokenstring

200 OK: InvitePreview

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/invites/{token}/accept

Join the organization

Path parameters

NameTypeDescription
tokenstring

200 OK: AcceptedInvite

Errors: 400, 401, 403, 404, 409, 429 with an error body

Billing

GET /v1/me/license

Your licenses: whether you can edit, and what a license costs

200 OK: MyLicense

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

POST /v1/me/license/checkout

Buy your own license: a Stripe Checkout page

Request body: BillingCheckoutBody

200 OK: BillingRedirect

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

POST /v1/me/license/portal

Payment method and invoices of your own licenses: Stripe's customer portal

200 OK: BillingRedirect

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

POST /v1/me/licenses/{id}/cancel

End your license at the end of the paid period

Path parameters

NameTypeDescription
idstring

200 OK: MyLicense

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

POST /v1/me/licenses/{id}/resume

Keep a license you set to end

Path parameters

NameTypeDescription
idstring

200 OK: MyLicense

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/billing

Who can edit, the licenses the org pays for, and Enterprise (any member; owners manage it)

Path parameters

NameTypeDescription
orgstringOrganization id or slug

200 OK: Billing

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/billing/checkout

Start Enterprise for every member: a Stripe Checkout page (owners)

Path parameters

NameTypeDescription
orgstringOrganization id or slug

Request body: BillingCheckoutBody

200 OK: BillingRedirect

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/billing/portal

Payment method and invoices: Stripe's customer portal (owners)

Path parameters

NameTypeDescription
orgstringOrganization id or slug

200 OK: BillingRedirect

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/billing/licenses

Pay for a member's license, theirs in every organization: a Stripe Checkout page (owners)

Path parameters

NameTypeDescription
orgstringOrganization id or slug

Request body: BillingLicenseBody

200 OK: BillingRedirect

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/billing/licenses/{id}/cancel

Stop paying for a license at the end of the paid period (owners)

Path parameters

NameTypeDescription
orgstringOrganization id or slug
idstring

200 OK: Billing

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/billing/licenses/{id}/resume

Keep paying for a license set to end (owners)

Path parameters

NameTypeDescription
orgstringOrganization id or slug
idstring

200 OK: Billing

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/billing/cancel

End Enterprise at the end of the paid period (owners)

Path parameters

NameTypeDescription
orgstringOrganization id or slug

200 OK: Billing

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/billing/pending

Keep Enterprise after cancelling it (owners)

Path parameters

NameTypeDescription
orgstringOrganization id or slug

200 OK: Billing

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/billing/current-terms

Leave earlier Enterprise terms for the current ones (owners)

Path parameters

NameTypeDescription
orgstringOrganization id or slug

200 OK: Billing

Errors: 400, 401, 402, 403, 404, 409, 429 with an error body

GET /v1/plans

The plans people can choose, with prices, limits and when they last changed (no sign-in; honours If-None-Match)

200 OK: PlanList

Errors: 304 with an error body

Runners

GET /v1/orgs/{org}/runners

Runners this organization can use

Path parameters

NameTypeDescription
orgstring

200 OK

NameTypeDescription
runnersRunner[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners

Register a runner for this organization

Path parameters

NameTypeDescription
orgstring

Request body: CreateRunnerBody

200 OK: CreatedRunner

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/orgs/{org}/runners/{id}

Change how many agent turns an organization's runner runs at once, and when they wait for its load (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

Request body: UpdateRunnerBody

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/runners/{id}

Remove an organization's runner

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/rotate-token

Give an organization's runner a new token; the old one stops working

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: RotatedRunnerToken

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/runners/{id}/setup

The setup steps of an organization's runner no machine has connected yet, with its setup token (org admins). 409 `runner_set_up` once one has

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: CreatedRunner

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/device/approve

Pin the runner to the machine it connected from instead (org admins); a waiting connection goes live

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/device/reject

Refuse the other machine (org admins); its connection is closed

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/device/reset

Forget the runner's machine (org admins); the next connection is pinned on trust

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/orgs/{org}/runners/{id}/direct

Give a pinned runner its own https address for terminals and downloads (org admins); checked at once

Path parameters

NameTypeDescription
orgstring
idstring

Request body: SetRunnerDirectBody

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/runners/{id}/direct

Stop using the runner's own address (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/direct/verify

Check now that the runner's address answers as this runner (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/me/runners

The caller's personal runners

200 OK

NameTypeDescription
runnersRunner[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners

Register a personal runner: only the caller can put workspaces on it

Request body: CreateRunnerBody

200 OK: CreatedRunner

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/me/runners/{id}

Change a personal runner: whether others may edit the workspaces on it (they can always view them), and how many agent turns it runs at once

Path parameters

NameTypeDescription
idstring

Request body: UpdatePersonalRunnerBody

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/me/runners/{id}

Remove a personal runner

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/rotate-token

Give a personal runner a new token; the old one stops working

Path parameters

NameTypeDescription
idstring

200 OK: RotatedRunnerToken

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/me/runners/{id}/setup

The setup steps of a personal runner no machine has connected yet, with its setup token. 409 `runner_set_up` once one has

Path parameters

NameTypeDescription
idstring

200 OK: CreatedRunner

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/device/approve

Pin the personal runner to the machine it connected from instead

Path parameters

NameTypeDescription
idstring

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/device/reject

Refuse the other machine; its connection is closed

Path parameters

NameTypeDescription
idstring

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/device/reset

Forget the runner's machine; the next connection is pinned on trust

Path parameters

NameTypeDescription
idstring

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/me/runners/{id}/direct

Give a pinned personal runner its own https address; checked at once

Path parameters

NameTypeDescription
idstring

Request body: SetRunnerDirectBody

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/me/runners/{id}/direct

Stop using the personal runner's own address

Path parameters

NameTypeDescription
idstring

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/direct/verify

Check now that the personal runner's address answers as this runner

Path parameters

NameTypeDescription
idstring

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/runners/{id}/queue

What runs and waits on an organization's runner, and what failed (org members; only admins see other people's turns)

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: RunnerQueue

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/me/runners/{id}/queue

What runs and waits on a personal runner, and what failed

Path parameters

NameTypeDescription
idstring

200 OK: RunnerQueue

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/runner-queue

This workspace's turns on its runner, and how busy the runner is (read only)

Path parameters

NameTypeDescription
wsstring

200 OK: RunnerQueue

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/retry-failed

Queue every failed project and chat on an organization's runner again (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

Request body: RetryFailedBody

200 OK: RetryFailedResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/retry-failed

Queue every failed project and chat on a personal runner again

Path parameters

NameTypeDescription
idstring

Request body: RetryFailedBody

200 OK: RetryFailedResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/retry-failed

Queue every failed project and chat of this workspace again

Path parameters

NameTypeDescription
wsstring

200 OK: RetryFailedResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/update

Have an online organization runner install the newest build and restart (org admins). While something runs on it, 409 `runner_busy` lists it (`work`, as `/busy` does); with `force` it updates anyway, and the agent turns it cut off carry on by themselves once it is back. With `whenIdle` it answers `{ pending: true }` and the runner installs once nothing runs (runner 0.30.0+; an older one: 409 `runner_update_when_idle_unsupported`).

Path parameters

NameTypeDescription
orgstring
idstring

Request body: UpdateRunnerNowBody

200 OK: RunnerUpdateResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/restart

Restart an online organization runner on the build it has (org admins). While something runs on it, 409 `runner_busy` lists it; with `force` it restarts anyway and the agent turns it cut off carry on once it is back.

Path parameters

NameTypeDescription
orgstring
idstring

Request body: RestartRunnerBody

200 OK: RunnerRestartResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/restart

Restart an online personal runner on the build it has. `force` and the 409 `runner_busy` answer as for an organization runner.

Path parameters

NameTypeDescription
idstring

Request body: RestartRunnerBody

200 OK: RunnerRestartResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/runners/{id}/busy

What runs on an organization runner now and an update would stop: agent turns, terminals, background work (org admins). Work in workspaces the caller cannot see is only counted.

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: RunnerBusy

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/cancel-update

Drop an update that waits for an organization runner to be idle (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/update

Have an online personal runner install the newest build and restart. `force` and `whenIdle`, and the 409 `runner_busy` answer, as for an organization runner.

Path parameters

NameTypeDescription
idstring

Request body: UpdateRunnerNowBody

200 OK: RunnerUpdateResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/me/runners/{id}/busy

What runs on a personal runner now and an update would stop. Work in workspaces the caller cannot see is only counted.

Path parameters

NameTypeDescription
idstring

200 OK: RunnerBusy

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/cancel-update

Drop an update that waits for a personal runner to be idle

Path parameters

NameTypeDescription
idstring

200 OK: Runner

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/runners/{id}/hosting

A runner's hosting: settings, its domain's status and DNS records, and its live state (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: RunnerHosting

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/orgs/{org}/runners/{id}/hosting

Turn hosting on or off and configure it: domain, TLS, max apps, free subdomains, hosting-only (org admins). A new domain starts pending until its TXT record is seen

Path parameters

NameTypeDescription
orgstring
idstring

Request body: RunnerHostingBody

200 OK: RunnerHosting

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/runners/{id}/hosting/proxy-config

The config to paste into the reverse proxy in front of this runner (Traefik/Coolify, nginx or Caddy), for its verified domains and listen address (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

Query parameters

NameTypeDescription
flavoroptional"traefik" | "nginx" | "caddy"
upstreamoptional"loopback" | "bridge"

200 OK: RunnerProxyConfig

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/me/runners/{id}/hosting/proxy-config

The config to paste into the reverse proxy in front of this runner (Traefik/Coolify, nginx or Caddy), for its verified domains and listen address (its owner)

Path parameters

NameTypeDescription
idstring

Query parameters

NameTypeDescription
flavoroptional"traefik" | "nginx" | "caddy"
upstreamoptional"loopback" | "bridge"

200 OK: RunnerProxyConfig

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/hosting/test-route

Test that a sample host under the runner's verified domain reaches it through the proxy in front, and say what is missing: DNS, a router or the certificate (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: RunnerRouteCheck

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/hosting/test-route

Test that a sample host under the runner's verified domain reaches it through the proxy in front, and say what is missing: DNS, a router or the certificate (its owner)

Path parameters

NameTypeDescription
idstring

200 OK: RunnerRouteCheck

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/hosting/doctor

Run the runner's hosting doctor (read only): the deployment mode found, a checklist, and a proposed fix as a diff. Changes nothing (org admins). 409 when the runner is offline or too old

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: HostingDoctorReport

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/hosting/doctor

Run the runner's hosting doctor (read only): the deployment mode found, a checklist, and a proposed fix as a diff. Changes nothing (its owner). 409 when the runner is offline or too old

Path parameters

NameTypeDescription
idstring

200 OK: HostingDoctorReport

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/hosting/doctor/apply

Apply the doctor's proposal with this id, and only what it listed; the doctor then runs again with the route test. A proposal that changed since the report is refused (org admins; audited)

Path parameters

NameTypeDescription
orgstring
idstring

Request body: RunnerHostingDoctorApplyBody

200 OK: HostingDoctorApplyResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/hosting/doctor/apply

Apply the doctor's proposal with this id, and only what it listed; the doctor then runs again with the route test. A proposal that changed since the report is refused (its owner; audited)

Path parameters

NameTypeDescription
idstring

Request body: RunnerHostingDoctorApplyBody

200 OK: HostingDoctorApplyResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/hosting/verify

Check the runner's hosting domains (their TXT records) and proxy address now (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: RunnerHosting

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/hosting/domains

Add another domain to a runner's hosting (org admins). It starts pending until its TXT record is seen; the first one becomes the default

Path parameters

NameTypeDescription
orgstring
idstring

Request body: RunnerHostingDomainBody

200 OK: RunnerHosting

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/runners/{id}/hosting/domains/{domain}

Give up one of a runner's hosting domains (org admins). Removing the default makes the next verified one the default

Path parameters

NameTypeDescription
orgstring
idstring
domainstring

200 OK: RunnerHosting

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/hosting/domains

Add another domain to a runner's hosting (its owner). It starts pending until its TXT record is seen; the first one becomes the default

Path parameters

NameTypeDescription
idstring

Request body: RunnerHostingDomainBody

200 OK: RunnerHosting

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/me/runners/{id}/hosting/domains/{domain}

Give up one of a runner's hosting domains (its owner). Removing the default makes the next verified one the default

Path parameters

NameTypeDescription
idstring
domainstring

200 OK: RunnerHosting

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/me/runners/{id}/hosting

A runner's hosting: settings, its domain's status and DNS records, and its live state (its owner)

Path parameters

NameTypeDescription
idstring

200 OK: RunnerHosting

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/me/runners/{id}/hosting

Turn hosting on or off and configure it: domain, TLS, max apps, free subdomains, hosting-only (its owner). A new domain starts pending until its TXT record is seen

Path parameters

NameTypeDescription
idstring

Request body: RunnerHostingBody

200 OK: RunnerHosting

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/hosting/verify

Check the runner's hosting domains (their TXT records) and proxy address now (its owner)

Path parameters

NameTypeDescription
idstring

200 OK: RunnerHosting

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/runners/{id}/promotion

Submit an organization's runner to become official (instance admins who are admins of the org)

Path parameters

NameTypeDescription
orgstring
idstring

Request body: SubmitRunnerPromotionBody

200 OK: RunnerPromotion

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/runners/{id}/promotion

Withdraw the open request to make an organization's runner official (instance admins)

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/me/runners/{id}/promotion

Submit your own personal runner to become official (instance admins)

Path parameters

NameTypeDescription
idstring

Request body: SubmitRunnerPromotionBody

200 OK: RunnerPromotion

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/me/runners/{id}/promotion

Withdraw the open request to make your personal runner official (instance admins)

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/runner/releases

Downloadable runner builds (public)

200 OK: RunnerReleases

Errors: 400, 401, 403, 404, 409, 429 with an error body

Vault

GET /v1/me/vaults

The vaults of the caller's organizations: a secret of their own (an agent API key) is sealed for each

200 OK: MyVaults

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/vault

The org vault: the public key secrets are sealed to, its fingerprint, the runners that hold it and those waiting for approval

Path parameters

NameTypeDescription
orgstring

200 OK: OrgVault

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/vault

Set up the org vault on one of its online runners (org admins)

Path parameters

NameTypeDescription
orgstring

Request body: SetUpVaultBody

200 OK: OrgVault

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/vault

The public key this workspace's secrets are sealed to (its organization's vault)

Path parameters

NameTypeDescription
wsstring

200 OK: WorkspaceVault

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/vault/grants/{runner}

Give a runner access to the org vault (org admins); a runner that holds it wraps the key for it

Path parameters

NameTypeDescription
orgstring
runnerstring

200 OK: OrgVault

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/vault/grants/{runner}

Take a runner's vault access away (org admins); rotate the vault afterwards, as it may still know the key

Path parameters

NameTypeDescription
orgstring
runnerstring

200 OK: OrgVault

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/vault/rotate

Rotate the org vault (org admins): a runner holding it makes a new key and seals every secret again; a runner that once held the old key opens nothing sealed after

Path parameters

NameTypeDescription
orgstring

200 OK: OrgVault

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/vault/reset

Reset the org vault (org admins) when no online runner can share its key: an online runner makes a new vault, the runners approved for the old one get its key, and the secrets sealed to the old one are deleted, to be entered again. Refused (409 vault_reachable) while a runner that opens the key is online

Path parameters

NameTypeDescription
orgstring

Request body: ResetVaultBody

200 OK: OrgVault

Errors: 400, 401, 403, 404, 409, 429 with an error body

Storage

GET /v1/orgs/{org}/storage

Where this organization's files are stored

Path parameters

NameTypeDescription
orgstring

200 OK: OrgStorage

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/orgs/{org}/storage

Set the organization's bucket

Path parameters

NameTypeDescription
orgstring

Request body: UpdateOrgStorageBody

200 OK: OrgStorage

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/storage/test

Write, read and delete a probe object

Path parameters

NameTypeDescription
orgstring

200 OK: StorageTestResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/storage/buckets

Buckets this organization's workspaces can use

Path parameters

NameTypeDescription
orgstring

200 OK

NameTypeDescription
bucketsStorageBucket[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/storage/buckets

Add a bucket of the organization's own (org admins)

Path parameters

NameTypeDescription
orgstring

Request body: CreateStorageBucketBody

200 OK: StorageBucket

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/orgs/{org}/storage/buckets/{id}

Change one of the organization's buckets (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

Request body: UpdateStorageBucketBody

200 OK: StorageBucket

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/storage/buckets/{id}

Remove one of the organization's buckets no workspace uses (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/storage/buckets/{id}/test

Write, read and delete a probe object (org admins)

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: StorageTestResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/storage

Which bucket this workspace's files are in, and any move under way

Path parameters

NameTypeDescription
wsstring

200 OK: WorkspaceStorage

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/storage/migrate

Move this workspace's files to another bucket (org admins)

Path parameters

NameTypeDescription
wsstring

Request body

NameTypeDescription
bucketIdstring

200 OK: WorkspaceStorage

Errors: 400, 401, 403, 404, 409, 429 with an error body

Integrations

GET /v1/me/integrations

Outside services you connected, and the ones you can

200 OK: IntegrationList

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/me/integrations/{provider}

Connect a service with your own key (checked with the service first)

Path parameters

NameTypeDescription
providerIntegrationProvider

Request body: ConnectIntegrationBody

200 OK: Integration

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/me/integrations/{provider}

Forget your key for a service

Path parameters

NameTypeDescription
providerIntegrationProvider

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/integrations

Services the organization connected for its members

Path parameters

NameTypeDescription
orgstring

200 OK: IntegrationList

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/orgs/{org}/integrations/{provider}

Connect a service for everyone in the organization (org admins)

Path parameters

NameTypeDescription
orgstring
providerIntegrationProvider

Request body: ConnectIntegrationBody

200 OK: Integration

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/integrations/{provider}

Forget the organization's key for a service (org admins)

Path parameters

NameTypeDescription
orgstring
providerIntegrationProvider

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/stt/status

Whether dictation can use server speech to text, with your key or the organization's

Query parameters

NameTypeDescription
orgoptionalstring

200 OK: SttStatus

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/stt/transcribe

Turn a recording into text with Mistral

Request body: TranscribeBody

200 OK: Transcription

Errors: 400, 401, 403, 404, 409, 429 with an error body

Workspaces

GET /v1/orgs/{org}/workspaces

Workspaces the caller can open

Path parameters

NameTypeDescription
orgstring

Query parameters

NameTypeDescription
archivedoptional"true" | "false"

200 OK

NameTypeDescription
workspacesWorkspace[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/workspaces

Create a workspace on a runner

Path parameters

NameTypeDescription
orgstring

Request body: CreateWorkspaceBody

200 OK: Workspace

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/workspaces/{slug}

One workspace, by its URL slug

Path parameters

NameTypeDescription
orgstring
slugstring

200 OK: Workspace

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}

One workspace

Path parameters

NameTypeDescription
wsstring

200 OK: Workspace

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/workspaces/{ws}

Update workspace settings, or move it to another runner

Path parameters

NameTypeDescription
wsstring

Request body: UpdateWorkspaceBody

200 OK: Workspace

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/workspaces/{ws}

Delete an archived workspace

Path parameters

NameTypeDescription
wsstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/quick-start

Hide the Quick start guide for everyone in the workspace, or show it again

Path parameters

NameTypeDescription
wsstring

Request body: SetQuickStartBody

200 OK: Workspace

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/retry

Retry provisioning after a failure, or when setup is taking longer than usual

Path parameters

NameTypeDescription
wsstring

200 OK: Workspace

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/reset-files

Start a failed or stuck workspace's files again on its runner, keeping its repositories, projects and canvas

The runner moves what is left of the workspace's home to its trash and provisions an empty one; repositories are cloned again and projects' boxes made again. Owners only, for a workspace that failed or has been setting up for more than two minutes.

Path parameters

NameTypeDescription
wsstring

200 OK: Workspace

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/unarchive

Bring an archived workspace back onto a runner

Path parameters

NameTypeDescription
wsstring

Request body: UnarchiveBody

200 OK: Workspace

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/archive

Stop the runtime; files stay in storage for the retention period

Path parameters

NameTypeDescription
wsstring

200 OK: Workspace

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/share

Who can open this workspace

Path parameters

NameTypeDescription
wsstring

200 OK: Share

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/share/members/{userId}

Grant, change or clear one person's role

Path parameters

NameTypeDescription
wsstring
userIdstring

Request body: SetShareRoleBody

200 OK: Share

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/share/invite

Share with someone by email

Path parameters

NameTypeDescription
wsstring

Request body: ShareInviteBody

200 OK: ShareInviteResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

Workspace content

GET /v1/workspaces/{ws}/history

Canvas history and unsaved changes

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
containeroptionalstring

200 OK: History

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/history/save

Commit unsaved canvas changes now

Path parameters

NameTypeDescription
wsstring

Request body: SaveHistoryBody

200 OK: HistoryResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/history/{sha}/revert

Put the canvas back to how it was at a commit

Path parameters

NameTypeDescription
wsstring
shastring

Request body

NameTypeDescription
containeroptionalstring

200 OK: HistoryResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/uploads

Start an upload

Path parameters

NameTypeDescription
wsstring

Request body: CreateUploadBody

200 OK: UploadTicket

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/uploads/{id}/complete

Bring an uploaded file into the workspace

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: UploadResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/usage

What the workspace's containers use right now, and its disk

Path parameters

NameTypeDescription
wsstring

200 OK: WorkspaceUsage

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/usage

What every workspace of the organization uses right now (admins)

Path parameters

NameTypeDescription
orgstring

200 OK: OrgUsage

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/processes

Processes running in the workspace's container, or in a project's

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
containeroptionalstring

200 OK: ProcessList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/containers/stop-runtime

Stop every container of the workspace; each starts again when it is next used

Path parameters

NameTypeDescription
wsstring

200 OK

NameTypeDescription
stoppedinteger
skippedinteger

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/processes/kill

Stop one process in a container

Path parameters

NameTypeDescription
wsstring

Request body: KillProcessBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/link-preview

Title, description and image of a web page, read from inside the workspace's box

Path parameters

NameTypeDescription
wsstring

Request body: LinkPreviewBody

200 OK: LinkPreview

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/snapshot

Read-only copy of the canvas from storage, for when the runner is offline, or of one of its sheets (`sheet`)

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
containeroptionalstring
sheetoptionalstring

200 OK: SnapshotLink

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/terminals

Open terminals

Path parameters

NameTypeDescription
wsstring

200 OK

NameTypeDescription
terminalsTerminal[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/terminals

Open a terminal in the workspace or one of its containers

Path parameters

NameTypeDescription
wsstring

Request body: CreateTerminalBody

200 OK: Terminal

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/workspaces/{ws}/terminals/{id}

Close a terminal

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

Sheets

GET /v1/workspaces/{ws}/sheets

The sheets of the workspace the caller may open (canvases, investigations, documents of docs), its own document first

Path parameters

NameTypeDescription
wsstring

200 OK: SheetList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/sheets

Add a canvas to the workspace

Path parameters

NameTypeDescription
wsstring

Request body: CreateSheetBody

200 OK: Sheet

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/library

The docs and prototypes of the workspace the caller may open, each with the document it is kept in

Path parameters

NameTypeDescription
wsstring

200 OK: Library

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/sheets/{id}

Rename a sheet or move it

Path parameters

NameTypeDescription
idstring

Request body: UpdateSheetBody

200 OK: Sheet

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/sheets/{id}

Delete a sheet (its files are archived in the workspace's history)

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/migrate-docs

Move the workspace's first canvas into docs, once: it becomes a doc, its blocks the workspace's library

Path parameters

NameTypeDescription
wsstring

200 OK: MigrateDocsResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/docs/name-suggestions

Up to three short titles for a doc, from its first words (a one-shot question to the caller's agent, not stored)

Path parameters

NameTypeDescription
wsstring

Request body: DocNameSuggestionsBody

200 OK: DocNameSuggestions

Errors: 400, 401, 403, 404, 409, 429, 502, 503 with an error body

Docs

GET /v1/workspaces/{ws}/docs/{doc}/share

A doc's view-only public link, if it has one, and whether the caller may change it

Path parameters

NameTypeDescription
wsstring
docstring

200 OK: DocShareState

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/docs/{doc}/share

Share a doc with a view-only link anyone can open without signing in (or answer the one it has)

Path parameters

NameTypeDescription
wsstring
docstring

200 OK: DocShareState

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/workspaces/{ws}/docs/{doc}/share

Stop sharing a doc: its public link answers "not valid" from now on

Path parameters

NameTypeDescription
wsstring
docstring

200 OK: DocShareState

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/docs/{doc}/share/reset

End a doc's public link and make a new one

Path parameters

NameTypeDescription
wsstring
docstring

200 OK: DocShareState

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/doc-shares

The docs of the workspace the caller may open that have a public link

Path parameters

NameTypeDescription
wsstring

200 OK: SharedDocs

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/doc-shares

How many public links to docs the organization has (admins)

Path parameters

NameTypeDescription
orgstring

200 OK: OrgDocShares

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/doc-edits

Edits agents made or proposed to docs: of one doc, one chat, or one state

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
docoptionalstring
chatoptionalstring
stateoptional"proposed" | "accepted" | "applied" | "undone"

200 OK: DocEditList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/doc-edits/{id}/accept

Apply a proposed edit to its doc

Path parameters

NameTypeDescription
idstring

200 OK: DocEdit

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/doc-edits/{id}/undo

Decline a proposed edit, or take back an accepted or applied one

Path parameters

NameTypeDescription
idstring

200 OK: DocEdit

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/doc-edit-batches/{batch}/accept

Apply every proposed edit of one request to its doc, in the order they were made: all of them or none

Path parameters

NameTypeDescription
wsstring
batchstring

200 OK: DocEditList

Errors: 400, 401, 403, 404, 409, 429 with an error body

Investigations

GET /v1/workspaces/{ws}/investigations

The workspace's investigations you may open, newest first, each with its state

Path parameters

NameTypeDescription
wsstring

200 OK: InvestigationList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/investigations

Ask a question an agent answers by reading repositories: makes a doc of the workspace for its answer, a record of the investigation and a chat bound to it, and sends the question as the chat's first message

Needs edit rights and a live runner, like adding a canvas. The investigation's state (`running`, `finished`, `failed`) follows the chat's turns and arrives as `sheets.changed`; a follow-up is a message in the chat (`POST /v1/chats/{id}/messages`).

Path parameters

NameTypeDescription
wsstring

Request body: CreateInvestigationBody

200 OK: Investigation

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/investigations/{id}/continue

Go on from an investigation (`id`: its tab) with every block of its tab as context: start work or write a spec (a project), or build a prototype (a prototype block on the tab, asked through its own chat)

Path parameters

NameTypeDescription
idstring

Request body: ContinueInvestigationBody

200 OK: ContinueInvestigationResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

Goals

GET /v1/workspaces/{ws}/goals

The workspace's open goals, newest first (without goal.md's counts)

Path parameters

NameTypeDescription
wsstring

200 OK: GoalList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/goals

Set a goal: makes goal.md on the board, the goal's agent chat, and sends the sentence as its first message

Needs edit rights and a live runner. The goal's state follows its chat's turns and arrives as `goals.changed` on the workspace channel.

Path parameters

NameTypeDescription
wsstring

Request body: CreateGoalBody

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/goals/{id}

A goal with its changes, agent time and cost, and goal.md's decisions counted

Path parameters

NameTypeDescription
idstring

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/goals/{id}

Rename a goal, or change how much it decides on its own, what it always asks, its review cap, how many projects run at once, its context and the board's doc side

Path parameters

NameTypeDescription
idstring

Request body: UpdateGoalBody

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/goals/{id}

Delete a goal: it is paused, and its canvas block, goal.md, its chat and the goal go; its projects stay

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/pause

Pause a goal: its projects stop after the step they are on, its apps keep running

Path parameters

NameTypeDescription
idstring

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/resume

Resume a paused goal where it stopped

Path parameters

NameTypeDescription
idstring

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/goals/{id}/budget

Set, raise or clear what a goal's agents may spend in all (null: no limit)

Spend is the agent cost of the goal's chat and its projects' chats (`usage.costUsd`). When it reaches the budget the goal pauses with `pausedReason: budget`: nothing new starts and its projects stop after the step they are on. A budget at or below the spend answers 409 `goal_budget_below_spend`. A goal paused by its budget resumes once the budget is above its spend; one a person paused stays paused. Resume answers 409 `goal_budget_reached` while the spend is at the budget.

Path parameters

NameTypeDescription
idstring

Request body: GoalBudgetBody

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/close

Close a goal: it is paused and leaves the sidebar; its projects and goal.md stay

Path parameters

NameTypeDescription
idstring

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/changes/{change}/undo

Take back a section the goal's agent added to goal.md from a chat message; a plan of stages from before answers 410

Path parameters

NameTypeDescription
idstring
changestring

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/design/keep

Refuses with 410 `goal_stages_removed`: a goal has no stages or design rounds

Path parameters

NameTypeDescription
idstring

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/goals/{id}/apps

The goal's Apps tab: the apps of its repositories, the app changes its agents proposed (each a diff against the config that applies now) and the secrets that need a value; no secret value is included

Path parameters

NameTypeDescription
idstring

200 OK: GoalApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/stages/{stage}/run

Refuses with 410 `goal_stages_removed`: a goal has no stages or design rounds

Path parameters

NameTypeDescription
idstring
stageinteger

200 OK: GoalStageRun

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/stages/{stage}/feedback

Refuses with 410 `goal_stages_removed`: a goal has no stages or design rounds

Path parameters

NameTypeDescription
idstring
stageinteger

Request body: GoalStageFeedbackBody

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/stages/{stage}/rollback

Refuses with 410 `goal_stages_removed`: a goal has no stages or design rounds

Path parameters

NameTypeDescription
idstring
stageinteger

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/stages/{stage}/merge

Refuses with 410 `goal_stages_removed`: a goal has no stages or design rounds

Path parameters

NameTypeDescription
idstring
stageinteger

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/goals/{id}/board

The goal's board: its projects, decisions, doc edits and app changes by column, with the review cap and how many run

Path parameters

NameTypeDescription
idstring

200 OK: GoalBoard

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/projects/{project}/approve

Approve plan: Start work on the caller's account (when no account is available the card says so); with no room for it, it waits in Next up

Path parameters

NameTypeDescription
idstring
projectstring

200 OK: GoalBoard

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/projects/{project}/not-now

Not now: the card goes back to Next up, unstarted, until someone moves it

Path parameters

NameTypeDescription
idstring
projectstring

200 OK: GoalBoard

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/goals/{id}/projects/{project}/position

Move a card within its column, or to another with the same result as that column's button: Working approves, Next up is Not now, Done queues a ready project for merge, For you brings back a card put off

Path parameters

NameTypeDescription
idstring
projectstring

Request body: MoveGoalProjectBody

200 OK: GoalBoard

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/retry

Try again: a goal stopped after iterations that changed nothing (or a failed turn) carries on, its stalls counted afresh

Path parameters

NameTypeDescription
idstring

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/goals/{id}/decide-all

Ask the goal's agent to decide every open decision itself, writing each down as assumed with its reason

Path parameters

NameTypeDescription
idstring

200 OK: Goal

Errors: 400, 401, 403, 404, 409, 429 with an error body

GitHub

GET /v1/orgs/{org}/github

GitHub App installations and the caller's GitHub connection

Path parameters

NameTypeDescription
orgstring

200 OK: OrgGithub

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/github/install-url

Where to send the browser to install the GitHub App

Path parameters

NameTypeDescription
orgstring

Query parameters

NameTypeDescription
nextoptionalstring

200 OK: InstallUrl

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/github/installations/{id}

Forget an installation

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/github/connect-url

Where to send the browser to connect a GitHub account

Request body

NameTypeDescription
nextoptionalstring

200 OK: InstallUrl

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/github/me

The caller's GitHub connection

200 OK: GithubIdentity

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/github/me

Disconnect GitHub, and remove the repositories only its token could read

200 OK: GithubDisconnectResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/github/me/disconnect-preview

Repositories that disconnecting GitHub removes

200 OK: GithubDisconnectPreview

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/github/pat

Connect with a personal access token

Request body: SetPatBody

200 OK: GithubIdentity

Errors: 400, 401, 403, 404, 409, 429 with an error body

Repositories

GET /v1/orgs/{org}/github/repos

GitHub repositories the caller can connect

Path parameters

NameTypeDescription
orgstring

Query parameters

NameTypeDescription
qoptionalstring

200 OK

NameTypeDescription
reposGithubRepo[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/repos

Repositories connected to the organization

Path parameters

NameTypeDescription
orgstring

200 OK

NameTypeDescription
reposRepo[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/repos

Connect a GitHub repository

Path parameters

NameTypeDescription
orgstring

Request body: ConnectRepoBody

200 OK: Repo

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/orgs/{org}/repos/new

Create a repository on GitHub and connect it

Path parameters

NameTypeDescription
orgstring

Request body: CreateRepoBody

200 OK: Repo

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/repos/{id}

Disconnect a repository

Path parameters

NameTypeDescription
orgstring
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/repos

Repositories mounted in a workspace

Path parameters

NameTypeDescription
wsstring

200 OK

NameTypeDescription
reposWorkspaceRepo[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/repos

Mount a repository in a workspace

Path parameters

NameTypeDescription
wsstring

Request body: MountRepoBody

200 OK: WorkspaceRepo

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/repos/{id}/fetch

Fetch the latest commits

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: WorkspaceRepo

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/repos/{id}/branches

Branches of a mounted repository, fetched from its remote first, each with its last commit (`details`, newest first)

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: RepoBranches

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/repos/{id}/pulls

Open pull requests of a mounted repository

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: RepoPulls

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/repos/{id}/issues

Open issues of a mounted repository (pull requests left out), newest first; `unavailable` without a GitHub connection

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: RepoIssues

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/repos/{id}/branch

Read the repository at another branch, and start projects from it

Path parameters

NameTypeDescription
wsstring
idstring

Request body: SetRepoBranchBody

200 OK: WorkspaceRepo

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/github/peek

What a GitHub address of a mounted repository is about (for link cards)

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
urlstring

200 OK: GithubPeek

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/repos/{id}/read-only

Mark a repository read-only in this workspace (a reference), or allow edits again

Path parameters

NameTypeDescription
wsstring
idstring

Request body: SetRepoReadOnlyBody

200 OK: WorkspaceRepo

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/repos/{id}/release

A repository left the workspace's documents: remove the workspace's copy, unless a doc or canvas still shows it or a project works in it

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: ReleaseRepoResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/workspaces/{ws}/repos/{id}

Remove a repository from a workspace

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

Files and git

GET /v1/workspaces/{ws}/fs/files

Files under a root (tracked and untracked, ignoring .gitignore'd ones)

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

200 OK: FileList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/fs/file

Read a text file

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring
pathstring

200 OK: FileContent

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/fs/file

Write a text file (merged with changes made since `base`, when given)

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring
pathstring

Request body: WriteFileBody

200 OK: WriteFileResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/fs/transfer

Copy or move a file or directory between roots (a task and the workspace)

Path parameters

NameTypeDescription
wsstring

Request body: TransferBody

200 OK: TransferResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/fs/remove

Delete files and folders under a root

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

Request body: RemovePathsBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/fs/grep

Search file contents

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring
qstring

200 OK: GrepResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/git/status

Branch, head and uncommitted changes

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

200 OK: GitStatus

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/git/commits

Commits on this branch

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring
baseoptionalstring
refoptionalstringA branch of the remote to read instead of the checked-out one (`origin/<ref>`): a repository's pushes to its default branch

200 OK

NameTypeDescription
commitsGitCommit[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/git/diff-files

Changed files for a diff target

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring
targetstring

200 OK

NameTypeDescription
filesGitFileChange[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/git/diff

Unified diff

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring
targetstring
pathoptionalstring

200 OK: GitDiff

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/git/show

A file as it is at a branch or commit

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring
refstring
pathstring

200 OK: GitFileAtRef

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/git/revert

Revert a commit with a new commit, as the caller

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

Request body

NameTypeDescription
shastring

200 OK

NameTypeDescription
shastring

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/git/commit

Commit everything, as the caller

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

Request body: CommitBody

200 OK

NameTypeDescription
shastring | null

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/git/discard

Discard uncommitted changes

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

Request body: DiscardBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/git/revert-hunk

Take one hunk of a diff back out of the working tree, uncommitted (refused when the file no longer has it)

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

Request body: RevertHunkBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/git/push

Push the branch with the caller's GitHub token

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

200 OK

NameTypeDescription
branchstring

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/git/fetch

Fetch origin for a worktree: its counts against the base are current afterwards

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

200 OK: GitStatus

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/git/pull

Fetch, then fast-forward the branch to its upstream (a diverged branch is refused, unchanged)

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

200 OK: GitPullResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/git/update

Merge the base branch into the worktree's branch, as the caller (aborted on a conflict)

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

200 OK: GitUpdateResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/git/abort

Abort the merge or rebase left half done in a worktree

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

200 OK: GitAbortResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/git/conflicts

What merging the base into the worktree's branch would conflict on (nothing is changed)

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

200 OK: GitConflicts

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/git/pr

The pull request for this branch, if any

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

200 OK: PullRequestState

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/git/pr

Open a pull request as the caller

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

Request body: OpenPrBody

200 OK: PullRequest

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/git/pr/merge

Merge the pull request as the caller

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
scope"workspace" | "container" | "worktree" | "repo"
containeroptionalstring
repooptionalstring

Request body: MergePrBody

200 OK: PullRequest

Errors: 400, 401, 403, 404, 409, 429 with an error body

Agent accounts

GET /v1/agent/catalog

Agents that can be connected, with their models: for Codex, the ones its CLI offers the caller's account, once it said. An empty defaultModel: the CLI's own default for the account.

200 OK

NameTypeDescription
agentsobject[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/agent-accounts

The caller's agent accounts

200 OK

NameTypeDescription
accountsAgentAccount[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/agent-accounts

Add an agent account (then sign it in)

Request body: CreateAgentAccountBody

200 OK: AgentAccount

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/agent-accounts/{id}

Rename an agent account

Path parameters

NameTypeDescription
idstring

Request body: RenameAgentAccountBody

200 OK: AgentAccount

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/agent-accounts/{id}

Remove an agent account and its stored credentials

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/agent-accounts/{id}/active

Use this account for its agent's turns

Path parameters

NameTypeDescription
idstring

200 OK: AgentAccount

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/agent-accounts/{id}/workspaces/{ws}

Pin this account to a workspace: it runs only there

Path parameters

NameTypeDescription
idstring
wsstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/agent-accounts/{id}/workspaces/{ws}

Unpin this account from a workspace

Path parameters

NameTypeDescription
idstring
wsstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/agent-accounts/{id}/login

Where the sign-in stands

Path parameters

NameTypeDescription
idstring

200 OK: AgentLoginState

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/agent-accounts/{id}/login

Start signing in (runs the agent's own login on a runner)

Path parameters

NameTypeDescription
idstring

Request body: StartAgentLoginBody

200 OK: AgentLoginState

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/agent-accounts/{id}/login/code

Submit the code the provider showed

Path parameters

NameTypeDescription
idstring

Request body: AgentLoginCodeBody

200 OK: AgentLoginState

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/agent-accounts/{id}/login/terminal

Open the running sign-in's CLI as a terminal, to drive it by hand (the caller's own sign-in only)

Path parameters

NameTypeDescription
idstring

200 OK: AgentLoginTerminal

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/agent-accounts/{id}/login/cancel

Abandon the sign-in

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

Chat

GET /v1/workspaces/{ws}/chat

Your own chat in the workspace, or in one of its projects (made when you have none)

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
containeroptionalstring
canvasoptionalstring

200 OK: Chat

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/chats

Everyone's chats in the workspace, or in one of its projects; of one doc

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
containeroptionalstring
canvasoptionalstring
docoptional"none" | string

200 OK

NameTypeDescription
chatsChatSummary[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/chats

Start another chat of your own in the workspace, or in one of its projects: a new tab (stored with the doc it was started from)

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
containeroptionalstring
canvasoptionalstring
docoptionalstring

Request body: CreateChatBody

200 OK: Chat

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/chats/all

Every chat of the workspace the caller may read, each with the place it belongs to (All chats)

Path parameters

NameTypeDescription
wsstring

200 OK

NameTypeDescription
chatsChatOverview[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/block-chats

How the blocks' own chats are doing, on the tabs you may open: whether the agent works and what it is doing right now. `sheet`: one tab only (`first` for the first tab). Changes arrive as `block-chat.changed` on the workspace's channel

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
sheetoptionalstring

200 OK

NameTypeDescription
chatsBlockChatState[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/block-chats

The own chat of a block on a tab (a prototype, a stat), made when the block has none: one per block, whoever asks. It is an ordinary chat (same turns, messages and tool calls) that is not among the workspace's chat tabs

Path parameters

NameTypeDescription
wsstring

Request body: OpenBlockChatBody

200 OK: Chat

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/chats/{id}

A chat: recent messages, what is queued, and the turn in progress

Path parameters

NameTypeDescription
idstring

200 OK: Chat

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/chats/{id}

Close a chat of your own: its tab goes away, its messages are kept

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/clear

Clear a chat of your own: it is closed and an empty one takes its place, so the agent starts fresh

Path parameters

NameTypeDescription
idstring

200 OK: Chat

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/chats/{id}/messages

Older messages

Path parameters

NameTypeDescription
idstring

Query parameters

NameTypeDescription
beforeinteger

200 OK

NameTypeDescription
messagesChatMessage[]
hasMoreboolean

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/messages

Send a message to the agent (queued if it is busy)

Path parameters

NameTypeDescription
idstring

Request body: SendChatBody

200 OK: ChatQueueItem

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/fork

Write into someone else's chat: starts a chat of your own that quotes theirs, and sends the message there

Path parameters

NameTypeDescription
idstring

Request body: SendChatBody

200 OK

NameTypeDescription
chatChat
itemChatQueueItem

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/continue

Summarize and continue someone else's chat: your agent summarizes it (one question, no tools, on your own agent account; Claude Code only, else 409 `agent_unsupported`) into a new chat of your own that starts from the summary, then `text` is sent there. 409 `your_chat` on a chat of your own.

Path parameters

NameTypeDescription
idstring

Request body: ContinueChatBody

200 OK: ContinueChatResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/terminal

Open the chat's agent as its own CLI (Claude Code, Codex) in a terminal session that carries the chat's conversation on: its owner types in it, other editors watch, and the chat follows it. Answers the live session's terminal if there is one. Only the chat's owner. While a headless turn runs nothing is stopped: the answer is `pending` with a null `terminalId`, and the session opens once the turn is over (`Chat.terminalPending`; `DELETE` takes the request back).

Path parameters

NameTypeDescription
idstring

Request body: OpenChatTerminalBody

200 OK: ChatTerminal

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/chats/{id}/terminal

End the chat's terminal session: the agent's CLI is hung up on, and the next message carries the conversation on. One asked for while a turn runs (`pending`) no longer opens.

Path parameters

NameTypeDescription
idstring

200 OK

NameTypeDescription
endedboolean

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/chats/{id}/queue/{item}

Change the words of a message that has not started; it keeps its place in the queue. Its author or the chat's owner. 409 `queue_item_taken` once the turn took it (or it is on its way into the running turn), 409 `cannot_edit` for an item Yard queued itself.

Path parameters

NameTypeDescription
idstring
itemstring

Request body: EditQueuedBody

200 OK: ChatQueueItem

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/chats/{id}/queue/{item}

Take back a message that has not started

Path parameters

NameTypeDescription
idstring
itemstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/queue/{item}/steer

Push a message that has not started into the running turn: the agent reads it at its next step, without stopping. `steered` is false when the runner could not take it now; it then stays queued and runs next. 409 `cannot_steer` when the turn or the message cannot be steered (the turn waits in the runner's queue, its agent takes no messages while it works, the message is held or not a chat message). Same access as taking the message back.

Path parameters

NameTypeDescription
idstring
itemstring

200 OK

NameTypeDescription
steeredboolean

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/chats/{id}/queue

Clear the messages that have not started (an owner clears everyone's, anyone else their own)

Path parameters

NameTypeDescription
idstring

200 OK

NameTypeDescription
removedinteger

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/cancel

Stop the running turn; with none, the work the agent left running in the box (a project's through its own Stop)

Path parameters

NameTypeDescription
idstring

200 OK

NameTypeDescription
stoppedboolean

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/subagents/{subagentId}/stop

Stop one subagent of the running turn (by the id of the tool call that launched it); the turn goes on. `stopped` is false when it does not run, or its agent CLI cannot stop it alone.

Path parameters

NameTypeDescription
idstring
subagentIdstring

200 OK

NameTypeDescription
stoppedboolean

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/background/{processId}/stop

Stop one process the agent left running in the box (SIGTERM, then SIGKILL after a grace period); the others go on. Once none runs, the agent resumes in this chat. `stopped` is false when it had already ended.

Path parameters

NameTypeDescription
idstring
processIdstring

200 OK

NameTypeDescription
stoppedboolean

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/start-now

Start the turn that waits in the runner's queue now, over the runner's limit (on an official runner: instance admins only). While it waits for the runner's load, only with `confirmLoad=true` (the person saw the warning); otherwise 409 `runner_overloaded`.

Path parameters

NameTypeDescription
idstring

Query parameters

NameTypeDescription
confirmLoadoptional"true" | "false"

200 OK

NameTypeDescription
startedboolean

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/retry

Send again what the chat's last turn was asked, after it ended in an error; it carries on from the conversation so far

Path parameters

NameTypeDescription
idstring

200 OK: ChatQueueItem

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/resume

Carry on the chat's last turn after the runner went offline while the agent was working: the agent picks up where it left off; the message is not sent again. Queued, so it waits for an offline runner. 409 `nothing_to_resume` when the last turn was not cut off.

Path parameters

NameTypeDescription
idstring

200 OK

NameTypeDescription
queueChatQueueItem[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/chats/{id}/usage

The chat's AI usage: its turns' tokens and cost, and, for the chat's owner only, the latest plan limits their agent account reported

Path parameters

NameTypeDescription
idstring

200 OK: ChatUsage

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/resume-usage

Usage is available again for the agent account holding this chat's messages: they, and the account's other held messages, go back into the queue

Path parameters

NameTypeDescription
idstring

200 OK

NameTypeDescription
chatsinteger

Errors: 400, 401, 403, 404, 409, 429 with an error body

Crew

GET /v1/chats/{id}/children

A chat's child threads and second opinions. Each stops with `POST /v1/chats/{child}/cancel`

Path parameters

NameTypeDescription
idstring

200 OK: ChatChildren

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/second-opinions

Ask another agent, in a child chat. The chat's own agent sees nothing of it until it is sent

Path parameters

NameTypeDescription
idstring

Request body: AskSecondOpinionBody

200 OK: SecondOpinionResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/second-opinions/{child}/send

Send the answer to the chat's own agent. 409 `no_answer_yet`, `already_sent`

Path parameters

NameTypeDescription
idstring
childstring

Request body: SendSecondOpinionBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/second-opinions/{child}/follow-up

Ask the second opinion's agent a follow-up

Path parameters

NameTypeDescription
idstring
childstring

Request body: SecondOpinionFollowUpBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/second-opinions/{child}/dismiss

Stop and close a second opinion without sending it

Path parameters

NameTypeDescription
idstring
childstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/steps/start

Run a message's proposed steps as child threads through the resolver, in order and side by side, up to the workspace's children at once

Path parameters

NameTypeDescription
idstring

Request body: StartStepsBody

200 OK: StartStepsResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/held/choose

Nobody was left on the list and the workspace asks: this agent takes the chat's waiting messages

Path parameters

NameTypeDescription
idstring

Request body: ChooseHeldBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/crew

The workspace's rules and crew settings, for everyone in it

Path parameters

NameTypeDescription
wsstring

200 OK: CrewOverview

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/workspaces/{ws}/crew

Change the crew settings: what happens when nobody is left, whether agents may message each other, the turn limit and the delegation limits

Path parameters

NameTypeDescription
wsstring

Request body: UpdateCrewSettingsBody

200 OK: CrewOverview

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/crew/rules

Add a rule

Path parameters

NameTypeDescription
wsstring

Request body: CreateCrewRuleBody

200 OK: CrewRule

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/crew/rules/order

Put the rules in this order

Path parameters

NameTypeDescription
wsstring

Request body: OrderBody

200 OK: CrewOverview

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/crew-rules/{id}

Change a rule. Making it the default takes that from the rule that was

Path parameters

NameTypeDescription
idstring

Request body: UpdateCrewRuleBody

200 OK: CrewRule

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/crew-rules/{id}

Remove a rule. 409 `crew_rule_default` for the default one

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/crew

A project's rules: the workspace's, with what the project changed (`changed`)

Path parameters

NameTypeDescription
idstring

200 OK: CrewOverview

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/containers/{id}/crew/{rule}

Change a rule for this project

Path parameters

NameTypeDescription
idstring
rulestring

Request body: CrewRuleOverrideBody

200 OK: CrewRule

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/containers/{id}/crew/{rule}

Reset a rule to the workspace's for this project

Path parameters

NameTypeDescription
idstring
rulestring

200 OK: CrewRule

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/agents

The workspace's agents, for everyone in it: instructions must not hold secrets

Path parameters

NameTypeDescription
wsstring

200 OK: WorkspaceAgentList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/agents

Add an agent to the workspace

Path parameters

NameTypeDescription
wsstring

Request body: CreateWorkspaceAgentBody

200 OK: WorkspaceAgent

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/agents/order

Put the workspace's agents in this order

Path parameters

NameTypeDescription
wsstring

Request body: OrderBody

200 OK: WorkspaceAgentList

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/workspace-agents/{id}

Change a workspace's agent: its name, model, effort, instructions, or whether it is on

Path parameters

NameTypeDescription
idstring

Request body: UpdateWorkspaceAgentBody

200 OK: WorkspaceAgent

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/workspace-agents/{id}

Remove a workspace's agent, also from every rule. 409 `crew_rule_empty` when a rule has nobody else

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/agent-accounts

Your own accounts bound to this workspace, in the order they are tried. Nobody else's are ever listed

Path parameters

NameTypeDescription
wsstring

200 OK: BoundAccountList

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/agent-accounts

Bind your own accounts to this workspace, in order and each with the rules it may serve: what is not listed is unbound. Someone else's account is a 404

Path parameters

NameTypeDescription
wsstring

Request body: BindAccountsBody

200 OK: BoundAccountList

Errors: 400, 401, 403, 404, 409, 429 with an error body

Containers

GET /v1/workspaces/{ws}/containers

Containers in a workspace (open ones, or the closed ones with closed=true); with parentId, only that project's sub-projects

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
closedoptional"true" | "false"
parentIdoptionalstring

200 OK

NameTypeDescription
containersContainer[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/containers

Create a container from instructions, selected blocks and repositories

Path parameters

NameTypeDescription
wsstring

Request body: CreateContainerBody

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/containers/purge-closed

Delete every closed container of the workspace for good

Path parameters

NameTypeDescription
wsstring

200 OK

NameTypeDescription
deletedinteger

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/containers/by-slug/{slug}

A container by its directory name

Path parameters

NameTypeDescription
wsstring
slugstring

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/chat-logs

What the chat-log blocks show, including for deleted containers

Path parameters

NameTypeDescription
wsstring

200 OK

NameTypeDescription
logsobject[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}

A container, with fresh branch state when its runner is online

Path parameters

NameTypeDescription
idstring

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/containers/{id}

Rename a container, or (owners) give its box limits of its own

Path parameters

NameTypeDescription
idstring

Request body: UpdateContainerBody

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/containers/{id}

Delete a container (its chat log stays). With unmerged monitors it needs `outputs=merge|delete` (409 `unmerged_outputs` without)

Path parameters

NameTypeDescription
idstring

Query parameters

NameTypeDescription
forceoptional"true" | "false"
outputsoptional"merge" | "delete"

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/close

Close a container: it is archived and can be reopened. With unmerged monitors it needs `outputs=merge|delete` (409 `unmerged_outputs` without). Its open sub-projects are closed too with `children=close`, or move up a level (`keep`, the default)

Path parameters

NameTypeDescription
idstring

Query parameters

NameTypeDescription
forceoptional"true" | "false"
outputsoptional"merge" | "delete"
childrenoptional"close" | "keep"

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/children

This project's open sub-projects

Path parameters

NameTypeDescription
idstring

200 OK: SubProjects

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/children

Sub-projects of this project, made in one call (at most 50): each set up but not started, its instructions as its spec draft, with the parent's repositories (from the parent's branch unless `base: main`), linked blocks and agent choice. No agent turn runs for any of them

Path parameters

NameTypeDescription
idstring

Request body: CreateSubProjectsBody

200 OK: SubProjects

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/outputs

Made by this project: the monitors its agent made that are not merged into the workspace yet, with their linked files and what each still needs, and the document a merge would use

Path parameters

NameTypeDescription
idstring

200 OK: ContainerOutputs

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/merge-outputs

Merge into the workspace: the project's ready monitors (or the ready ones among `ids`) are turned on and get a block in a document of the workspace; the others stay in the project

Path parameters

NameTypeDescription
idstring

Request body: MergeOutputsBody

200 OK: MergeOutputsResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/reopen

Reopen a closed container

Path parameters

NameTypeDescription
idstring

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/chat-log-block

Put the conversation on the workspace canvas as a chat-log block

Path parameters

NameTypeDescription
idstring

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/retry

Retry a container whose creation failed

Path parameters

NameTypeDescription
idstring

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/repos

Check repositories out in the container (new worktrees, read-only checkouts, or read-only ones made writable)

Path parameters

NameTypeDescription
idstring

Request body: AttachContainerReposBody

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/start

Work: the agent implements the spec

Path parameters

NameTypeDescription
idstring

Request body: StartContainerBody

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/stop

Stop the agent and the work it left running in the box (a container being worked on returns to draft, or to done when its progress file says the work is finished)

Path parameters

NameTypeDescription
idstring

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/test-runs/{runId}/base

Run a failed test run of the agent's (`yard run`) again on the base branch, as `yard tests base` does, to tell which failures were there before this project. Answers once it is checking, with the run (`base.state` `checking`); the result arrives with the project's runs. 404 `no_test_run` for a run that did not fail with its failures named, 409 `no_setup` without a setup to install the base with, 409 `already_checking`.

Path parameters

NameTypeDescription
idstring
runIdstring

200 OK: TestRun

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/done

Mark the work as done

Path parameters

NameTypeDescription
idstring

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/accept-criteria

Accept a done project as it is, with acceptance criteria still unticked

Path parameters

NameTypeDescription
idstring

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/criteria/skip

Skip one acceptance criterion: it counts as skipped, not met, and no longer holds up merging

Path parameters

NameTypeDescription
idstring

Request body: SkipCriterionBody

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/criteria/restore

Take back the skip of an acceptance criterion: it is open again

Path parameters

NameTypeDescription
idstring

Request body: RestoreCriterionBody

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/push

Push every worktree branch with the caller's GitHub token

Path parameters

NameTypeDescription
idstring

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/prs

Open pull requests as the caller

Path parameters

NameTypeDescription
idstring

Request body: ContainerPrsBody

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/merge

Merge the open pull requests as the caller

Path parameters

NameTypeDescription
idstring

Request body: ContainerMergeBody

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/links

Link workspace blocks into the container

Path parameters

NameTypeDescription
idstring

Request body: ContainerBlocksBody

200 OK

NameTypeDescription
copiedinteger

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/attachments

The files attached to the project after it was made

Path parameters

NameTypeDescription
idstring

200 OK: ContainerAttachments

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/attachments

Attach an uploaded file to the project: it is listed under Context, and the project's agent is told at its next step

Upload the bytes first with `POST /v1/workspaces/{ws}/uploads` (`container`: the project's directory name, `purpose: "attachments"`), then send the ticket's `path` here.

Path parameters

NameTypeDescription
idstring

Request body: AttachContainerFileBody

200 OK: ContainerAttachments

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/containers/{id}/repos/order

The order the project's worktrees deploy and merge in

Path parameters

NameTypeDescription
idstring

Request body: ContainerRepoOrderBody

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/follow-ups

A follow-up worktree: a new branch on top of one of the project's, whose pull request goes into it

Path parameters

NameTypeDescription
idstring

Request body: CreateFollowUpBody

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/containers/{id}/follow-ups/{linkId}

Whether a follow-up moves by itself when what it follows changes

Path parameters

NameTypeDescription
idstring
linkIdstring

Request body: UpdateFollowUpBody

200 OK: Container

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/attachments/from-origin

Attach a file of the workspace, kept live, as a copy, as a link or at a commit

Path parameters

NameTypeDescription
idstring

Request body: AttachOriginBody

200 OK: ContainerAttachments

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/attachments/since

Since then: which attachments' origins changed, and which copies were edited

Path parameters

NameTypeDescription
idstring

200 OK: AttachmentsSince

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/containers/{id}/attachments/{attachmentId}

Change how an attachment is kept

Path parameters

NameTypeDescription
idstring
attachmentIdstring

Request body: UpdateAttachmentBody

200 OK: ContainerAttachments

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/containers/{id}/attachments/{attachmentId}

Take an attached file off the project

Path parameters

NameTypeDescription
idstring
attachmentIdstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/attachments/{attachmentId}/update

Update: copy the origin again. Local edits are refused unless `force`

Path parameters

NameTypeDescription
idstring
attachmentIdstring

Request body: RefreshAttachmentBody

200 OK: ContainerAttachments

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/sync-back

Bring container-canvas edits to the workspace originals, merged with the workspace's own changes; what cannot be merged is a conflict

Path parameters

NameTypeDescription
idstring

Request body: ContainerBlocksBody

200 OK: SyncBackResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/discard-edits

Throw away container-canvas edits

Path parameters

NameTypeDescription
idstring

Request body: ContainerBlocksBody

200 OK

NameTypeDescription
copiedinteger

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/report

The project's report: what the agent wrote up when the work was done, as Markdown (404 `report_not_found` without one). A closed project keeps it

Path parameters

NameTypeDescription
idstring

200 OK: ContainerReport

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/follow-ups/feedback

Add the follow-ups of the project's report to the workspace's feedback, one entry each linking back to the project. Closing a project does it; adding them again adds nothing

Path parameters

NameTypeDescription
idstring

200 OK: ContainerFollowUpEntries

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/archive

What a closed project keeps in the archive, to read: its spec as it was when it was closed and the blocks of its document (409 `not_closed` for an open project)

Path parameters

NameTypeDescription
idstring

200 OK: ContainerArchive

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/merge-queue

The workspace's merge queue: active items in order, failed ones, recently finished ones

Path parameters

NameTypeDescription
wsstring

200 OK: MergeQueue

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/merge-queue

Queue Done projects for merge, at the end and in the given order; the others are skipped with the reason

Path parameters

NameTypeDescription
wsstring

Request body: EnqueueMergeBody

200 OK: EnqueueMergeResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/workspaces/{ws}/merge-queue/{containerId}

Take a project out of the merge queue

Path parameters

NameTypeDescription
wsstring
containerIdstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/merge-queue/{containerId}/retry

Put a project whose merge failed back at the end of the queue

Path parameters

NameTypeDescription
wsstring
containerIdstring

200 OK: MergeQueue

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/merge-queue/pause

Pause the merge queue: nothing in it moves on until it is resumed

Path parameters

NameTypeDescription
wsstring

200 OK: MergeQueue

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/merge-queue/resume

Resume a paused merge queue where it stopped

Path parameters

NameTypeDescription
wsstring

200 OK: MergeQueue

Errors: 400, 401, 403, 404, 409, 429 with an error body

Apps

GET /v1/workspaces/{ws}/apps/{repo}/{name}/env

Every variable one app of the workspace runs with: its value (a secret's is never returned), where it comes from (injected, a database, a link to a sibling app, the app's own default, or a layer's env value) and whether it needs a value or links to an app that is not there

Path parameters

NameTypeDescription
wsstring
repostring
namestring

200 OK: AppResolvedEnv

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/apps/{repo}/{name}/env

Every variable one app of a project runs with, its source and status (the project's values over the workspace's)

Path parameters

NameTypeDescription
idstring
repostring
namestring

200 OK: AppResolvedEnv

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/apps/{repo}/{name}/env/{var}

Set one variable for one app in the workspace's env: a value of that app's own, which wins over what it inherits at the next start

Path parameters

NameTypeDescription
wsstring
repostring
namestring
varstring

Request body: PutAppEnvVarBody

200 OK: AppResolvedEnv

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/workspaces/{ws}/apps/{repo}/{name}/env/{var}

Remove one app's own value of a variable from the workspace's env: the app gets what it inherits again. 404 `env_not_found` when it has none.

Path parameters

NameTypeDescription
wsstring
repostring
namestring
varstring

200 OK: AppResolvedEnv

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/containers/{id}/apps/{repo}/{name}/env/{var}

Set one variable for one app in the project's env: it wins over the workspace's at the next start

Path parameters

NameTypeDescription
idstring
repostring
namestring
varstring

Request body: PutAppEnvVarBody

200 OK: AppResolvedEnv

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/containers/{id}/apps/{repo}/{name}/env/{var}

Remove one app's own value of a variable from the project's env. 404 `env_not_found` when it has none.

Path parameters

NameTypeDescription
idstring
repostring
namestring
varstring

200 OK: AppResolvedEnv

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/apps/env

The workspace's env values for apps (secret values are never returned)

Path parameters

NameTypeDescription
wsstring

200 OK: AppEnvList

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/apps/env

Replace the workspace's env values for apps; a secret sent without a value keeps the stored one

Path parameters

NameTypeDescription
wsstring

Request body: PutAppEnvBody

200 OK: AppEnvList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/apps/env

The project's env values for apps (secret values are never returned)

Path parameters

NameTypeDescription
idstring

200 OK: AppEnvList

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/containers/{id}/apps/env

Replace the project's env values for apps; they win over the workspace's

Path parameters

NameTypeDescription
idstring

Request body: PutAppEnvBody

200 OK: AppEnvList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/app-environments/{env}/env

An environment's own env values for apps, which win over the workspace's for its apps only (secret values are never returned)

Path parameters

NameTypeDescription
wsstring
envstring

200 OK: AppEnvList

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/app-environments/{env}/env

Replace an environment's own env values for apps; a secret sent without a value keeps the stored one

Path parameters

NameTypeDescription
wsstring
envstring

Request body: PutAppEnvBody

200 OK: AppEnvList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/app-environments/{env}/apps/{repo}/{name}/env

Every variable one app of an environment runs with, its source and status (the environment's values over the workspace's)

Path parameters

NameTypeDescription
wsstring
envstring
repostring
namestring

200 OK: AppResolvedEnv

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/app-environments/{env}/apps/{repo}/{name}/env/{var}

Set one variable for one app in an environment's env: it wins over the workspace's for that environment at the next start

Path parameters

NameTypeDescription
wsstring
envstring
repostring
namestring
varstring

Request body: PutAppEnvVarBody

200 OK: AppResolvedEnv

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/workspaces/{ws}/app-environments/{env}/apps/{repo}/{name}/env/{var}

Remove one app's own value of a variable from an environment's env. 404 `env_not_found` when it has none.

Path parameters

NameTypeDescription
wsstring
envstring
repostring
namestring
varstring

200 OK: AppResolvedEnv

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/apps

The workspace's app configs (its own layer)

Path parameters

NameTypeDescription
wsstring

200 OK: AppConfigList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/apps/{repo}/{name}

One app config of the workspace layer

Path parameters

NameTypeDescription
wsstring
repostring
namestring

200 OK: AppConfig

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/apps/{repo}/{name}

Create or replace an app in the workspace layer (every project of the workspace sees it); disabled hides an org default

Path parameters

NameTypeDescription
wsstring
repostring
namestring

Request body: PutAppConfigBody

200 OK: AppConfig

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/workspaces/{ws}/apps/{repo}/{name}

Remove an app from the workspace layer

Path parameters

NameTypeDescription
wsstring
repostring
namestring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/apps/{repo}/save-as-default

Make the workspace's apps of a repository the org default for it (org admins)

Path parameters

NameTypeDescription
wsstring
repostring

200 OK: AppConfigList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/apps/settings

Which runner the workspace's apps run on, the domains it can use and the one in use, and who can open new project previews

Path parameters

NameTypeDescription
wsstring

200 OK: WorkspaceAppsSettings

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/apps/settings

Choose the runner the workspace's apps run on (null: its own runner if it hosts, else one of the org's), the domain their addresses are under (null: the runner's default) and who can open new project previews; only the fields sent change

Path parameters

NameTypeDescription
wsstring

Request body: PutWorkspaceAppsSettingsBody

200 OK: WorkspaceAppsSettings

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/apps/config/{repo}/{name}

A project-layer app config

Path parameters

NameTypeDescription
idstring
repostring
namestring

200 OK: AppConfig

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/containers/{id}/apps/config/{repo}/{name}

Create or replace an app in the project layer (only this project sees it); disabled hides an inherited app here

Path parameters

NameTypeDescription
idstring
repostring
namestring

Request body: PutAppConfigBody

200 OK: AppConfig

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/containers/{id}/apps/config/{repo}/{name}

Remove an app from the project layer

Path parameters

NameTypeDescription
idstring
repostring
namestring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/apps/config/{repo}/{name}/promote

Move a project-layer app to the workspace layer, so every project sees it

Path parameters

NameTypeDescription
idstring
repostring
namestring

200 OK: AppConfig

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/orgs/{org}/repos/{repo}/apps

The org default apps of a repository

Path parameters

NameTypeDescription
orgstring
repostring

200 OK: AppConfigList

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/orgs/{org}/repos/{repo}/apps/{name}

Create or replace an org default app (org admins)

Path parameters

NameTypeDescription
orgstring
repostring
namestring

Request body: PutAppConfigBody

200 OK: AppConfig

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/orgs/{org}/repos/{repo}/apps/{name}

Remove an org default app (org admins)

Path parameters

NameTypeDescription
orgstring
repostring
namestring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/messages/{messageId}/apps/{index}

Save an app the agent proposed in a chat (the card at `index` of the message), as the person edited it, to the workspace or to a project; saving it again replaces the config. Its secrets become env values of that app in the same layer: a generated one is made and sealed here (never returned), another is left without a value, and a name that already applies to the app is not touched. 404 `action_not_found` when there is no app proposal there.

Path parameters

NameTypeDescription
idstring
messageIdstring
indexoptionalinteger | null

Request body: ConfirmAppProposalBody

200 OK: AppConfig

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/messages/{messageId}/apps/{index}/skip

Skip an app the agent proposed in a chat: nothing is saved, the card says so

Path parameters

NameTypeDescription
idstring
messageIdstring
indexoptionalinteger | null

200 OK: ChatMessage

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/apps

A project's apps: their config after the layers are merged, and their instances on the runner that hosts them

Path parameters

NameTypeDescription
idstring

200 OK: ProjectApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/apps/{repo}/{name}/start

Start an app (and what it depends on)

Path parameters

NameTypeDescription
idstring
repostring
namestring

Request body: AppActionBody

200 OK: ProjectApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/apps/{repo}/{name}/stop

Stop an app; its data stays

Path parameters

NameTypeDescription
idstring
repostring
namestring

Request body: AppActionBody

200 OK: ProjectApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/apps/{repo}/{name}/restart

Restart an app; it is rebuilt only when the source changed

Path parameters

NameTypeDescription
idstring
repostring
namestring

Request body: AppActionBody

200 OK: ProjectApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/apps/{repo}/{name}/reset

Remove an app's container, image and logs, and its data unless keepData

Path parameters

NameTypeDescription
idstring
repostring
namestring

Request body: AppActionBody

200 OK: ProjectApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/apps/start

Start every app of the project, in dependency order

Path parameters

NameTypeDescription
idstring

Request body: AppActionBody

200 OK: ProjectApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/apps/stop

Stop every app of the project

Path parameters

NameTypeDescription
idstring

Request body: AppActionBody

200 OK: ProjectApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/apps/reset

Reset every app of the project

Path parameters

NameTypeDescription
idstring

Request body: AppActionBody

200 OK: ProjectApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/apps/view

A workspace's own apps (run from its copy of each repository, on the base branch) with their instances, and the previews of its open projects

Path parameters

NameTypeDescription
wsstring

200 OK: WorkspaceApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/apps/running

How many of the workspace's own apps run right now

Path parameters

NameTypeDescription
wsstring

200 OK: WorkspaceAppsRunning

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/apps/{repo}/{name}/start

Start an app of the workspace itself (and what it depends on), from the workspace's copy of the repository

Path parameters

NameTypeDescription
wsstring
repostring
namestring

Request body: AppActionBody

200 OK: WorkspaceApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/apps/{repo}/{name}/stop

Stop a workspace app; its data stays

Path parameters

NameTypeDescription
wsstring
repostring
namestring

Request body: AppActionBody

200 OK: WorkspaceApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/apps/{repo}/{name}/restart

Restart a workspace app; it is rebuilt only when the source changed

Path parameters

NameTypeDescription
wsstring
repostring
namestring

Request body: AppActionBody

200 OK: WorkspaceApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/apps/{repo}/{name}/reset

Remove a workspace app's container, image and logs, and its data unless keepData

Path parameters

NameTypeDescription
wsstring
repostring
namestring

Request body: AppActionBody

200 OK: WorkspaceApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/apps/start

Start every app of the workspace itself, in dependency order

Path parameters

NameTypeDescription
wsstring

Request body: AppActionBody

200 OK: WorkspaceApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/apps/stop

Stop every app of the workspace itself

Path parameters

NameTypeDescription
wsstring

Request body: AppActionBody

200 OK: WorkspaceApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/apps/reset

Reset every app of the workspace itself

Path parameters

NameTypeDescription
wsstring

Request body: AppActionBody

200 OK: WorkspaceApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/apps/{repo}/{name}/logs

The backlog of a workspace app's build and run log; ask again with since for what came after

Path parameters

NameTypeDescription
wsstring
repostring
namestring

Query parameters

NameTypeDescription
sinceoptionalinteger | null
tailoptionalinteger

200 OK: AppLogs

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/apps/{repo}/{name}/terminal

Open a shell in the app's container (it must be running); the terminal then attaches over the usual terminal socket

Path parameters

NameTypeDescription
idstring
repostring
namestring

200 OK: Terminal

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/apps/{repo}/{name}/terminal

Open a shell in the app's container (it must be running); the terminal then attaches over the usual terminal socket

Path parameters

NameTypeDescription
wsstring
repostring
namestring

200 OK: Terminal

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/apps/{repo}/{name}/logs

The backlog of an app's build and run log (live lines follow as app.log events)

Path parameters

NameTypeDescription
idstring
repostring
namestring

Query parameters

NameTypeDescription
sinceoptionalinteger | null
tailoptionalinteger

200 OK: AppLogs

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/apps/{repo}/{name}/db/tables

Tables of a database app

Path parameters

NameTypeDescription
idstring
repostring
namestring

200 OK

NameTypeDescription
tablesDbTable[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/apps/{repo}/{name}/db/rows

A page of rows of one table of a database app

Path parameters

NameTypeDescription
idstring
repostring
namestring

Query parameters

NameTypeDescription
tablestring
offsetoptionalinteger | null
limitoptionalinteger

200 OK: DbRows

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/apps/{repo}/{name}/db/query

A read-only query on a database app (writes are refused)

Path parameters

NameTypeDescription
idstring
repostring
namestring

Request body: DbQueryBody

200 OK: DbRows

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/hosted/auth/ticket

A short-lived ticket that opens one team app's host for the caller, if they can see its project

Request body: HostedTicketBody

200 OK: HostedTicket

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/app-environments

A workspace's app environments: named sets of its apps with no project behind them, each from a branch chosen per repository

Path parameters

NameTypeDescription
wsstring

200 OK: AppEnvironmentList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/app-environments

Make an environment (409 `slug_taken`, 409 `too_many_environments` past 10); with start, its apps start at once from their branches

Path parameters

NameTypeDescription
wsstring

Request body: CreateAppEnvironmentBody

201 OK: AppEnvironment

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/workspaces/{ws}/app-environments/{env}

Rename an environment, or give repositories another branch: their running apps restart with the new source

Path parameters

NameTypeDescription
wsstring
envstring

Request body: PatchAppEnvironmentBody

200 OK: AppEnvironment

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/workspaces/{ws}/app-environments/{env}

Delete an environment: its apps are taken down with their data (volumes, database credentials, names on the edge, network) and its env values go

Path parameters

NameTypeDescription
wsstring
envstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/app-environments/{env}/view

An environment's apps with their instances, as the workspace's own are listed

Path parameters

NameTypeDescription
wsstring
envstring

200 OK: AppEnvironmentApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/app-environments/{env}/apps/{repo}/{name}/start

Start an app of an environment (and what it depends on), from its branch

Path parameters

NameTypeDescription
wsstring
envstring
repostring
namestring

Request body: AppActionBody

200 OK: AppEnvironmentApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/app-environments/{env}/apps/{repo}/{name}/stop

Stop an environment's app; its data stays

Path parameters

NameTypeDescription
wsstring
envstring
repostring
namestring

Request body: AppActionBody

200 OK: AppEnvironmentApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/app-environments/{env}/apps/{repo}/{name}/restart

Restart an environment's app; it is rebuilt only when the source changed

Path parameters

NameTypeDescription
wsstring
envstring
repostring
namestring

Request body: AppActionBody

200 OK: AppEnvironmentApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/app-environments/{env}/apps/{repo}/{name}/reset

Remove an environment app's container, image and logs, and its data unless keepData

Path parameters

NameTypeDescription
wsstring
envstring
repostring
namestring

Request body: AppActionBody

200 OK: AppEnvironmentApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/app-environments/{env}/apps/start

Start every app of an environment, in dependency order

Path parameters

NameTypeDescription
wsstring
envstring

Request body: AppActionBody

200 OK: AppEnvironmentApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/app-environments/{env}/apps/stop

Stop every app of an environment

Path parameters

NameTypeDescription
wsstring
envstring

Request body: AppActionBody

200 OK: AppEnvironmentApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/app-environments/{env}/apps/reset

Reset every app of an environment

Path parameters

NameTypeDescription
wsstring
envstring

Request body: AppActionBody

200 OK: AppEnvironmentApps

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/app-environments/{env}/apps/{repo}/{name}/logs

The backlog of an environment app's build and run log; ask again with since for what came after

Path parameters

NameTypeDescription
wsstring
envstring
repostring
namestring

Query parameters

NameTypeDescription
sinceoptionalinteger | null
tailoptionalinteger

200 OK: AppLogs

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/app-environments/{env}/apps/{repo}/{name}/terminal

Open a shell in an environment app's container (it must be running)

Path parameters

NameTypeDescription
wsstring
envstring
repostring
namestring

200 OK: Terminal

Errors: 400, 401, 403, 404, 409, 429 with an error body

Review

GET /v1/containers/{id}/review

The review digest of a project's repository at its current head, with this user's read ticks that still hold. A head with no digest starts one on the runner and answers `pending`: poll until `ready`

Path parameters

NameTypeDescription
idstring

Query parameters

NameTypeDescription
repooptionalstring

200 OK: ReviewState

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/containers/{id}/review/read/{changeId}

Tick a change as read by this user. The tick holds while the change keeps this content hash: a later commit that changes it clears it

Path parameters

NameTypeDescription
idstring
changeIdstring

Query parameters

NameTypeDescription
repooptionalstring

Request body: ReviewReadBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/containers/{id}/review/read/{changeId}

Take this user's tick off a change

Path parameters

NameTypeDescription
idstring
changeIdstring

Query parameters

NameTypeDescription
repooptionalstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/review/checklist

The digest's Before you deploy items as a Markdown checklist (409 `digest_not_ready` before the first digest)

Path parameters

NameTypeDescription
idstring

Query parameters

NameTypeDescription
repooptionalstring

200 OK: ReviewChecklist

Errors: 400, 401, 403, 404, 409, 429 with an error body

Previews

GET /v1/containers/{id}/previews

The ports something in a project's box listens on, each with its private address

Path parameters

NameTypeDescription
idstring

200 OK: PreviewPorts

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/containers/{id}/previews/{port}/publish

Publish a port of a project's box at an address of its own on a hosting runner, or change how it is published

Path parameters

NameTypeDescription
idstring
portinteger

Request body: PublishPortBody

200 OK: PublishedPort

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/containers/{id}/previews/{port}/publish

Unpublish a port of a project's box; its private address stays

Path parameters

NameTypeDescription
idstring
portinteger

204 Unpublished

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/previews/{port}/open

A signed address that opens one port of a project's box for the caller (a tab, or a frame's src)

Path parameters

NameTypeDescription
idstring
portinteger

Request body: PreviewOpenBody

200 OK: PreviewOpen

Errors: 400, 401, 403, 404, 409, 429 with an error body

Remote-runs

GET /v1/containers/{id}/needs

What a project needs from a machine, and the organization's runners that could run its checks

Path parameters

NameTypeDescription
idstring

200 OK: ProjectNeeds

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/containers/{id}/remote-runner

Pick the runner a project's remote runs go to (null: none)

Path parameters

NameTypeDescription
idstring

Request body: ChooseRemoteRunnerBody

200 OK: ProjectNeeds

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/remote-runs

A project's remote runs, newest first

Path parameters

NameTypeDescription
idstring

200 OK: RemoteRunList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/remote-runs

Run a command (or a probe) of a project on its chosen runner, or on `runnerId` for a probe

Path parameters

NameTypeDescription
idstring

Request body: StartRemoteRunBody

200 OK: RemoteRun

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/containers/{id}/remote-runs/{run}

One remote run with its log (the lines Yard keeps of it)

Path parameters

NameTypeDescription
idstring
runstring

Query parameters

NameTypeDescription
sinceoptionalinteger | null

200 OK: RemoteRunLog

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/containers/{id}/remote-runs/{run}/cancel

Stop a remote run

Path parameters

NameTypeDescription
idstring
runstring

200 OK: RemoteRun

Errors: 400, 401, 403, 404, 409, 429 with an error body

Tests

GET /v1/workspaces/{ws}/repos/{id}/tests/config

How Yard runs a repository's tests in this workspace (404 when it has no test config)

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: TestConfig

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/repos/{id}/tests/config

Set the test commands, their output formats and an optional setup for a repository

Path parameters

NameTypeDescription
wsstring
idstring

Request body: TestConfigBody

200 OK: TestConfig

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/repos/{id}/tests/baseline

The latest test baseline of the workspace's branch, stale when the branch moved past it

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: TestBaselineView

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/repos/{id}/tests/baseline

Take a test baseline at the branch's head (again, when the last one failed); answers while it runs

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: TestBaselineView

Errors: 400, 401, 403, 404, 409, 429 with an error body

Monitors

GET /v1/workspaces/{ws}/monitors/environments

The workspace's monitor environments and their variables (secret values are never returned)

Path parameters

NameTypeDescription
wsstring

200 OK: MonitorEnvironmentList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/monitors/environments

Create an environment (`production`, `staging`); the first one is the default

Path parameters

NameTypeDescription
wsstring

Request body: CreateMonitorEnvironmentBody

200 OK: MonitorEnvironment

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/monitors/environments/{id}

One environment and its variables

Path parameters

NameTypeDescription
idstring

200 OK: MonitorEnvironment

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/monitors/environments/{id}

Rename an environment, or make it the default

Path parameters

NameTypeDescription
idstring

Request body: PatchMonitorEnvironmentBody

200 OK: MonitorEnvironment

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/monitors/environments/{id}

Delete an environment and its secrets; its flows use the default one

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/monitors/environments/{id}/turn-on

Turn a draft environment on, once each of its variables has a value (409 `missing_values` otherwise)

Path parameters

NameTypeDescription
idstring

200 OK: MonitorEnvironment

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/monitors/environments/{id}/sources

The repository files a environment was written from, and which of them changed since

Path parameters

NameTypeDescription
idstring

200 OK: MonitorSourceList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/monitors/environments/{id}/sources

Link a repository file to a environment ("Link a file")

Path parameters

NameTypeDescription
idstring

Request body: AddMonitorSourceBody

200 OK: MonitorSourceList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/monitors/environments/{id}/sources/confirm

"Still correct": the environment stands for its linked files as they are now, which removes the changed notice until one changes again

Path parameters

NameTypeDescription
idstring

200 OK: MonitorSourceList

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/monitors/environments/{id}/vars/{name}

Set a variable; a secret's value is sealed and never shown again

Path parameters

NameTypeDescription
idstring
namestring

Request body: PutMonitorEnvVarBody

200 OK: MonitorEnvironment

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/monitors/environments/{id}/vars/{name}

Remove a variable

Path parameters

NameTypeDescription
idstring
namestring

200 OK: MonitorEnvironment

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/monitors/flows

The workspace's flows, each with its last runs for a sparkline

Path parameters

NameTypeDescription
wsstring

200 OK: FlowList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/monitors/flows

Create a flow (multi-step HTTP check)

Path parameters

NameTypeDescription
wsstring

Request body: CreateFlowBody

200 OK: Flow

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/monitors/flows/import

Turn a curl command, a Postman collection or an OpenAPI document into flow steps (nothing is saved)

Path parameters

NameTypeDescription
wsstring

Request body: ImportFlowBody

200 OK: ImportFlowResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/monitors/flows/{id}

A flow with its steps and last run

Path parameters

NameTypeDescription
idstring

200 OK: Flow

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/monitors/flows/{id}

Change a flow: steps, schedule, environment, alerts

Path parameters

NameTypeDescription
idstring

Request body: PatchFlowBody

200 OK: Flow

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/monitors/flows/{id}

Delete a flow and its run history

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/monitors/flows/{id}/run

Run a flow now on the workspace's runner; answers when it finished. Works for a live flow (counted like a scheduled run, the schedule stays as it was), a paused one and a draft with no missing value (409 `missing_values` otherwise; a draft's run never alerts)

Path parameters

NameTypeDescription
idstring

Request body: RunFlowBody

200 OK: FlowRunDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/monitors/flows/{id}/test-step

Run one step on its own (after the steps before it), without saving anything

Path parameters

NameTypeDescription
idstring

Request body: TestStepBody

200 OK: StepResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/monitors/flows/{id}/turn-on

Turn a draft flow on: it is live, active and scheduled from now. 409 `missing_values` while its environment lacks a value it uses

Path parameters

NameTypeDescription
idstring

200 OK: Flow

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/monitors/flows/{id}/runs

A flow's runs, newest first

Path parameters

NameTypeDescription
idstring

Query parameters

NameTypeDescription
limitoptionalinteger
beforeoptionalstring

200 OK: FlowRunList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/monitors/runs/{id}

One run with every step's result

Path parameters

NameTypeDescription
idstring

200 OK: FlowRunDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/monitors/flows/{id}/sources

The repository files a flow was written from, and which of them changed since

Path parameters

NameTypeDescription
idstring

200 OK: MonitorSourceList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/monitors/flows/{id}/sources

Link a repository file to a flow ("Link a file")

Path parameters

NameTypeDescription
idstring

Request body: AddMonitorSourceBody

200 OK: MonitorSourceList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/monitors/flows/{id}/sources/confirm

"Still correct": the flow stands for its linked files as they are now, which removes the changed notice until one changes again

Path parameters

NameTypeDescription
idstring

200 OK: MonitorSourceList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/hooks/flows/{token}

Run a flow from outside (CI, a deploy): the token in its webhook URL is the credential

Path parameters

NameTypeDescription
tokenstring

202 OK: FlowHookAccepted

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/monitors/alert-channels

Where the workspace's monitor alerts go besides in-app notifications

Path parameters

NameTypeDescription
wsstring

200 OK: AlertChannelList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/monitors/alert-channels

Add an email address or a webhook (Slack and Discord are detected from the URL)

Path parameters

NameTypeDescription
wsstring

Request body: CreateAlertChannelBody

200 OK: AlertChannel

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/monitors/alert-channels/{id}

Rename an alert channel or turn it off

Path parameters

NameTypeDescription
idstring

Request body: PatchAlertChannelBody

200 OK: AlertChannel

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/monitors/alert-channels/{id}

Remove an alert channel

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/monitors/alert-channels/{id}/test

Send a test alert to one channel

Path parameters

NameTypeDescription
idstring

200 OK: AlertChannelTestResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/monitors/alerts

The alerts the workspace's monitors sent, newest first

Path parameters

NameTypeDescription
wsstring

200 OK: MonitorAlertList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/monitors/settings

How long the workspace keeps run history

Path parameters

NameTypeDescription
wsstring

200 OK: MonitorSettings

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/monitors/settings

Change how long the workspace keeps run history (days)

Path parameters

NameTypeDescription
wsstring

Request body: MonitorSettings

200 OK: MonitorSettings

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/monitors/cron

The workspace's cron monitors with their recent executions

Path parameters

NameTypeDescription
wsstring

200 OK: CronMonitorList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/monitors/cron

Create a cron monitor; the answer has its ping URL

Path parameters

NameTypeDescription
wsstring

Request body: CreateCronMonitorBody

200 OK: CronMonitor

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/monitors/cron/{id}

One cron monitor

Path parameters

NameTypeDescription
idstring

200 OK: CronMonitor

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/monitors/cron/{id}

Change a cron monitor's schedule, grace, runtime limit or alerts

Path parameters

NameTypeDescription
idstring

Request body: PatchCronMonitorBody

200 OK: CronMonitor

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/monitors/cron/{id}

Delete a cron monitor and its history

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/monitors/cron/{id}/turn-on

Turn a draft cron monitor on: from now it has a ping URL and expects its job on schedule

Path parameters

NameTypeDescription
idstring

200 OK: CronMonitor

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/monitors/cron/{id}/sources

The repository files a cron monitor was written from, and which of them changed since

Path parameters

NameTypeDescription
idstring

200 OK: MonitorSourceList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/monitors/cron/{id}/sources

Link a repository file to a cron monitor ("Link a file")

Path parameters

NameTypeDescription
idstring

Request body: AddMonitorSourceBody

200 OK: MonitorSourceList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/monitors/cron/{id}/sources/confirm

"Still correct": the cron monitor stands for its linked files as they are now, which removes the changed notice until one changes again

Path parameters

NameTypeDescription
idstring

200 OK: MonitorSourceList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/monitors/cron/{id}/pings

The pings a cron monitor received, newest first

Path parameters

NameTypeDescription
idstring

200 OK: CronPingList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/monitors/cron/{id}/executions

Executions (a start paired with its end), newest first

Path parameters

NameTypeDescription
idstring

200 OK: CronExecutionList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/ping/{token}

A job succeeded

Path parameters

NameTypeDescription
tokenstring

200 OK: CronPingAccepted

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/ping/{token}

A job succeeded

Path parameters

NameTypeDescription
tokenstring

200 OK: CronPingAccepted

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/ping/{token}/start

A job started (pairs with the next success or fail ping)

Path parameters

NameTypeDescription
tokenstring

200 OK: CronPingAccepted

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/ping/{token}/start

A job started (pairs with the next success or fail ping)

Path parameters

NameTypeDescription
tokenstring

200 OK: CronPingAccepted

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/ping/{token}/fail

A job failed

Path parameters

NameTypeDescription
tokenstring

200 OK: CronPingAccepted

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/ping/{token}/fail

A job failed

Path parameters

NameTypeDescription
tokenstring

200 OK: CronPingAccepted

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/monitors/turn-on

Turn on the ready drafts of a document (`sheetId`: a canvas, null for the workspace's own), or the drafts named in `ids`. The ones that still need values are returned as `waiting`. A project's drafts are merged, not turned on here

Path parameters

NameTypeDescription
wsstring

Request body: TurnOnMonitorsBody

200 OK: TurnOnMonitorsResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/monitors/waiting

What waits for a person: the drafts in each document of the workspace and the unmerged monitors of each project, with how many are ready, and the total for the sidebar

Path parameters

NameTypeDescription
wsstring

200 OK: MonitorsWaiting

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/monitors/sources/{id}

Unlink a file from its monitor

Path parameters

NameTypeDescription
idstring

200 OK: MonitorSourceList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/messages/{messageId}/monitors/{index}

Put a monitor the agent proposed in a chat (the card at `index`) in the workspace as a draft, as the person edited it: its block lands in the document the chat is on (`sheetId`), or in the project for a project's chat, and a person turns it on. Once per card; 404 `action_not_found` when there is no monitor proposal there.

Path parameters

NameTypeDescription
idstring
messageIdstring
indexoptionalinteger | null

Request body: ConfirmMonitorProposalBody

200 OK: MonitorProposalCreated

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/chats/{id}/messages/{messageId}/monitors/{index}/skip

Skip a monitor the agent proposed: nothing is created, the card says so

Path parameters

NameTypeDescription
idstring
messageIdstring
indexoptionalinteger | null

200 OK: ChatMessage

Errors: 400, 401, 403, 404, 409, 429 with an error body

Actions

GET /v1/workspaces/{ws}/actions

The workspace's actions and workflows, each with its trigger, kind of steps and last run

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
archivedoptional"true" | "false"

200 OK: ActionList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/actions

Create an action: a draft whose first version is a proposal until someone applies it

Path parameters

NameTypeDescription
wsstring

Request body: CreateActionBody

200 OK: ActionDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/actions/{id}

An action with its manifest (form, steps, triggers) and tool settings

Path parameters

NameTypeDescription
idstring

200 OK: ActionDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/actions/{id}

Rename an action or change how agents may call it as a tool

Path parameters

NameTypeDescription
idstring

Request body: PatchActionBody

200 OK: ActionDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/actions/{id}

Delete an action with its runs; its folder is removed from the actions branch

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/actions/{id}/archive

Archive an action (hidden, triggers stop) or bring it back

Path parameters

NameTypeDescription
idstring

Request body: ArchiveActionBody

200 OK: ActionDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/actions/{id}/pause

Pause or resume an action's triggers; running it by hand still works

Path parameters

NameTypeDescription
idstring

Request body: PauseActionBody

200 OK: ActionDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/actions/{id}/duplicate

Copy an action as a new draft

Path parameters

NameTypeDescription
idstring

200 OK: ActionDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/actions/{id}/versions

An action's versions and proposals, newest first

Path parameters

NameTypeDescription
idstring

200 OK: ActionVersionList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/action-versions/{id}

A version with its diff against the one before it (or the current one, for a proposal)

Path parameters

NameTypeDescription
idstring

200 OK: ActionVersionDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/action-versions/{id}/apply

Apply a proposal: it becomes the next numbered version. Runs in progress keep theirs. 409 `invalid_manifest` names what is wrong

Path parameters

NameTypeDescription
idstring

200 OK: ActionVersion

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/action-versions/{id}/discard

Discard a proposal

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/actions/{id}/files

The files of an action at a ref (the current version by default)

Path parameters

NameTypeDescription
idstring

Query parameters

NameTypeDescription
refoptionalstring

200 OK: ActionFiles

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/actions/{id}/file

One file of an action at a ref

Path parameters

NameTypeDescription
idstring

Query parameters

NameTypeDescription
pathstring
refoptionalstring

200 OK: ActionFileContent

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/actions/{id}/commit

Commit edited files on a branch, as a proposed version

Path parameters

NameTypeDescription
idstring

Request body: CommitActionFilesBody

200 OK: ActionVersion

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/actions/{id}/runs

Run an action with its form's inputs (file inputs are paths in the workspace: uploads/, files/). Queued while the workspace runs as many as it allows

Path parameters

NameTypeDescription
idstring

Request body: RunActionBody

200 OK: ActionRunDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/action-runs

Runs of the workspace's actions, newest first

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
filteroptionalActionRunFilter
actionoptionalstring
limitoptionalinteger

200 OK: ActionRunList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/action-runs/{id}

A run with every step's status, duration, events and the files it made

Path parameters

NameTypeDescription
idstring

200 OK: ActionRunDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/action-runs/{id}/log

A step's log (secrets masked, the last 256 KB)

Path parameters

NameTypeDescription
idstring

Query parameters

NameTypeDescription
stepstring

200 OK: ActionLog

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/action-runs/{id}/approve

Approve the step a run waits at (or confirm a wait in Yard); only its approvers may

Path parameters

NameTypeDescription
idstring

200 OK: ActionRunDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/action-runs/{id}/cancel

Cancel a run

Path parameters

NameTypeDescription
idstring

200 OK: ActionRunDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/action-runs/{id}/diagnose

Ask the agent in the action's chat what went wrong in a failed run

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/action-secrets

Secrets of actions: names, scopes, who uses them; never values

Path parameters

NameTypeDescription
wsstring

200 OK: ActionSecretList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/action-secrets

Add a secret (sealed in the browser), or only name it

Path parameters

NameTypeDescription
wsstring

Request body: PutActionSecretBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/action-secrets/{id}

Change a secret's value or scope

Path parameters

NameTypeDescription
idstring

Request body: PutActionSecretBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/action-secrets/{id}

Delete a secret

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/action-toolbox

The toolbox (programs with their install scripts and where they are cached) and the files/ folders actions share

Path parameters

NameTypeDescription
wsstring

200 OK: ActionToolbox

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/action-toolbox/tools

Add or replace a tool and install it on the runner

Path parameters

NameTypeDescription
wsstring

Request body: PutActionToolBody

200 OK: ActionToolInstall

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/workspaces/{ws}/action-toolbox/tools/{id}

Remove a tool from the toolbox

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/action-toolbox/folders

Name a files/ folder and how long its contents are kept

Path parameters

NameTypeDescription
wsstring

Request body: PutActionFolderBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/workspaces/{ws}/action-toolbox/folders/{id}

Forget a files/ folder (its files stay)

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/action-settings

Workspace settings › Actions

Path parameters

NameTypeDescription
wsstring

200 OK: ActionSettings

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/action-settings

Change Workspace settings › Actions (owners)

Path parameters

NameTypeDescription
wsstring

Request body: PatchActionSettingsBody

200 OK: ActionSettings

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/actions/{id}/chat

The action's own chat (made the first time): where its agent changes it, runs its agent steps and reads its failures

Path parameters

NameTypeDescription
idstring

200 OK: ActionChatRef

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/action-tools

The actions an agent of a project (or a chat) may call as tools, with their parameters

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
containeroptionalstring
chatoptionalstring

200 OK: ActionToolList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/actions/{id}/chats

Give a chat's agent this action as a tool (an action dropped into its composer)

Path parameters

NameTypeDescription
idstring

Request body: GiveActionToChatBody

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/action-settings/pull

Fetch the actions repository's remote: commits made elsewhere become versions as the settings say

Path parameters

NameTypeDescription
wsstring

200 OK: ActionsPulled

Errors: 400, 401, 403, 404, 409, 429 with an error body

Status

GET /v1/workspaces/{ws}/status-pages

The workspace's status pages, with their components' state

Path parameters

NameTypeDescription
wsstring

200 OK: StatusPageList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/status-pages

Create a status page (unpublished until you publish it)

Path parameters

NameTypeDescription
wsstring

Request body: CreateStatusPageBody

200 OK: StatusPage

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/status-pages/{id}

One status page with its components

Path parameters

NameTypeDescription
idstring

200 OK: StatusPage

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/status-pages/{id}

Change a page: title, address, published, subscriptions, auto-incidents

Path parameters

NameTypeDescription
idstring

Request body: PatchStatusPageBody

200 OK: StatusPage

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/status-pages/{id}

Delete a page with its incidents, maintenance and subscribers

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/status-pages/{id}/components

Add a component made of flows and cron monitors of the page's workspace

Path parameters

NameTypeDescription
idstring

Request body: CreateStatusComponentBody

200 OK: StatusComponent

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/status-components/{id}

Change a component

Path parameters

NameTypeDescription
idstring

Request body: PatchStatusComponentBody

200 OK: StatusComponent

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/status-components/{id}

Remove a component from its page

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/status-pages/{id}/maintenance

A page's maintenance windows, newest first

Path parameters

NameTypeDescription
idstring

200 OK: MaintenanceList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/status-pages/{id}/maintenance

Schedule maintenance; subscribers hear when it starts and ends

Path parameters

NameTypeDescription
idstring

Request body: CreateMaintenanceBody

200 OK: MaintenanceWindow

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/maintenance/{id}

Change a maintenance window

Path parameters

NameTypeDescription
idstring

Request body: PatchMaintenanceBody

200 OK: MaintenanceWindow

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/maintenance/{id}

Delete a maintenance window

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/status-pages/{id}/subscribers

A page's email subscribers (confirmed or waiting)

Path parameters

NameTypeDescription
idstring

200 OK: StatusSubscriberList

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/status-subscribers/{id}

Remove a subscriber

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/incidents

Incidents of every status page of the workspace, newest first

Path parameters

NameTypeDescription
wsstring

200 OK: IncidentList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/status-pages/{id}/incidents

A page's incidents, newest first (drafts included)

Path parameters

NameTypeDescription
idstring

200 OK: IncidentList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/status-pages/{id}/incidents

Open an incident with its first update; a published one emails subscribers

Path parameters

NameTypeDescription
idstring

Request body: CreateIncidentBody

200 OK: Incident

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/incidents/{id}

One incident with its updates

Path parameters

NameTypeDescription
idstring

200 OK: Incident

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/incidents/{id}

Change an incident: title, status, impact, components, published, internal note

Path parameters

NameTypeDescription
idstring

Request body: PatchIncidentBody

200 OK: Incident

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/incidents/{id}

Delete an incident

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/incidents/{id}/updates

Post an update; it sets the incident's status and emails subscribers when published

Path parameters

NameTypeDescription
idstring

Request body: CreateIncidentUpdateBody

200 OK: IncidentUpdate

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/incidents/{id}/postmortem

The incident's postmortem (empty until written), with a Markdown export

Path parameters

NameTypeDescription
idstring

200 OK: Postmortem

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/incidents/{id}/postmortem

Write the postmortem; `published: true` shows it on the public incident page

Path parameters

NameTypeDescription
idstring

Request body: PutPostmortemBody

200 OK: Postmortem

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/incidents/{id}/postmortem/publish

Publish the postmortem on the public incident page

Path parameters

NameTypeDescription
idstring

200 OK: Postmortem

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/incidents/{id}/drafts

The incident's AI drafts, newest first

Path parameters

NameTypeDescription
idstring

200 OK: IncidentDraftList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/incidents/{id}/drafts

Draft a brief or a postmortem from the incident's evidence with your own agent; answers with the pending draft

Path parameters

NameTypeDescription
idstring

Request body: CreateIncidentDraftBody

202 OK: IncidentDraft

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/incident-drafts/{id}

One draft with the evidence it was written from

Path parameters

NameTypeDescription
idstring

200 OK: IncidentDraftDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/incident-drafts/{id}/review

Mark a ready draft as reviewed

Path parameters

NameTypeDescription
idstring

200 OK: IncidentDraft

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/incident-drafts/{id}/apply

Copy the chosen fields of a draft into the postmortem (it stays unpublished)

Path parameters

NameTypeDescription
idstring

Request body: ApplyIncidentDraftBody

200 OK: IncidentDraft

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/status/confirm/{token}

Confirm a subscription (the link in the confirmation email)

Path parameters

NameTypeDescription
tokenstring

200 OK: StatusSubscriptionAnswer

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/status/unsubscribe/{token}

Unsubscribe (the link in every update email)

Path parameters

NameTypeDescription
tokenstring

200 OK: StatusSubscriptionAnswer

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/status/unsubscribe/{token}

One-click unsubscribe from a mail client (List-Unsubscribe-Post)

Path parameters

NameTypeDescription
tokenstring

200 OK: StatusSubscriptionAnswer

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/status/{slug}

A published page: components with their state, open incidents, maintenance and 90 days of history

Path parameters

NameTypeDescription
slugstring

200 OK: PublicStatusPage

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/status/{slug}/history

A published page's past incidents and maintenance

Path parameters

NameTypeDescription
slugstring

200 OK: PublicStatusHistory

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/status/{slug}/incidents/{id}

One published incident with its updates and published postmortem

Path parameters

NameTypeDescription
slugstring
idstring

200 OK: PublicIncidentDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/status/{slug}/summary.json

A small machine-readable summary of a published page

Path parameters

NameTypeDescription
slugstring

200 OK: StatusSummary

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/status/{slug}/feed.atom

An Atom feed of a published page's incidents

Path parameters

NameTypeDescription
slugstring

200 Atom feed

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/status/{slug}/badge.svg

An SVG badge with the page's overall state

Path parameters

NameTypeDescription
slugstring

200 SVG badge

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/status/{slug}/subscribe

Subscribe an email address; a confirmation email is sent first

Path parameters

NameTypeDescription
slugstring

Request body: StatusSubscribeBody

200 OK: StatusSubscriptionAnswer

Errors: 400, 401, 403, 404, 409, 429 with an error body

Insights

GET /v1/workspaces/{ws}/insights/sources

The workspace's insight sources (Postgres databases); connection strings are never returned

Path parameters

NameTypeDescription
wsstring

200 OK: InsightSourceList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/insights/sources

Connect a Postgres database; its URL is sealed

Path parameters

NameTypeDescription
wsstring

Request body: CreateInsightSourceBody

200 OK: InsightSource

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/insights/sources/{id}

Change a source, or its field access: which tables the agent may see, and per column whether the AI can read its values (`ai`) or only people do (`people`)

Path parameters

NameTypeDescription
idstring

Request body: PatchInsightSourceBody

200 OK: InsightSource

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/insights/sources/{id}

Remove a source with its boards

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/insights/sources/{id}/introspect

Read the source's tables and columns, from the workspace's box

Path parameters

NameTypeDescription
idstring

200 OK: InsightSource

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/insights/boards

The workspace's insight boards

Path parameters

NameTypeDescription
wsstring

200 OK: InsightBoardList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/insights/boards

Create a board on a source

Path parameters

NameTypeDescription
wsstring

Request body: CreateInsightBoardBody

200 OK: InsightBoard

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/insights/boards/{id}

A board with its cards and their latest snapshots

Path parameters

NameTypeDescription
idstring

200 OK: InsightBoard

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/insights/boards/{id}

Rename a board or change how often it refreshes

Path parameters

NameTypeDescription
idstring

Request body: PatchInsightBoardBody

200 OK: InsightBoard

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/insights/boards/{id}

Delete a board and its cards

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/insights/boards/{id}/ask

Ask a question on a board from before stats: your own agent writes one SELECT, kept as a proposed card. It does not run until a person approves it

Path parameters

NameTypeDescription
idstring

Request body: AskInsightBody

200 OK: InsightCard

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/insights/boards/{id}/refresh

Run every approved card of a board again now

Path parameters

NameTypeDescription
idstring

200 OK: InsightBoard

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/stats

The stats on the tabs you may open, each with its query, what waits for approval, its last result and who gets each column's values. `sheet`: one tab only (`first` for the first tab). `place=insights`: the stats of the Insights page, every one you may open

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
sheetoptionalstring
placeoptional"insights"

200 OK: StatList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/stats

Add a stat: the question goes to the stat block's own chat, whose agent writes one read-only query. It is kept as a proposal and does not run until a person approves it

Path parameters

NameTypeDescription
wsstring

Request body: CreateStatBody

200 OK: StatAsked

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/stats/run

Run all stats of a tab again: every approved one, now

Path parameters

NameTypeDescription
wsstring

Request body: RunStatsBody

200 OK: StatList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/insights/cards/{id}

A stat: its query, what waits for approval, and its last result

Path parameters

NameTypeDescription
idstring

200 OK: InsightCard

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/insights/cards/{id}

Change a stat: its title, how it is drawn (only redraws), how often it runs by itself, or its query (saving a query approves it, and it runs)

Path parameters

NameTypeDescription
idstring

Request body: PatchInsightCardBody

200 OK: InsightCard

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/insights/cards/{id}

Remove a card

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/insights/cards/{id}/approve

Approve and run: the proposed query (or your edited version of it) becomes the stat's query and runs read-only. Until then the earlier approved query and its last result stay

Path parameters

NameTypeDescription
idstring

Request body: ApproveStatBody

200 OK: InsightCard

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/insights/cards/{id}/ask

Change a stat's question: it goes to the block's chat and comes back as a new query to approve. The approved query and its result stay until then

Path parameters

NameTypeDescription
idstring

Request body: AskStatBody

200 OK

NameTypeDescription
cardInsightCard
chatIdstring

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/insights/cards/{id}/run

Run a stat again now. Refused (409 `stat_not_approved`) while its query is not approved. A run that fails keeps its error on the stat

Path parameters

NameTypeDescription
idstring

200 OK: InsightCard

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/insights/cards/{id}/fix

Ask the agent to fix it: the error of the stat's last run goes into the block's chat as a turn

Path parameters

NameTypeDescription
idstring

Request body: FixStatBody

200 OK

NameTypeDescription
cardInsightCard
chatIdstring

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/insights/cards/{id}/columns

What the AI may read, for this stat: its own choice per result column (`ai` or `people`; null takes the choice away, so the column follows its table again). Applies at once

Path parameters

NameTypeDescription
idstring

Request body: PatchCardColumnsBody

200 OK: InsightCard

Errors: 400, 401, 403, 404, 409, 429 with an error body

Conflicts

GET /v1/workspaces/{ws}/conflicts

Files two writers changed in ways that could not be merged (open ones by default)

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
statusoptional"open" | "resolved" | "all"

200 OK: ConflictList

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/conflicts/{id}

One conflict, with its versions when they are text

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: FileConflictDetail

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/conflicts/{id}/resolve

Settle a conflict: keep one version, keep both, or write the merged text. Recorded in the history.

Path parameters

NameTypeDescription
wsstring
idstring

Request body: ResolveConflictBody

200 OK: ResolveConflictResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/conflicts/{id}/ask-agent

Ask your agent, in a chat of its own, to propose a merged version for you to review

Path parameters

NameTypeDescription
wsstring
idstring

200 OK: AskConflictAgentResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

Comments

GET /v1/workspaces/{ws}/comments

Comment threads on the workspace canvas, or on a project's canvas and spec

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
containeroptionalstring

200 OK

NameTypeDescription
threadsCommentThread[]

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/comments

Start a comment thread on a block or a passage

Path parameters

NameTypeDescription
wsstring

Request body: StartThreadBody

200 OK: CommentThread

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/comment-threads/{id}/comments

Answer in a comment thread

Path parameters

NameTypeDescription
idstring

Request body: ReplyBody

200 OK: CommentThread

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/comment-threads/{id}/resolve

Mark a thread resolved

Path parameters

NameTypeDescription
idstring

200 OK: CommentThread

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/comment-threads/{id}/reopen

Open a resolved thread again

Path parameters

NameTypeDescription
idstring

200 OK: CommentThread

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/comments/{id}

Change your own comment

Path parameters

NameTypeDescription
idstring

Request body: EditCommentBody

200 OK: CommentThread

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/comments/{id}

Delete your comment (workspace owners: any comment)

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

Notifications

GET /v1/notifications

The caller's recent notifications

200 OK

NameTypeDescription
notificationsNotification[]
unreadinteger

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/notifications/read-all

Mark every notification as read

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/notifications/clear

Remove every notification of the caller

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/notifications/{id}/read

Mark a notification as read

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

Feedback

POST /v1/feedback

Send a request or a problem to the people who build Yard

Request body: FeedbackBody

200 OK

NameTypeDescription
idstring

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/feedback

The workspace's feedback: the inbox, or what is archived

Path parameters

NameTypeDescription
wsstring

Query parameters

NameTypeDescription
archivedoptional"true" | "false"

200 OK: FeedbackEntryList

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/feedback

Add an entry to the workspace's feedback, for example from your own product with an API key

Path parameters

NameTypeDescription
wsstring

Request body: CreateFeedbackEntryBody

200 OK: FeedbackEntry

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/workspaces/{ws}/feedback

Mark several entries new, seen or done, or archive them, at once

Path parameters

NameTypeDescription
wsstring

Request body: BulkFeedbackEntriesBody

200 OK: BulkFeedbackEntriesResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

PATCH /v1/feedback-entries/{id}

Mark an entry new, seen or done, or archive it

Path parameters

NameTypeDescription
idstring

Request body: PatchFeedbackEntryBody

200 OK: PatchedFeedbackEntry

Errors: 400, 401, 403, 404, 409, 429 with an error body

DELETE /v1/feedback-entries/{id}

Delete an entry

Path parameters

NameTypeDescription
idstring

200 OK: Ok

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/workspaces/{ws}/feedback/take-back

Undo a change of several entries at once, with the token it answered; entries changed since keep that change

Path parameters

NameTypeDescription
wsstring

Request body: TakeBackFeedbackBody

200 OK: BulkFeedbackEntriesResult

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/feedback-entries/{id}/links

Record a project or a prototype block made from an entry; a new entry becomes seen

Path parameters

NameTypeDescription
idstring

Request body: AddFeedbackLinkBody

200 OK: FeedbackEntry

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/workspaces/{ws}/feedback/settings

The workspace's hosted form, and whether Yard's in-app feedback arrives here

Path parameters

NameTypeDescription
wsstring

200 OK: FeedbackSettings

Errors: 400, 401, 403, 404, 409, 429 with an error body

PUT /v1/workspaces/{ws}/feedback/form

Create or change the workspace's hosted form: title, address, published, the email field

Path parameters

NameTypeDescription
wsstring

Request body: SaveFeedbackFormBody

200 OK: FeedbackForm

Errors: 400, 401, 403, 404, 409, 429 with an error body

GET /v1/feedback-forms/{slug}

A published form: its title, description and whether it asks for an email address

Path parameters

NameTypeDescription
slugstring

200 OK: PublicFeedbackForm

Errors: 400, 401, 403, 404, 409, 429 with an error body

POST /v1/feedback-forms/{slug}

Send feedback to a published form, without signing in

Path parameters

NameTypeDescription
slugstring

Request body: SubmitFeedbackBody

200 OK

NameTypeDescription
idstring

Errors: 400, 401, 403, 404, 409, 429 with an error body

Screenshots

POST /v1/workspaces/{ws}/screenshots

Screenshot a URL or the virtual display from inside a box

Path parameters

NameTypeDescription
wsstring

Request body: ScreenshotBody

200 OK: Screenshot

Errors: 400, 401, 403, 404, 409, 429 with an error body

Direct runner domains

POST /v1/workspaces/{ws}/direct

A one-minute ticket to open a terminal or read files straight from the workspace's runner, when it has its own address

Path parameters

NameTypeDescription
wsstring

Request body: DirectTicketBody

200 OK: DirectTicket

Errors: 400, 401, 403, 404, 409, 429 with an error body

Errors

Every error answers with the same body:

ErrorBody

NameTypeDescription
errorstring
codestring
planoptionalstring

Schemas

AcceptedInvite

Fields

NameTypeDescription
orgobject
workspaceIdstring | null

ActionChatRef

Fields

NameTypeDescription
chatIdstring

ActionDetail

Fields

NameTypeDescription
idstring
workspaceIdstring
slugstring
kind"action" | "workflow"
titlestring
descriptionstring
draftboolean
draftBystring | null
draftBranchstring | null
versionActionVersionRef
stepCountinteger
agentStepsinteger
approvalsinteger
triggersActionTrigger[]
inputsActionInput[]
lastRunActionLastRun
runCountinteger
toolNamestring
toolEnabledboolean
toolAccessActionToolAccess
pausedAtstring | null
archivedAtstring | null
createdAtstring
manifestActionManifest
draftManifestActionManifest
toolDescriptionstring
toolProjectsstring[]
chatIdstring | null
canEditboolean

ActionDiagnosis

Fields

NameTypeDescription
textstring
agentstring
atstring
versionIdstring | null

ActionFileChange

Fields

NameTypeDescription
pathstring
addedinteger
removedinteger

ActionFileContent

Fields

NameTypeDescription
refstring
pathstring
contentstring

ActionFileEntry

Fields

NameTypeDescription
pathstring
sizeinteger

ActionFiles

Fields

NameTypeDescription
refstring
filesActionFileEntry[]

ActionFileWrite

Fields

NameTypeDescription
pathstring
contentstring | null

ActionFolder

Fields

NameTypeDescription
idstring
pathstring
holdsstring | null
keepobject | null
usedByobject[]
bytesinteger | null

ActionGitState

Fields

NameTypeDescription
enabledboolean
remotestring | null
branchstring
pushedAtstring | null
pushErrorstring | null

ActionInbound

"apply" | "apply_after_review" | "ignore"

ActionInput

Fields

NameTypeDescription
namestring
labeloptionalstring
typeActionInputType
requiredoptionalboolean
defaultoptionalstring | number | boolean
optionsoptionalstring[]
acceptoptionalstring[]
descriptionoptionalstring

ActionInputType

"text" | "choice" | "files" | "bool" | "number"

ActionLastRun

Fields

NameTypeDescription
idstring
numberinteger
statusActionRunStatus
labelstring | null
atstring
waitingLabelstring | null

ActionList

Fields

NameTypeDescription
actionsActionSummary[]
gitActionGitState

ActionLog

Fields

NameTypeDescription
stepIdstring
textstring
truncatedboolean

ActionManifest

Fields

NameTypeDescription
kindoptional"action" | "workflow"
titlestring
descriptionoptionalstring
inputsoptionalActionInput[]
stepsActionStep[]
outputsoptionalstring[]
triggersoptionalActionTrigger[]
tooloptionalActionToolSettings
reposoptionalActionRepo[]

ActionOutputFile

Fields

NameTypeDescription
pathstring
bytesinteger

ActionRepo

Fields

NameTypeDescription
repostring
refoptionalstring

ActionRunDetail

Fields

NameTypeDescription
idstring
actionIdstring
actionTitlestring
actionSlugstring
versionNumberinteger | null
numberinteger
statusActionRunStatus
waitingFor"approval" | "person" | null
waitingLabelstring | null
stepIndexinteger | null
stepCountinteger
previewboolean
triggeredByActionRunTrigger
startedBystring | null
startedByNamestring | null
callerobject | null
parentRunIdstring | null
labelstring | null
outputsActionOutputFile[]
errorstring | null
createdAtstring
startedAtstring | null
finishedAtstring | null
inputsobject
stepsActionStepResult[]
diagnosisActionDiagnosis
reposobject[]
runnerIdstring | null
canApproveboolean

ActionRunFilter

"all" | "waiting" | "failed" | "agents" | "mine"

ActionRunList

Fields

NameTypeDescription
runsActionRunSummary[]

ActionRunStatus

"queued" | "running" | "waiting" | "succeeded" | "failed" | "cancelled"

ActionRunSummary

Fields

NameTypeDescription
idstring
actionIdstring
actionTitlestring
actionSlugstring
versionNumberinteger | null
numberinteger
statusActionRunStatus
waitingFor"approval" | "person" | null
waitingLabelstring | null
stepIndexinteger | null
stepCountinteger
previewboolean
triggeredByActionRunTrigger
startedBystring | null
startedByNamestring | null
callerobject | null
parentRunIdstring | null
labelstring | null
outputsActionOutputFile[]
errorstring | null
createdAtstring
startedAtstring | null
finishedAtstring | null

ActionRunTrigger

"manual" | "form" | "schedule" | "tag" | "files" | "workflow" | "agent" | "cli"

ActionSecret

Fields

NameTypeDescription
idstring
namestring
scopeActionSecretScope
actionIdsstring[]
stepRefstring | null
emptyboolean
usedByobject[]
askedByobject | null
setBystring | null
updatedAtstring
lastUsedAtstring | null

ActionSecretList

Fields

NameTypeDescription
secretsActionSecret[]

ActionSecretScope

"workspace" | "actions" | "step"

ActionSettings

Fields

NameTypeDescription
gitEnabledboolean
remoteRepostring | null
branchstring
inboundActionInbound
runnerIdstring | null
maxParallelinteger
keepRunsDaysinteger
agentsMayEditboolean
notifyUserIdsstring[]

ActionSlug

string

ActionsPulled

Fields

NameTypeDescription
versionsinteger

ActionStep

Fields

NameTypeDescription
idActionSlug
namestring
kindActionStepKind
runoptionalstring
withoptionalobject
toolsoptionalstring[]
readsoptionalstring[]
writesoptionalstring[]
secretsoptionalstring[]
repooptionalstring
ifoptionalstring
optionaloptionalboolean
optionalInputoptionalstring
waitoptionalActionWait
approversoptionalstring[]
promptoptionalstring
timeoutMsoptionalinteger

ActionStepEvent

Fields

NameTypeDescription
atstring
kind"info" | "ok" | "wait" | "error"
textstring

ActionStepKind

"script" | "action" | "approval" | "wait" | "agent" | "if" | "notify"

ActionStepResult

Fields

NameTypeDescription
stepIdstring
namestring
kindActionStepKind
statusActionStepStatus
startedAtstring | null
durationMsinteger | null
exitCodeinteger | null
summarystring | null
eventsActionStepEvent[]
waitingLabelstring | null
approvedBystring | null
childRunIdstring | null
outputsActionOutputFile[]

ActionStepStatus

"pending" | "running" | "waiting" | "passed" | "failed" | "skipped" | "not_run"

ActionSummary

Fields

NameTypeDescription
idstring
workspaceIdstring
slugstring
kind"action" | "workflow"
titlestring
descriptionstring
draftboolean
draftBystring | null
draftBranchstring | null
versionActionVersionRef
stepCountinteger
agentStepsinteger
approvalsinteger
triggersActionTrigger[]
inputsActionInput[]
lastRunActionLastRun
runCountinteger
toolNamestring
toolEnabledboolean
toolAccessActionToolAccess
pausedAtstring | null
archivedAtstring | null
createdAtstring

ActionToolAccess

"all" | "projects" | "people"

ActionToolbox

Fields

NameTypeDescription
toolsActionToolboxItem[]
foldersActionFolder[]

ActionToolboxItem

Fields

NameTypeDescription
idstring
namestring
versionstring | null
installScriptstring
sourcestring | null
cachedOnobject[]

ActionToolInstall

Fields

NameTypeDescription
okboolean
logstring

ActionToolList

Fields

NameTypeDescription
toolsActionToolSpec[]

ActionToolParam

Fields

NameTypeDescription
namestring
typeActionInputType
requiredboolean
descriptionstring
optionsoptionalstring[]

ActionToolSettings

Fields

NameTypeDescription
nameoptionalstring
descriptionoptionalstring

ActionToolSpec

Fields

NameTypeDescription
actionIdstring
namestring
titlestring
descriptionstring
paramsActionToolParam[]
returnsstring[]
scriptOnlyboolean
approvalsinteger

ActionTrigger

object | object | object | object

ActionVersion

Fields

NameTypeDescription
idstring
actionIdstring
numberinteger | null
status"proposed" | "applied" | "discarded"
branchstring
commitShastring
summarystring | null
filesChangedActionFileChange[]
byUserNamestring | null
byAgentstring | null
chatIdstring | null
fromRunIdstring | null
testRunIdstring | null
appliedBystring | null
createdAtstring
problemsstring[]

ActionVersionDetail

Fields

NameTypeDescription
idstring
actionIdstring
numberinteger | null
status"proposed" | "applied" | "discarded"
branchstring
commitShastring
summarystring | null
filesChangedActionFileChange[]
byUserNamestring | null
byAgentstring | null
chatIdstring | null
fromRunIdstring | null
testRunIdstring | null
appliedBystring | null
createdAtstring
problemsstring[]
diffstring

ActionVersionList

Fields

NameTypeDescription
versionsActionVersion[]

ActionVersionRef

Fields

NameTypeDescription
idstring
numberinteger | null
commitShastring
summarystring | null
createdAtstring

ActionWait

Fields

NameTypeDescription
matchoptionalstring
labelstring
timeoutMsoptionalinteger
keepoptionalstring[]

AddFeedbackLinkBody

object | object

AddMonitorSourceBody

Fields

NameTypeDescription
repoIdstring
pathstring

AgentAccount

Fields

NameTypeDescription
idstring
provider"claude" | "codex" | "cursor" | "grok" | "fake"
labelstring
status"pending" | "active" | "expired"
auth"login" | "api_key"
isActiveboolean
workspacesobject[]
emailstring | null
lastUsedAtstring | null
createdAtstring

AgentLimits

Fields

NameTypeDescription
provider"claude" | "codex" | "cursor" | "grok" | "fake"
accountIdstring | null
windowsAgentLimitWindow[]
observedAtstring

AgentLimitWindow

Fields

NameTypeDescription
kindstring
usedPercentnumber | null
resetsAtstring | null
statusoptional"allowed" | "warning" | "rejected"

AgentLoginCodeBody

Fields

NameTypeDescription
codestring

AgentLoginState

Fields

NameTypeDescription
accountIdstring
phase"none" | "starting" | "awaiting_code" | "awaiting_device" | "verifying" | "authorized" | "error" | "expired"
urlstring | null
userCodestring | null
errorstring | null
runneroptionalobject | null
runnersoptionalobject[]

AgentLoginTerminal

Fields

NameTypeDescription
terminalIdstring

AlertChannel

Fields

NameTypeDescription
idstring
workspaceIdstring
kindAlertChannelKind
namestring
targetstring | null
enabledboolean
createdAtstring

AlertChannelKind

"email" | "webhook" | "slack" | "discord"

AlertChannelList

Fields

NameTypeDescription
channelsAlertChannel[]

AlertChannelTestResult

Fields

NameTypeDescription
okboolean
errorstring | null

ApiKey

Fields

NameTypeDescription
idstring
kind"user" | "org"
namestring
prefixstring
scopes("read" | "write" | "runners" | "admin")[]
role"admin" | "member" | null
createdByobject | null
createdAtstring
expiresAtstring | null
lastUsedAtstring | null
lastUsedIpstring | null
previousExpiresAtstring | null

AppActionBody

Fields

NameTypeDescription
keepDataoptionalboolean
renameHostoptionalboolean

AppConfig

Fields

NameTypeDescription
idstring
layerAppConfigLayer
repostring
repoIdstring
namestring
specobject
disabledboolean
updatedBystring | null
updatedAtstring

AppConfigLayer

"org" | "workspace" | "project"

AppConfigList

Fields

NameTypeDescription
configsAppConfig[]

AppEnvEntry

Fields

NameTypeDescription
repostring | null
appstring | null
namestring
valuestring | null
secretboolean
setboolean

AppEnvironment

Fields

NameTypeDescription
idstring
namestring
slugstring
sourcesAppEnvironmentSource[]
runninginteger
totalinteger
createdAtstring

AppEnvironmentApps

Fields

NameTypeDescription
appsResolvedApp[]
hiddenobject[]
runsOnHostingRunnerChoice & object | null
blockedstring | null
environmentAppEnvironment

AppEnvironmentList

Fields

NameTypeDescription
environmentsAppEnvironment[]
maxinteger

AppEnvironmentSource

Fields

NameTypeDescription
repostring
branchstring | null
baseBranchstring | null
goneboolean

AppEnvList

Fields

NameTypeDescription
entriesAppEnvEntry[]

AppEnvVar

Fields

NameTypeDescription
namestring
valuestring | null
rawstring | null
secretboolean
sourceobject
status"ok" | "needs-value" | "broken-link"
detailstring | null

AppInstance

Fields

NameTypeDescription
idstring
state"pending" | "fetching" | "building" | "starting" | "running" | "sleeping" | "stopped" | "error"
urlsAppUrl[]
sourceShastring | null
runnerIdstring
startedBystring | null
errorstring | null
updatedAtstring

AppLogs

Fields

NameTypeDescription
linesobject[]

ApplyIncidentDraftBody

Fields

NameTypeDescription
fieldsIncidentDraftField[]

AppResolvedEnv

Fields

NameTypeDescription
repostring
appstring
varsAppEnvVar[]
issuesinteger

ApproveStatBody

Fields

NameTypeDescription
sqloptionalstring

AppSecretProposal

Fields

NameTypeDescription
namestring
generateoptionalobject
whyoptionalstring

AppUrl

Fields

NameTypeDescription
portstring
urlstring
visibility"team" | "public"
kind"domain" | "edge"

AppVisibility

"team" | "public"

ArchiveActionBody

Fields

NameTypeDescription
archivedboolean

ArchivedBlock

Fields

NameTypeDescription
idstring
typestring
titlestring
detailstring | null

AskConflictAgentResult

Fields

NameTypeDescription
chatIdstring

AskInsightBody

Fields

NameTypeDescription
questionstring

AskSecondOpinionBody

Fields

NameTypeDescription
textstring
sourceSeqoptionalinteger
provideroptional"claude" | "codex" | "cursor" | "grok" | "fake"
modeloptionalstring
effortoptionalstring
accountIdoptionalstring
agentIdoptionalstring
ruleIdoptionalstring

AskStatBody

Fields

NameTypeDescription
questionstring
provideroptional"claude" | "codex" | "cursor" | "grok" | "fake"
modeloptionalstring
effortoptionalstring

Assertion

object | object | object | object | object | object

AssertionResult

Fields

NameTypeDescription
typestring
targetoptionalstring
expectedoptionalunknown
actualoptionalunknown
passedboolean

AttachContainerFileBody

Fields

NameTypeDescription
pathstring
nameoptionalstring

AttachContainerReposBody

Fields

NameTypeDescription
reposobject[]

AttachmentKeptAs

"live" | "copy" | "link" | "commit"

AttachmentSince

Fields

NameTypeDescription
idstring
changedboolean
localEditsboolean
originMissingboolean

AttachmentsSince

Fields

NameTypeDescription
sinceAttachmentSince[]
runnerOnlineboolean

AttachOriginBody

Fields

NameTypeDescription
originstring
nameoptionalstring
keptAsoptionalAttachmentKeptAs
pinnedRefoptionalstring
repooptionalstring
addedBecauseoptionalstring

AuthProviders

Fields

NameTypeDescription
githubboolean
earlyAccessboolean

AutoIncidentMode

"off" | "draft" | "publish"

Billing

Fields

NameTypeDescription
enabledboolean
paymentsReadyboolean
plansPlan[]
enterpriseobject | null
peopleobject[]
licensesLicense[]
legacyobject | null
callerobject
pendingInvitesinteger
canManageboolean
hasCustomerboolean

BillingCheckoutBody

Fields

NameTypeDescription
intervaloptional"month" | "year"

BillingLicenseBody

Fields

NameTypeDescription
userIdstring
intervaloptional"month" | "year"

BillingRedirect

Fields

NameTypeDescription
urlstring

BindAccountsBody

Fields

NameTypeDescription
accountsobject[]

BlockRef

Fields

NameTypeDescription
sheetIdstring | null
blockIdstring

BoundAccount

Fields

NameTypeDescription
accountIdstring
provider"claude" | "codex" | "cursor" | "grok" | "fake"
labelstring
status"pending" | "active" | "expired"
positioninteger
allowedRulesstring[] | null

BoundAccountList

Fields

NameTypeDescription
accountsBoundAccount[]

BulkFeedbackEntriesBody

Fields

NameTypeDescription
idsstring[]
statusoptionalFeedbackStatus
archivedoptionalboolean

BulkFeedbackEntriesResult

Fields

NameTypeDescription
entriesFeedbackEntry[]
takeBackoptionalstring | null

Capture

Fields

NameTypeDescription
namestring
pathstring

ChangePasswordBody

Fields

NameTypeDescription
currentstring
nextstring

Chat

Fields

NameTypeDescription
idstring
workspaceIdstring
containerIdstring | null
ownerobject | null
kindoptional"main" | "child" | "second_opinion"
parentChatIdoptionalstring | null
stepIdoptionalstring | null
sourceSeqoptionalinteger | null
forkedFromChatFork
blockIdstring | null
sheetIdstring | null
blockTitlestring | null
docIdstring | null
scopeChatScopeKind
scopeIdstring | null
status"idle" | "running" | "awaiting_input" | "error" | "background" | "terminal"
messagesChatMessage[]
hasMoreboolean
queueChatQueueItem[]
liveChatLive
terminalPendingoptionalboolean
backgroundChatBackgroundProcess[]

ChatActivity

Fields

NameTypeDescription
idstring
kind"read" | "edit" | "run" | "search" | "other"
labelstring
detailoptionalstring
okoptionalboolean
doneboolean
inputoptionalstring
outputoptionalstring
parentoptionalstring

ChatAdded

Fields

NameTypeDescription
blockIdsoptionalstring[]
reposoptionalstring[]

ChatAppSaved

Fields

NameTypeDescription
indexinteger
layer"workspace" | "project"
containerIdstring | null
namestring
savedBystring
atstring

ChatBackgroundProcess

Fields

NameTypeDescription
idstring
pidinteger
commandstring
startedAtstring
state"running" | "exited" | "stopped"
endedAtoptionalstring
stoppedByoptionalstring
portsoptionalinteger[]
turnIdstring

ChatChildren

Fields

NameTypeDescription
childrenChatSummary[]

ChatContextCanvas

Fields

NameTypeDescription
sheetIdstring

ChatContextDoc

Fields

NameTypeDescription
docIdstring
wholeboolean
sectionsoptionalstring[]

ChatFiledAction

Fields

NameTypeDescription
kind"filed"
itemsobject[]
docIdoptionalstring

ChatFinding

Fields

NameTypeDescription
findingstring
byoptionalstring
verdict"confirmed" | "rejected" | "unsure"
pathoptionalstring
lineoptionalinteger
noteoptionalstring

ChatFollowUp

Fields

NameTypeDescription
containerIdstring
slugstring
titlestring
hrefstring

ChatFork

Fields

NameTypeDescription
chatIdstring
ownerobject | null
seqinteger

ChatFromChat

Fields

NameTypeDescription
chatIdstring
titlestring
scope"workspace" | "doc" | "prototype" | "project" | "investigation" | "canvas"
agentIdoptionalstring
agentNameoptionalstring
replyoptionalboolean

ChatGitEvent

Fields

NameTypeDescription
kind"pushed" | "pr_opened" | "pr_merged" | "pr_closed" | "pr_reopened" | "pr_conflicting"
repostring
branchstring
baseoptionalstring
commitsoptionalinteger
numberoptionalinteger
urloptionalstring
bystring | null
onGitHubboolean
openCriteriaoptionalstring

ChatLive

Fields

NameTypeDescription
turnIdstring
textstring
activityChatActivity[]
subagentsChatSubagent[]
todosobject[]
queuedPositioninteger | null
queuedReason"concurrency" | "load" | null
loadobject | null
startedBystring
canSteerboolean
terminaloptionalobject

ChatLoadNotice

Fields

NameTypeDescription
state"queued" | "started" | "paused" | "restarted" | "expired"
positionoptionalinteger
cpuPercentoptionalnumber | null
memPercentoptionalnumber | null

ChatMemoryNotice

Fields

NameTypeDescription
commandstring | null
limitBytesnumber | null
peakBytesnumber | null
countoptionalinteger

ChatMessage

Fields

NameTypeDescription
idstring
chatIdstring
seqinteger
role"user" | "agent" | "system"
authorobject | null
textstring
contextobject[]
attachmentsstring[]
activityChatActivity[]
subagentsChatSubagent[]
questionsobject[]
actions(object | object | object | object | object | object | object | object)[]
feedbackSentstring[]
specsCreatedobject[]
appsSavedoptionalChatAppSaved[]
appsSkippedoptionalinteger[]
monitorsCreatedoptionalChatMonitorCreated[]
monitorsSkippedoptionalinteger[]
errorobject | null
cancelledboolean
agentobject | null
workspaceAgentIdoptionalstring | null
ruleIdoptionalstring | null
effortoptionalstring | null
fromAgentIdoptionalstring | null
toAgentIdoptionalstring | null
stepsoptionalChatStepRun[]
findingsoptionalChatFinding[]
handoffoptionalobject
secondOpinionoptionalobject
childChatoptionalobject
actionVersionoptionalobject
actionRunoptionalobject
turnLimitoptionalinteger
crewFallthroughoptionalobject
gitChatGitEvent
loadChatLoadNotice
usageChatUsageNotice
steeredoptionalboolean
viaoptional"terminal"
continuedoptionalboolean
resumeoptionalboolean
memoryChatMemoryNotice
resourcesoptionalChatResourcesNotice
followUpoptionalChatFollowUp
fromProjectoptionalChatProjectRef
fromChatoptionalChatFromChat
sentTooptionalChatProjectRef
turnUsageChatTurnUsage
filedoptionalChatFiledAction
createdAtstring

ChatMonitorCreated

Fields

NameTypeDescription
indexinteger
monitor"flow" | "cron" | "environment"
idstring
createdBystring
atstring

ChatPlace

Fields

NameTypeDescription
page"workspace" | "docs" | "doc" | "prototypes" | "prototype" | "projects" | "project" | "investigate" | "investigation" | "canvas" | "monitors" | "files" | "other"
idoptionalstring
sheetIdoptionalstring | null
taboptionalstring
titleoptionalstring

ChatProjectRef

Fields

NameTypeDescription
containerIdstring
slugstring
titlestring
hrefstring
relationoptional"parent" | "sibling" | "sub-project"

ChatQueueItem

Fields

NameTypeDescription
idstring
chatIdstring
authorobject
textstring
heldboolean
steerableboolean
editableboolean
createdAtstring

ChatResourcesNotice

Fields

NameTypeDescription
cpusnumber | null
memoryMbnumber | null
shmMbnumber

ChatScopeKind

"workspace" | "doc" | "prototype" | "project" | "investigation" | "canvas"

ChatStepRun

Fields

NameTypeDescription
idstring
titlestring
taskstring
ruleoptionalstring
agentoptionalstring
afteroptionalstring[]
state"proposed" | "waiting" | "running" | "done" | "failed" | "stopped" | "skipped"
chatIdstring | null
erroroptionalstring

ChatSubagent

Fields

NameTypeDescription
idstring
taskIdoptionalstring
descriptionstring
agentTypeoptionalstring
backgroundoptionalboolean
status"running" | "completed" | "failed" | "stopped"
promptoptionalstring
lastStepoptionalstring
summaryoptionalstring
toolUsesoptionalinteger
durationMsoptionalnumber
startedAtstring
endedAtoptionalstring
textoptionalstring
canStopboolean

ChatSummary

Fields

NameTypeDescription
idstring
workspaceIdstring
containerIdstring | null
ownerobject | null
kindoptional"main" | "child" | "second_opinion"
parentChatIdoptionalstring | null
stepIdoptionalstring | null
sourceSeqoptionalinteger | null
forkedFromChatFork
blockIdstring | null
sheetIdstring | null
blockTitlestring | null
docIdstring | null
scopeChatScopeKind
scopeIdstring | null
titlestring | null
status"idle" | "running" | "awaiting_input" | "error" | "background" | "terminal"
messagesinteger
lastActivityAtstring
createdAtstring

ChatTerminal

Fields

NameTypeDescription
terminalIdstring | null
pendingoptionalboolean

ChatTurnUsage

Fields

NameTypeDescription
inputTokensnumber
outputTokensnumber
cacheReadTokensnumber
cacheWriteTokensnumber
costUsdnumber | null
contextTokensoptionalnumber | null
contextWindowoptionalnumber | null

ChatUsage

Fields

NameTypeDescription
chatIdstring
totalsobject
limitsAgentLimits
contextoptionalobject | null

ChatUsageNotice

Fields

NameTypeDescription
resetsAtstring | null
heldboolean

ChooseHeldBody

Fields

NameTypeDescription
agentIdstring

ChooseRemoteRunnerBody

Fields

NameTypeDescription
runnerIdstring | null

CitedClaim

Fields

NameTypeDescription
textstring
citationsstring[]

CliLoginPoll

Fields

NameTypeDescription
status"pending" | "approved" | "denied" | "expired"
keyoptionalstring
keyIdoptionalstring

CliLoginRequest

Fields

NameTypeDescription
codestring
hostnamestring
scopes("read" | "write" | "runners" | "admin")[]
status"pending" | "approved" | "denied" | "expired"
expiresAtstring

CliLoginStart

Fields

NameTypeDescription
codestring
deviceTokenstring
verifyUrlstring
intervalinteger
expiresAtstring

CliLoginStartBody

Fields

NameTypeDescription
hostnamestring
scopesoptional("read" | "write" | "runners" | "admin")[]

ClosedProjectRetentionDays

integer | null

Comment

Fields

NameTypeDescription
idstring
authorobject | null
bodystring
createdAtstring
editedAtstring | null
deletedboolean
attachmentsoptionalCommentAttachment[]

CommentAttachment

object | object | object

CommentThread

Fields

NameTypeDescription
idstring
workspaceIdstring
containerIdstring | null
anchorobject | object | object
resolvedboolean
resolvedByobject | null
createdAtstring
commentsComment[]
sentCommentThreadSent

CommentThreadSent

Fields

NameTypeDescription
atstring
byobject | null
agentstring
chatIdstring | null
messageIdstring | null

CommitActionFilesBody

Fields

NameTypeDescription
branchstring
filesActionFileWrite[]
messagestring
proposeoptionalboolean

CommitBody

Fields

NameTypeDescription
messagestring

ComponentState

"operational" | "degraded" | "down" | "maintenance" | "unknown"

ConfirmAppProposalBody

Fields

NameTypeDescription
layer"workspace" | "project"
projectIdoptionalstring
namestring
specobject
secretsoptionalAppSecretProposal[]

ConfirmMonitorProposalBody

Fields

NameTypeDescription
nameoptionalstring
scheduleoptionalstring | null
activeoptionalboolean
sheetIdoptionalstring | null

ConflictList

Fields

NameTypeDescription
conflictsFileConflict[]

ConflictSide

Fields

NameTypeDescription
kind"person" | "agent" | "project" | "disk"
namestring
userIdoptionalstring
containeroptionalstring
containerIdoptionalstring

ConnectIntegrationBody

Fields

NameTypeDescription
apiKeyoptionalstring
sealedoptionalSealedSecret
sealedCopiesoptionalSealedSecretCopy[]

ConnectRepoBody

Fields

NameTypeDescription
fullNamestring

Container

Fields

NameTypeDescription
idstring
workspaceIdstring
slugstring
titlestring
instructionsstring
flow"spec" | "direct"
status"creating" | "draft" | "ready" | "done"
agentState"idle" | "running" | "awaiting_input" | "error" | "background"
errorstring | null
errorAuthboolean
errorDetailoptionalSetupFailureDetail
activityContainerActivity
setupoptionalstring | null
planobject[]
backgroundChatBackgroundProcess[]
testRunsTestRun[]
progressProjectProgress
reportAtstring | null
criteriaobject
chatIdstring
blockIdstring | null
linksstring[]
chatLogBlockIdstring | null
specBlockIdoptionalstring | null
sourceSheetIdoptionalstring | null
sourceDocIdoptionalstring | null
linkedItemsoptionalProjectLink[]
contextoptionalContextManifestEntry[]
closedAtstring | null
parentIdoptionalstring | null
childCountoptionalobject
unstartedboolean
convertedAtstring | null
agentobject
reposContainerRepo[]
limitsContainerLimits
verificationDepth"quick" | "standard" | "thorough" | null
mergeQueueobject | null
reviewoptionalProjectReview
additionsinteger
deletionsinteger
projectAppsoptionalinteger
attachmentsoptionalContainerAttachment[]
createdByobject | null
createdAtstring
updatedAtstring

ContainerActivity

Fields

NameTypeDescription
textstring
stepsstring[]
writingSpecboolean

ContainerArchive

Fields

NameTypeDescription
specstring | null
blocksArchivedBlock[]
savedAtstring | null

ContainerAttachment

Fields

NameTypeDescription
idstring
namestring
sizeinteger
attachedByobject | null
attachedAtstring
pathstring
keptAsAttachmentKeptAs
pinnedRefstring | null
originPathstring | null
originVersionstring | null
addedBecausestring | null

ContainerAttachments

Fields

NameTypeDescription
attachmentsContainerAttachment[]

ContainerBlocksBody

Fields

NameTypeDescription
blockIdsoptionalstring[]
sheetIdoptionalstring | null
contextoptionalContextEntity[]
contextPathsoptionalContextPath[]

ContainerFollowUpEntries

Fields

NameTypeDescription
entriesContainerFollowUpEntry[]

ContainerFollowUpEntry

Fields

NameTypeDescription
titlestring
entryIdstring

ContainerLimits

Fields

NameTypeDescription
cpusnumber | null
memoryMbinteger | null
shmMbinteger | null

ContainerMergeBody

Fields

NameTypeDescription
methodoptionalMergeMethod

ContainerOutputs

Fields

NameTypeDescription
outputsMonitorOutput[]
targetOutputTarget

ContainerPrsBody

Fields

NameTypeDescription
titleoptionalstring
bodyoptionalstring
allowOpenCriteriaoptionalboolean

ContainerRepo

Fields

NameTypeDescription
linkIdstring
repoSlugstring
deployOrderinteger | null
followsIdstring | null
partinteger | null
autoRebaseboolean
repoIdstring
slugstring
fullNamestring
mode"worktree" | "readonly"
branchstring
basestring
additionsinteger
deletionsinteger
commitsinteger
dirtyinteger
pushedboolean
unpushedinteger
aheadBaseinteger
behindBaseinteger
upstreamBehindinteger
operation"merge" | "rebase" | "cherry_pick" | "revert" | null
conflictedstring[]
worktreeRemovedboolean
checkedOutoptionalboolean
probject | null

ContainerRepoOrderBody

Fields

NameTypeDescription
reposstring[]

ContainerReport

Fields

NameTypeDescription
textstring
updatedAtstring
followUpsContainerFollowUpEntry[]

ContextEntity

Fields

NameTypeDescription
kind"doc" | "prototype" | "project" | "research" | "canvas" | "block" | "file" | "repo" | "repo-branch" | "repo-pr" | "repo-issue" | "repo-commit" | "chat" | "monitor" | "stat" | "action" | "goal" | "url" | "file-lines" | "upload" | "branch" | "commit" | "message"
idstring
labeloptionalstring
blockTypeoptionalstring
scopeoptionalobject
repooptionalobject
partsoptionalstring[]

ContextManifestEntry

Fields

NameTypeDescription
keystring
kindstring
titlestring
viaoptionalstring
filesstring[]
aboutoptionalstring

ContextPath

string

ContinueChatBody

Fields

NameTypeDescription
textoptionalstring
provideroptional"claude" | "codex" | "cursor" | "grok" | "fake"
modeloptionalstring
effortoptionalstring
accountIdoptionalstring
agentIdoptionalstring
ruleIdoptionalstring

ContinueChatResult

Fields

NameTypeDescription
chatChat

ContinueInvestigationBody

Fields

NameTypeDescription
as"work" | "spec" | "prototype"
textoptionalstring
suggestionoptionalstring
provideroptional"claude" | "codex" | "cursor" | "grok" | "fake"
modeloptionalstring
effortoptionalstring
accountIdoptionalstring
agentIdoptionalstring
ruleIdoptionalstring

ContinueInvestigationResult

object | object

CreateActionBody

Fields

NameTypeDescription
titlestring
slugoptionalActionSlug
kindoptional"action" | "workflow"
filesoptionalActionFileWrite[]
describeoptionalstring
contextoptionalContextEntity[]
contextPathsoptionalContextPath[]
agentIdoptionalstring
runnerIdoptionalstring

CreateAgentAccountBody

Fields

NameTypeDescription
provider"claude" | "codex" | "cursor" | "grok" | "fake"
labeloptionalstring
apiKeyoptionalstring
sealedApiKeyoptionalSealedSecretCopy[]

CreateAlertChannelBody

Fields

NameTypeDescription
namestring
kindoptionalAlertChannelKind
urloptionalstring
sealedUrloptionalSealedSecret
hostoptionalstring
addressoptionalstring

CreateApiKeyBody

Fields

NameTypeDescription
namestring
scopes("read" | "write" | "runners" | "admin")[]
expiresInDaysoptionalinteger
roleoptional"admin" | "member"

CreateAppEnvironmentBody

Fields

NameTypeDescription
namestring
slugoptionalstring
sourcesoptionalobject[]
startoptionalboolean

CreateChatBody

Fields

NameTypeDescription
docIdoptionalstring
sheetIdoptionalstring
titleoptionalstring
canvasIdoptionalstring

CreateContainerBody

Fields

NameTypeDescription
instructionsoptionalstring
startoptionalboolean
flowoptional"spec" | "direct"
titleoptionalstring
parentIdoptionalstring
blockIdsoptionalstring[]
sheetIdoptionalstring | null
blocksoptionalBlockRef[]
docIdoptionalstring
linkedItemsoptionalProjectLink[]
contextoptionalContextEntity[]
contextPathsoptionalContextPath[]
reposoptionalobject[]
attachmentsoptionalstring[]
specBlockIdoptionalstring
xoptionalnumber
yoptionalnumber
fromChatoptionalobject
provideroptional"claude" | "codex" | "cursor" | "grok" | "fake"
modeloptionalstring
effortoptionalstring
accountIdoptionalstring
agentIdoptionalstring
ruleIdoptionalstring

CreateCrewRuleBody

Fields

NameTypeDescription
namestring
instructionsoptionalstring | null
agentIdsstring[]
modeoptional"in_order" | "agent_picks"
isDefaultoptionalboolean

CreateCronMonitorBody

Fields

NameTypeDescription
namestring
schedulestring
timezoneoptionalstring
graceSecondsoptionalinteger
maxRuntimeSecondsoptionalinteger | null
activeoptionalboolean
alertsoptionalobject

CreatedApiKey

Fields

NameTypeDescription
keyApiKey
secretstring

CreatedInvite

Fields

NameTypeDescription
inviteInvite
urlstring

CreatedRunner

Fields

NameTypeDescription
runnerRunner
tokenstring
commandstring
installCommandstring
installCommandWindowsstring
composeobject

CreateFeedbackEntryBody

Fields

NameTypeDescription
kindoptionalFeedbackKind
titleoptionalstring
bodyoptionalstring
nameoptionalstring
emailoptionalstring
pageoptionalstring

CreateFlowBody

Fields

NameTypeDescription
namestring
stepsoptionalFlowStep[]
scheduleoptionalstring | null
timezoneoptionalstring
activeoptionalboolean
environmentIdoptionalstring | null
alertsoptionalobject

CreateFollowUpBody

Fields

NameTypeDescription
linkIdstring

CreateGoalBody

Fields

NameTypeDescription
statementstring
titleoptionalstring
autonomyoptional"ask" | "autopilot"
alwaysAskoptionalGoalAlwaysAsk[]
reposoptionalobject[]
placeBlockoptionalboolean
blocksoptionalBlockRef[]
contextDocsoptionalChatContextDoc[]
contextCanvasesoptionalChatContextCanvas[]
attachmentsoptionalstring[]
contextoptionalContextEntity[]
contextPathsoptionalContextPath[]
provideroptional"claude" | "codex" | "cursor" | "grok" | "fake"
modeloptionalstring
effortoptionalstring
accountIdoptionalstring
agentIdoptionalstring
ruleIdoptionalstring

CreateIncidentBody

Fields

NameTypeDescription
titlestring
bodystring
statusoptionalIncidentStatus
impactoptionalIncidentImpact
componentIdsoptionalstring[]
publishedoptionalboolean
startedAtoptionalstring

CreateIncidentDraftBody

Fields

NameTypeDescription
kindIncidentDraftKind

CreateIncidentUpdateBody

Fields

NameTypeDescription
statusIncidentStatus
bodystring

CreateInsightBoardBody

Fields

NameTypeDescription
namestring
sourceIdstring
refreshMinutesoptionalinteger | null

CreateInsightSourceBody

Fields

NameTypeDescription
namestring
urloptionalstring
sealedUrloptionalSealedSecret
targetoptionalInsightTarget
sslModeoptionalInsightSslMode
allowSelfSignedoptionalboolean

CreateInvestigationBody

Fields

NameTypeDescription
questionstring
blocksoptionalBlockRef[]
reposoptionalobject[]
attachmentsoptionalstring[]
monitorIdsoptionalstring[]
contextoptionalContextEntity[]
contextPathsoptionalContextPath[]
provideroptional"claude" | "codex" | "cursor" | "grok" | "fake"
modeloptionalstring
effortoptionalstring
accountIdoptionalstring
agentIdoptionalstring
ruleIdoptionalstring

CreateInviteBody

Fields

NameTypeDescription
emailoptionalstring
roleoptional"admin" | "member" | "viewer"
maxUsesoptionalinteger

CreateMaintenanceBody

Fields

NameTypeDescription
titlestring
bodyoptionalstring | null
componentIdsoptionalstring[]
startsAtstring
endsAtstring

CreateMonitorEnvironmentBody

Fields

NameTypeDescription
namestring
isDefaultoptionalboolean

CreateOrgBody

Fields

NameTypeDescription
namestring
slugoptionalstring

CreateRepoBody

Fields

NameTypeDescription
namestring
privateoptionalboolean
owneroptionalstring

CreateRunnerBody

Fields

NameTypeDescription
namestring

CreateSheetBody

Fields

NameTypeDescription
namestring

CreateStatBody

Fields

NameTypeDescription
sheetIdoptionalstring | null
placeoptional"insights"
blockIdoptionalstring
sourceIdstring
questionstring
vizoptionalInsightViz
provideroptional"claude" | "codex" | "cursor" | "grok" | "fake"
modeloptionalstring
effortoptionalstring

CreateStatusComponentBody

Fields

NameTypeDescription
namestring
descriptionoptionalstring | null
positionoptionalinteger
flowIdsoptionalstring[]
cronIdsoptionalstring[]

CreateStatusPageBody

Fields

NameTypeDescription
titlestring
slugoptionalstring
descriptionoptionalstring | null
publishedoptionalboolean
subscriptionsEnabledoptionalboolean
autoIncidentModeoptionalAutoIncidentMode

CreateStorageBucketBody

Fields

NameTypeDescription
namestring
provider"r2" | "s3" | "gcs" | "s3c"
endpointoptionalstring
regionoptionalstring
bucketstring
accessKeyIdstring
secretAccessKeyoptionalstring
sealedSecretAccessKeyoptionalSealedSecret
isDefaultoptionalboolean
acceptsNewoptionalboolean

CreateSubProjectsBody

Fields

NameTypeDescription
itemsobject[]
baseoptional"parent" | "main"

CreateTerminalBody

Fields

NameTypeDescription
containeroptionalstring
newoptionalboolean

CreateUploadBody

Fields

NameTypeDescription
namestring
sizeinteger
contentTypeoptionalstring
containeroptionalstring
purposeoptional"uploads" | "attachments"
placeoptional"uploads"

CreateWorkspaceAgentBody

Fields

NameTypeDescription
provider"claude" | "codex" | "cursor" | "grok" | "fake"
namestring
modeloptionalstring | null
effortoptionalstring | null
instructionsoptionalstring | null
enabledoptionalboolean

CreateWorkspaceBody

Fields

NameTypeDescription
namestring
runnerIdstring
useGpuoptionalboolean
storageBucketIdoptionalstring
closedProjectRetentionDaysoptionalClosedProjectRetentionDays

CrewOverview

Fields

NameTypeDescription
rulesCrewRule[]
settingsCrewSettings

CrewRule

Fields

NameTypeDescription
idstring
workspaceIdstring
namestring
instructionsstring | null
agentIdsstring[]
mode"in_order" | "agent_picks"
isDefaultboolean
positioninteger
changedoptionalboolean
removedoptionalboolean

CrewRuleOverrideBody

Fields

NameTypeDescription
agentIdsoptionalstring[] | null
modeoptional"in_order" | "agent_picks" | null
instructionsoptionalstring | null
nameoptionalstring | null
removedoptionalboolean

CrewSettings

Fields

NameTypeDescription
crewNoOneLeft"ask" | "wait"
agentsMayMessageboolean
askBeforeAgentDocEditsboolean
agentTurnLimitinteger
delegateMaxChildreninteger
delegateMaxDepthinteger
askBeforeGoalAlwaysAsk[]
reviewerAgentIdstring | null

CronExecution

Fields

NameTypeDescription
idstring
statusCronExecutionStatus
startedAtstring | null
finishedAtstring | null
durationMsinteger | null
slowboolean

CronExecutionList

Fields

NameTypeDescription
executionsCronExecution[]

CronExecutionStatus

"running" | "succeeded" | "failed" | "stuck"

CronMonitor

Fields

NameTypeDescription
idstring
workspaceIdstring
namestring
pingTokenstring | null
pingUrlstring | null
schedulestring
timezonestring
graceSecondsinteger
maxRuntimeSecondsinteger | null
activeboolean
statusCronMonitorStatus
alertsMonitorAlertSettings
lastPingAtstring | null
lastDurationMsinteger | null
nextExpectedAtstring | null
recentCronExecution[]
liveAtstring | null
containerIdstring | null
docIdstring | null
missingstring[]
readyboolean
sourcesMonitorSource[]
changedCountinteger
createdAtstring
updatedAtstring

CronMonitorList

Fields

NameTypeDescription
monitorsCronMonitor[]

CronMonitorStatus

"new" | "healthy" | "late" | "stuck" | "failed" | "paused"

CronPing

Fields

NameTypeDescription
idstring
kindCronPingKind
durationMsinteger | null
payloadstring | null
sourceIpstring | null
receivedAtstring

CronPingAccepted

Fields

NameTypeDescription
oktrue

CronPingKind

"start" | "success" | "fail"

CronPingList

Fields

NameTypeDescription
pingsCronPing[]

DbQueryBody

Fields

NameTypeDescription
sqlstring

DbRows

Fields

NameTypeDescription
columnsstring[]
rows((string | null)[])[]
truncatedboolean

DirectTicket

Fields

NameTypeDescription
urlstring
ticketstring
expiresAtstring

DirectTicketBody

Fields

NameTypeDescription
purpose"terminal" | "file"
terminalIdoptionalstring
containeroptionalstring

DiscardBody

Fields

NameTypeDescription
pathsstring[]

DnsRecord

Fields

NameTypeDescription
type"TXT" | "A" | "CNAME"
namestring
valuestring | null
purposestring

DocEdit

Fields

NameTypeDescription
idstring
docIdstring
chatIdstring
chatMessageIdstring | null
batchIdstring
positioninteger
mode"direct" | "proposed"
agentstring | null
userIdstring | null
userNamestring | null
beforestring
afterstring
state"proposed" | "accepted" | "applied" | "undone"
createdAtstring

DocEditList

Fields

NameTypeDescription
editsDocEdit[]

DocNameSuggestions

Fields

NameTypeDescription
suggestionsstring[]

DocNameSuggestionsBody

Fields

NameTypeDescription
textstring

DocShare

Fields

NameTypeDescription
urlstring | null
createdAtstring
createdByobject | null
viewCountinteger
lastViewedAtstring | null

DocShareState

Fields

NameTypeDescription
shareDocShare
canManageboolean
allowedboolean

EdgeOrgUsage

Fields

NameTypeDescription
monthstring
bytesnumber
requestsnumber
limitBytesnumber
labelsinteger
labelLimitinteger

EditCommentBody

Fields

NameTypeDescription
bodystring

EditQueuedBody

Fields

NameTypeDescription
textstring

EmailCategory

"security" | "comments" | "agent_input" | "agent_result" | "conflicts" | "monitors"

EmailFactorDisableBody

Fields

NameTypeDescription
passwordstring

EmailPreferences

Fields

NameTypeDescription
securityboolean
commentsboolean
agent_inputboolean
agent_resultboolean
conflictsboolean
monitorsboolean

EmailUnsubscribed

Fields

NameTypeDescription
categoryEmailCategory

EnqueueMergeBody

Fields

NameTypeDescription
containerIdsstring[]
methodoptionalMergeMethod
closeAfteroptionalboolean
forceoptionalboolean

EnqueueMergeResult

Fields

NameTypeDescription
queueMergeQueue
skippedobject[]

FeedbackBody

Fields

NameTypeDescription
kind"feature" | "bug" | "other"
titleoptionalstring
bodyoptionalstring
workspaceIdoptionalstring
chatIdoptionalstring
messageIdoptionalstring
areaoptional"environment"
contextoptionalFeedbackContext

FeedbackContext

Fields

NameTypeDescription
areaoptional"environment"
runneroptionalFeedbackRunner
byoptional"agent"
pathoptionalstring
orgIdoptionalstring
workspaceIdoptionalstring
containerIdoptionalstring
appVersionoptionalstring
viewportoptionalobject

FeedbackEmailField

"off" | "optional" | "required"

FeedbackEntry

Fields

NameTypeDescription
idstring
sourceFeedbackSource
kindFeedbackKind
titlestring
bodystring
namestring | null
emailstring | null
pagestring | null
statusFeedbackStatus
statusByobject | null
statusAtstring | null
archivedAtstring | null
contextFeedbackContext & object | null
madeFeedbackLink[]
fromFeedbackFrom
createdAtstring

FeedbackEntryList

Fields

NameTypeDescription
entriesFeedbackEntry[]
inboxinteger
archivedinteger

FeedbackForm

Fields

NameTypeDescription
idstring
slugstring
titlestring
descriptionstring | null
publishedboolean
emailFeedbackEmailField
publicUrlstring
submitUrlstring

FeedbackFrom

Fields

NameTypeDescription
idstring | null
slugstring | null
titlestring
removedboolean

FeedbackKind

"feature" | "bug" | "other"

FeedbackRunner

Fields

NameTypeDescription
kind"official" | "official-pro" | "org" | "personal"
versionstring | null
driver"docker" | "process" | null
osstring | null
archstring | null
gpuboolean
useGpuboolean
kvmoptionalboolean
useKvmoptionalboolean

FeedbackSettings

Fields

NameTypeDescription
formFeedbackForm
yardConnectedboolean

FeedbackSource

"form" | "api" | "yard" | "project"

FeedbackStatus

"new" | "seen" | "in_progress" | "done"

FileConflict

Fields

NameTypeDescription
idstring
workspaceIdstring
containerstring | null
pathstring
titlestring | null
kind"text" | "image" | "binary"
source"save" | "sync-back" | "transfer" | "canvas"
blockIdstring | null
oursConflictSide
theirsConflictSide
hasBaseboolean
status"open" | "resolved"
resolution"ours" | "theirs" | "both" | "merged" | "superseded" | null
resolvedBystring | null
resolvedAtstring | null
createdAtstring

FileConflictDetail

Fields

NameTypeDescription
idstring
workspaceIdstring
containerstring | null
pathstring
titlestring | null
kind"text" | "image" | "binary"
source"save" | "sync-back" | "transfer" | "canvas"
blockIdstring | null
oursConflictSide
theirsConflictSide
hasBaseboolean
status"open" | "resolved"
resolution"ours" | "theirs" | "both" | "merged" | "superseded" | null
resolvedBystring | null
resolvedAtstring | null
createdAtstring
textobject | null
proposalstring | null

FileContent

Fields

NameTypeDescription
pathstring
contentstring
binaryboolean
sizenumber
truncatedboolean

FileList

Fields

NameTypeDescription
filesstring[]
truncatedboolean

FixStatBody

Fields

NameTypeDescription
provideroptional"claude" | "codex" | "cursor" | "grok" | "fake"
modeloptionalstring
effortoptionalstring

Flow

Fields

NameTypeDescription
idstring
workspaceIdstring
namestring
stepsFlowStep[]
schedulestring | null
timezonestring
activeboolean
environmentIdstring | null
webhookTokenstring | null
alertsMonitorAlertSettings
healthMonitorHealth
nextRunAtstring | null
lastRunFlowRunSummary
liveAtstring | null
containerIdstring | null
docIdstring | null
missingstring[]
readyboolean
sourcesMonitorSource[]
changedCountinteger
createdAtstring
updatedAtstring

FlowHookAccepted

Fields

NameTypeDescription
idstring
flowIdstring
status"running"

FlowList

Fields

NameTypeDescription
flowsFlowListItem[]

FlowListItem

Fields

NameTypeDescription
idstring
workspaceIdstring
namestring
schedulestring | null
timezonestring
activeboolean
environmentIdstring | null
webhookTokenstring | null
alertsMonitorAlertSettings
healthMonitorHealth
nextRunAtstring | null
lastRunFlowRunSummary
liveAtstring | null
containerIdstring | null
docIdstring | null
missingstring[]
readyboolean
sourcesMonitorSource[]
changedCountinteger
createdAtstring
updatedAtstring
stepCountinteger
recentobject[]
failingSincestring | null
failStreakinteger

FlowRunDetail

Fields

NameTypeDescription
idstring
flowIdstring
statusFlowRunStatus
triggeredByRunTrigger
environmentIdstring | null
runnerIdstring | null
reasonstring | null
durationMsinteger | null
responseTimeMsinteger | null
failedStepinteger | null
startedAtstring
finishedAtstring | null
stepsStepResult[]
stepCountinteger

FlowRunList

Fields

NameTypeDescription
runsFlowRunSummary[]
nextCursorstring | null

FlowRunStatus

"running" | "passed" | "failed" | "timeout" | "error" | "inconclusive"

FlowRunSummary

Fields

NameTypeDescription
idstring
flowIdstring
statusFlowRunStatus
triggeredByRunTrigger
environmentIdstring | null
runnerIdstring | null
reasonstring | null
durationMsinteger | null
responseTimeMsinteger | null
failedStepinteger | null
startedAtstring
finishedAtstring | null

FlowStep

Fields

NameTypeDescription
idstring
namestring
methodHttpMethod
urlstring
headersoptionalobject
bodyTypeoptional"json" | "text" | "form"
bodyoptionalstring | null
bodyWrappedoptionalboolean
sensitiveBodyoptionalboolean
assertionsoptionalAssertion[]
logsoptionalstring[]
timeoutMsoptionalinteger
retriesoptionalinteger
retryDelayMsoptionalinteger
runIfoptionalstring | null
alwaysRunoptionalboolean
capturesoptionalCapture[]

GitAbortResult

Fields

NameTypeDescription
aborted"merge" | "rebase" | "cherry_pick" | "revert"

GitConflicts

Fields

NameTypeDescription
conflictsboolean
filesstring[]
basestring

GitDiff

Fields

NameTypeDescription
diffstring
truncatedboolean

GitFileAtRef

Fields

NameTypeDescription
existsboolean
textstring | null
sizeinteger
truncatedboolean
shastring | null

GithubDisconnectPreview

Fields

NameTypeDescription
reposGithubDisconnectRepo[]

GithubDisconnectRepo

Fields

NameTypeDescription
idstring
fullNamestring
orgSlugstring
orgNamestring
workspacesobject[]
blockedBystring | null

GithubDisconnectResult

Fields

NameTypeDescription
oktrue
removedinteger
keptstring[]

GithubIdentity

Fields

NameTypeDescription
connectedboolean
loginstring | null
namestring | null
emailstring | null
kind"app" | "pat" | null
usableboolean

GithubInstallation

Fields

NameTypeDescription
idstring
installationIdinteger
accountLoginstring
accountTypestring
suspendedboolean

GithubPeek

object | object | object | object | object

GithubSigninBody

Fields

NameTypeDescription
nextoptionalstring

GithubSignupBody

Fields

NameTypeDescription
ticketstring
emailstring
passwordstring
namestring

GithubSignupPending

Fields

NameTypeDescription
loginstring
namestring | null
emailstring | null

GitPullResult

Fields

NameTypeDescription
updatedboolean
headstring | null

GitStatus

Fields

NameTypeDescription
branchstring | null
headstring | null
dirtyinteger
aheadinteger
behindinteger
upstreamstring | null
additionsinteger
deletionsinteger
aheadBaseinteger
behindBaseinteger
operation"merge" | "rebase" | "cherry_pick" | "revert" | null
conflictedstring[]
basestring | null

GitUpdateResult

Fields

NameTypeDescription
result"merged" | "up_to_date" | "conflict"
headstring | null
filesstring[]
basestring
renumberedoptionalobject[]

GiveActionToChatBody

Fields

NameTypeDescription
chatIdstring

Goal

Fields

NameTypeDescription
idstring
workspaceIdstring
slugstring
titlestring
statementstring
autonomy"ask" | "autopilot"
alwaysAskGoalAlwaysAsk[]
state"running" | "waiting" | "paused" | "done" | "error"
pausedAtstring | null
pausedByobject | null
pausedReason"person" | "budget" | null
budgetCentsinteger | null
chatIdstring | null
docIdstring | null
reposobject[]
health"on-track" | "at-risk" | "off-track" | null
healthTextstring | null
healthAtstring | null
reviewCapinteger
concurrencyinteger
contextGoalContextItem[]
boardDocOnboolean
createdByobject | null
createdAtstring
updatedAtstring
closedAtstring | null
changesGoalChange[]
usageGoalUsage
criteriaobject
projectsobject
openQuestionstring | null
needsYouboolean
appChangesinteger
decisionsGoalDecisions
waitingGoalWaiting[]
lastCheckGoalCheck
iterationGoalIteration | null
iterationsGoalIteration[]
waitingFor"question" | "apps" | "design" | "merge" | "stage-question" | "paused" | "always-ask" | "review" | "stuck" | "met" | null
stallsinteger

GoalAlwaysAsk

Fields

NameTypeDescription
kind"apps" | "secrets" | "delete-data" | "spend" | "merge" | "custom"
labelstring
amountoptionalinteger

GoalAppDiffLine

Fields

NameTypeDescription
op"+" | "-"
keystring
textstring

GoalAppProposal

Fields

NameTypeDescription
chatIdstring
messageIdstring
indexinteger
containerIdstring | null
stageinteger | null
repostring
namestring
kind"add" | "change"
whystring | null
linesGoalAppDiffLine[]
specobject
secretsstring[]

GoalApps

Fields

NameTypeDescription
reposstring[]
appsResolvedApp[]
runsOnobject | null
proposalsGoalAppProposal[]
secretsNeededobject[]

GoalBoard

Fields

NameTypeDescription
goalIdstring
columnsobject
reviewCapinteger
reviewCountinteger
concurrencyinteger
runninginteger

GoalBudgetBody

Fields

NameTypeDescription
budgetCentsinteger | null

GoalChange

Fields

NameTypeDescription
idstring
kind"plan" | "section"
summarystring
diffGoalDiffLine[]
headingstring | null
chatMessageIdstring | null
createdAtstring
undoneAtstring | null

GoalCheck

Fields

NameTypeDescription
branchstring | null
commandstring
okboolean
atstring

GoalContextItem

Fields

NameTypeDescription
refContextEntity
keptAs"live" | "copy" | "link" | "commit"

GoalDecision

Fields

NameTypeDescription
sectionstring
keystring
valuestring
state"you" | "recommended" | "assumed" | "open" | "limit"
whystring

GoalDecisions

Fields

NameTypeDescription
totalinteger
decidedinteger
openinteger
limitsinteger
readinessnumber
confidence"Low" | "Fair" | "Good" | "High"
sectionsobject[]
assumedGoalDecision[]
openRowsGoalDecision[]
limitRowsGoalDecision[]

GoalDiffLine

Fields

NameTypeDescription
op"+" | "-" | "~"
textstring

GoalIteration

Fields

NameTypeDescription
idstring
indexinteger
reason"first" | "continue" | "answered" | "note" | "project-finished" | "project-stuck" | "apps-applied" | "resumed" | "verify" | "retry" | "design-kept" | "design-timeout" | "stage-start" | "stage-finished" | "stage-merged" | "stage-stuck"
detailstring | null
phase"goal" | "decisions" | "design" | "build" | "met"
summarystring | null
startedAtstring
endedAtstring | null
outcome"progress" | "waiting" | "no-change" | "error" | null
runningboolean

GoalList

Fields

NameTypeDescription
goalsGoal[]
closedDocIdsstring[]

GoalStageFeedbackBody

Fields

NameTypeDescription
textstring

GoalStageRun

Fields

NameTypeDescription
containerIdstring
slugstring

GoalUsage

Fields

NameTypeDescription
agentMsnumber
costUsdnumber
turnsinteger

GoalWaiting

Fields

NameTypeDescription
kind"question" | "secret" | "apps" | "design" | "stage" | "merge"
titlestring
detailstring
appoptionalstring
nameoptionalstring

GrepResult

Fields

NameTypeDescription
matchesobject[]
truncatedboolean

Health

Fields

NameTypeDescription
okboolean
versionstring
timestring

History

Fields

NameTypeDescription
headstring | null
dirtystring[]
commitsHistoryCommit[]

HistoryCommit

Fields

NameTypeDescription
shastring
shortstring
messagestring
authorstring
datestring
isHeadboolean

HistoryResult

Fields

NameTypeDescription
shastring | null

HostedTicket

Fields

NameTypeDescription
redirectstring
ticketstring
expiresAtstring

HostedTicketBody

Fields

NameTypeDescription
urlstring

HostingDoctorApplyResult

Fields

NameTypeDescription
appliedstring[]
reportHostingDoctorReport

HostingDoctorReport

Fields

NameTypeDescription
mode"host-direct" | "container" | "coolify" | "host-proxy" | "standalone"
modeSummarystring
checksobject[]
skippedobject[]
proposalobject | null
routeobject | null

HostingDomainStatus

Fields

NameTypeDescription
domainstring
status"pending" | "verified" | "failed"
method"txt" | "admin" | "migrated" | null
verifiedAtstring | null
lastCheckedAtstring | null
lastErrorstring | null
graceUntilstring | null
recordsDnsRecord[]

HostingRunnerChoice

Fields

NameTypeDescription
idstring
namestring
kind"org" | "personal" | "official"
onlineboolean
domainstring | null
edgeDomainstring | null

HostingState

Fields

NameTypeDescription
enabledboolean
dockerboolean
dockerReasonoptionalstring | null
proxy"off" | "starting" | "up" | "down"
portsstring[]
certificate"none" | "manual" | "acme" | "self-signed"
originCertificatestring | null
fingerprintstring | null
tunnel"off" | "connecting" | "connected" | "error"
tunnelsinteger | null
maxAppsinteger
lastErrorstring | null
listenoptionalstring | null
listenFromoptional"env" | "machine" | "yard" | "default" | "auto" | null
listenSuggestionoptionalstring | null
behindProxyoptionalobject | null
proxyInfooptionalobject | null
problemsoptionalobject[] | null

HttpMethod

"GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS"

ImportFlowBody

Fields

NameTypeDescription
format"curl" | "postman" | "openapi"
sourcestring
nameoptionalstring

ImportFlowResult

Fields

NameTypeDescription
namestring
stepsFlowStep[]
warningsstring[]

Incident

Fields

NameTypeDescription
idstring
pageIdstring
pageSlugstring
pageTitlestring
workspaceIdstring
titlestring
statusIncidentStatus
impactIncidentImpact
componentIdsstring[]
publishedboolean
autoCreatedboolean
autoMonitorKeysstring[]
resolveProposedAtstring | null
internalNotestring | null
startedAtstring
resolvedAtstring | null
updatesIncidentUpdate[]
hasPostmortemboolean
createdAtstring
updatedAtstring

IncidentDraft

Fields

NameTypeDescription
idstring
incidentIdstring
evidenceIdstring
kindIncidentDraftKind
statusIncidentDraftStatus
draftIncidentDraftContent
droppedinteger
errorstring | null
agentstring | null
modelstring | null
requestedBystring | null
reviewedBystring | null
reviewedAtstring | null
createdAtstring

IncidentDraftContent

Fields

NameTypeDescription
observationsCitedClaim[]
hypothesesCitedClaim[]
summaryoptionalstring
impactoptionalstring
rootCauseoptionalstring
contributingFactorsoptionalstring
resolutionoptionalstring
lessonsoptionalstring
actionItemsoptionalobject[]

IncidentDraftDetail

Fields

NameTypeDescription
idstring
incidentIdstring
evidenceIdstring
kindIncidentDraftKind
statusIncidentDraftStatus
draftIncidentDraftContent
droppedinteger
errorstring | null
agentstring | null
modelstring | null
requestedBystring | null
reviewedBystring | null
reviewedAtstring | null
createdAtstring
evidenceIncidentEvidenceItem[]

IncidentDraftField

"summary" | "impact" | "rootCause" | "contributingFactors" | "resolution" | "lessons" | "actionItems"

IncidentDraftKind

"brief" | "postmortem"

IncidentDraftList

Fields

NameTypeDescription
draftsIncidentDraft[]

IncidentDraftStatus

"pending" | "ready" | "error" | "reviewed" | "applied"

IncidentEvidenceItem

Fields

NameTypeDescription
idstring
sourceTypestring
sourceIdstring
occurredAtstring
titlestring
detailoptionalunknown

IncidentImpact

"none" | "minor" | "major" | "critical"

IncidentList

Fields

NameTypeDescription
incidentsIncident[]

IncidentStatus

"investigating" | "identified" | "monitoring" | "resolved"

IncidentUpdate

Fields

NameTypeDescription
idstring
statusIncidentStatus
bodystring
createdBystring | null
createdAtstring

InsightAccess

"ai" | "people"

InsightBoard

Fields

NameTypeDescription
idstring
workspaceIdstring
sourceIdstring
namestring
holderboolean
sheetIdstring | null
refreshMinutesinteger | null
lastRefreshedAtstring | null
cardsInsightCard[]
createdAtstring

InsightBoardList

Fields

NameTypeDescription
boardsobject[]

InsightCard

Fields

NameTypeDescription
idstring
boardIdstring
sourceIdstring
sheetIdstring | null
blockIdstring | null
questionstring
titlestring
sqlstring
vizInsightViz
mappingInsightMapping
statusInsightCardStatus
proposalInsightProposal
askedQuestionstring | null
errorstring | null
refreshMinutesinteger | null
lastRunAtstring | null
positioninteger
latestInsightSnapshot
trendnumber[]
columnsInsightResultColumn[]
sourceNamestring
tablesstring[]
createdAtstring

InsightCardStatus

"proposed" | "approved"

InsightColumn

Fields

NameTypeDescription
namestring
typestring
nullableboolean
visibleboolean
accessInsightAccess
detectedInsightDetected

InsightDetected

"personal" | null

InsightMapping

Fields

NameTypeDescription
xoptionalstring
yoptionalstring[]
valueoptionalstring
labeloptionalstring
horizontaloptionalboolean

InsightProposal

Fields

NameTypeDescription
questionstring
sqlstring
titlestring
vizInsightViz
mappingInsightMapping
atstring

InsightResult

Fields

NameTypeDescription
columnsstring[]
rowsobject[]
truncatedboolean
durationMsinteger

InsightResultColumn

Fields

NameTypeDescription
namestring
typestring
accessInsightAccess
detectedInsightDetected
ownboolean
derivedboolean

InsightSnapshot

Fields

NameTypeDescription
idstring
resultInsightResult
errorstring | null
takenAtstring

InsightSource

Fields

NameTypeDescription
idstring
workspaceIdstring
namestring
displaystring
sslModeInsightSslMode
allowSelfSignedboolean
tablesInsightTable[]
introspectedAtstring | null
statsinteger
createdAtstring

InsightSourceList

Fields

NameTypeDescription
sourcesInsightSource[]

InsightSslMode

"disable" | "require" | "verify-full"

InsightTable

Fields

NameTypeDescription
schemastring
namestring
visibleboolean
columnsInsightColumn[]

InsightTarget

Fields

NameTypeDescription
hoststring
portinteger | null
databasestring

InsightViz

"stat" | "table" | "line" | "bar"

InstallUrl

Fields

NameTypeDescription
urlstring

Integration

Fields

NameTypeDescription
providerIntegrationProvider
connectedboolean
hintstring | null
connectedAtstring | null
unreadableboolean

IntegrationList

Fields

NameTypeDescription
integrationsIntegration[]

IntegrationProvider

"mistral"

Investigation

Fields

NameTypeDescription
sheetIdstring
namestring
chatIdstring | null
questionstring
state"running" | "finished" | "failed"
errorstring | null
blocksPostedinteger | null
createdByobject | null
createdAtstring
finishedAtstring | null
docIdstring | null
answerstring | null

InvestigationList

Fields

NameTypeDescription
investigationsInvestigation[]

Invite

Fields

NameTypeDescription
idstring
emailstring | null
role"owner" | "admin" | "member" | "viewer"
workspaceIdstring | null
workspaceRole"owner" | "editor" | "viewer" | null
maxUsesinteger | null
usesinteger
expiresAtstring
createdAtstring
invitedBystring

InvitePreview

Fields

NameTypeDescription
orgNamestring
orgSlugstring
role"owner" | "admin" | "member" | "viewer"
emailstring | null
invitedBystring
workspaceNamestring | null

KillProcessBody

Fields

NameTypeDescription
containeroptionalstring
pidinteger

Library

Fields

NameTypeDescription
docsobject[]
prototypesobject[]

License

Fields

NameTypeDescription
idstring
userIdstring
namestring
paidBy"self" | "org"
orgNamestring | null
planstring
interval"month" | "year" | null
status"active" | "past_due" | "ended"
renewsAtstring | null
cancelAtPeriodEndboolean
expiresAtstring | null
freeboolean

LinkPreview

Fields

NameTypeDescription
urlstring
titlestring | null
descriptionstring | null
imagestring | null
sitestring | null
frameableoptionalboolean

LinkPreviewBody

Fields

NameTypeDescription
urlstring

MaintenanceList

Fields

NameTypeDescription
maintenanceMaintenanceWindow[]

MaintenanceWindow

Fields

NameTypeDescription
idstring
pageIdstring
componentIdsstring[]
titlestring
bodystring | null
startsAtstring
endsAtstring
state"scheduled" | "in_progress" | "completed"
createdAtstring

Me

Fields

NameTypeDescription
userUser
orgsOrgSummary[]

Member

Fields

NameTypeDescription
userIdstring
namestring
emailstring
role"owner" | "admin" | "member" | "viewer"
joinedAtstring

MergeMethod

"merge" | "squash" | "rebase"

MergeOutputsBody

Fields

NameTypeDescription
idsoptionalstring[]
sheetIdoptionalstring | null

MergeOutputsResult

Fields

NameTypeDescription
mergedMonitorOutput[]
stayedMonitorOutput[]
targetOutputTarget

MergePrBody

Fields

NameTypeDescription
methodoptional"merge" | "squash" | "rebase"

MergeQueue

Fields

NameTypeDescription
itemsMergeQueueItem[]
waitForChecksboolean
pausedobject | null

MergeQueueItem

Fields

NameTypeDescription
idstring
containerIdstring
slugstring
titlestring
stateMergeQueueState
positioninteger | null
methodMergeMethod
closeAfterboolean
attemptsinteger
errorstring | null
queuedByobject | null
createdAtstring
updatedAtstring
finishedAtstring | null

MergeQueueState

"queued" | "preparing" | "resolving" | "waiting" | "checks" | "merging" | "merged" | "failed" | "removed"

MigrateDocsResult

Fields

NameTypeDescription
madeinteger

MonitorAlert

Fields

NameTypeDescription
idstring
workspaceIdstring
monitorKind"flow" | "cron" | "runner"
monitorIdstring
monitorNamestring
eventMonitorAlertEvent
messagestring
createdAtstring

MonitorAlertEvent

"failing" | "recovered" | "late" | "failed" | "stuck" | "slow" | "runner_offline" | "runner_online"

MonitorAlertList

Fields

NameTypeDescription
alertsMonitorAlert[]

MonitorAlertSettings

Fields

NameTypeDescription
enabledoptionalboolean
failThresholdoptionalinteger
cooldownMinutesoptionalinteger
notifyRecoveryoptionalboolean

MonitorEnvironment

Fields

NameTypeDescription
idstring
workspaceIdstring
namestring
isDefaultboolean
varsMonitorEnvVar[]
liveAtstring | null
containerIdstring | null
docIdstring | null
missingstring[]
readyboolean
sourcesMonitorSource[]
changedCountinteger
createdAtstring
updatedAtstring

MonitorEnvironmentList

Fields

NameTypeDescription
environmentsMonitorEnvironment[]

MonitorEnvVar

Fields

NameTypeDescription
namestring
secretboolean
valuestring | null
setboolean
updatedAtstring

MonitorHealth

"new" | "passing" | "failing" | "paused" | "unknown"

MonitorKind

"flow" | "cron" | "environment"

MonitorOutput

Fields

NameTypeDescription
kindMonitorKind
idstring
namestring
liveAtstring | null
readyboolean
missingstring[]
sourcesMonitorSource[]

MonitorProposalCreated

Fields

NameTypeDescription
monitor"flow" | "cron" | "environment"
idstring
docIdstring
messageChatMessage

MonitorSettings

Fields

NameTypeDescription
runRetentionDaysinteger

MonitorSource

Fields

NameTypeDescription
idstring
repoIdstring
repostring
repoFullNamestring
pathstring
linkedBlobstring | null
currentBlobstring | null
changedboolean
goneboolean
commitobject | null
checkedAtstring | null

MonitorSourceList

Fields

NameTypeDescription
sourcesMonitorSource[]
changedCountinteger
notestring | null

MonitorsWaiting

Fields

NameTypeDescription
sheetsobject[]
projectsobject[]
countinteger

MountRepoBody

Fields

NameTypeDescription
repoIdstring

MoveGoalProjectBody

Fields

NameTypeDescription
columnoptional"forYou" | "nextUp" | "working" | "done"
positioninteger

MyLicense

Fields

NameTypeDescription
enabledboolean
paymentsReadyboolean
planPlan
licensesLicense[]
licensedboolean
hasCustomerboolean

MyVaults

Fields

NameTypeDescription
userIdstring
vaultsobject[]

Need

Fields

NameTypeDescription
desktopoptionalboolean
osoptional"linux" | "macos" | "windows"
realScreenoptionalboolean
gpuoptionalboolean
kvmoptionalboolean
whyoptionalstring

Ok

Fields

NameTypeDescription
oktrue

OpenBlockChatBody

Fields

NameTypeDescription
blockIdstring
sheetIdoptionalstring | null
titleoptionalstring

OpenChatTerminalBody

Fields

NameTypeDescription
colsoptionalinteger
rowsoptionalinteger
provideroptional"claude" | "codex" | "cursor" | "grok" | "fake"
modeloptionalstring
effortoptionalstring
accountIdoptionalstring
agentIdoptionalstring
ruleIdoptionalstring

OpenPrBody

Fields

NameTypeDescription
titlestring
bodyoptionalstring

OrderBody

Fields

NameTypeDescription
idsstring[]

Org

Fields

NameTypeDescription
idstring
slugstring
namestring
planstring
retentionDaysinteger
defaultAgentstring | null
defaultModelstring | null
defaultEffortstring | null
allowedEmailDomainsstring[]
agentFeedbackboolean
publicReadableNamesboolean
allowPublicDocLinksboolean
role"owner" | "admin" | "member" | "viewer"
memberCountinteger
createdAtstring

OrgDocShares

Fields

NameTypeDescription
liveinteger

OrgGithub

Fields

NameTypeDescription
configuredboolean
appSlugstring | null
installationsGithubInstallation[]
meGithubIdentity

OrgStorage

Fields

NameTypeDescription
kind"managed" | "r2" | "s3" | "gcs"
endpointstring | null
regionstring | null
bucketstring | null
accessKeyIdstring | null
hasSecretboolean
usableboolean

OrgSummary

Fields

NameTypeDescription
idstring
slugstring
namestring
role"owner" | "admin" | "member" | "viewer"

OrgUsage

Fields

NameTypeDescription
measuredAtstring
totalsobject
workspacesobject[]
publicHostingEdgeOrgUsage & object | null

OrgVault

Fields

NameTypeDescription
orgIdstring
vaultVaultKey
holdersVaultHolder[]
pendingVaultCandidate[]
canManageboolean
legacySecretsinteger
reachableboolean
sealedSecretsinteger

OutputTarget

Fields

NameTypeDescription
sheetIdstring | null
docIdstring
namestring

Passkey

Fields

NameTypeDescription
idstring
namestring
createdAtstring
lastUsedAtstring | null

PasskeyLoginBody

Fields

NameTypeDescription
ticketstring
challengeIdoptionalstring
responseobject

PasskeyLoginOptionsBody

Fields

NameTypeDescription
challengeIdoptionalstring

PasskeyRegisterBody

Fields

NameTypeDescription
namestring
responseobject

PatchActionBody

Fields

NameTypeDescription
titleoptionalstring
toolEnabledoptionalboolean
toolNameoptionalstring
toolDescriptionoptionalstring
toolAccessoptionalActionToolAccess
toolProjectsoptionalstring[]

PatchActionSettingsBody

Fields

NameTypeDescription
gitEnabledoptionalboolean
remoteRepooptionalstring | null
branchoptionalstring
inboundoptionalActionInbound
runnerIdoptionalstring | null
maxParalleloptionalinteger
keepRunsDaysoptionalinteger
agentsMayEditoptionalboolean
notifyUserIdsoptionalstring[]

PatchAlertChannelBody

Fields

NameTypeDescription
nameoptionalstring
enabledoptionalboolean

PatchAppEnvironmentBody

Fields

NameTypeDescription
nameoptionalstring
sourcesoptionalobject[]

PatchCardColumnsBody

Fields

NameTypeDescription
columnsobject

PatchCronMonitorBody

Fields

NameTypeDescription
nameoptionalstring
scheduleoptionalstring
timezoneoptionalstring
graceSecondsoptionalinteger
maxRuntimeSecondsoptionalinteger | null
activeoptionalboolean
alertsoptionalobject
rotatePingTokenoptionaltrue

PatchedFeedbackEntry

Fields

NameTypeDescription
idstring
sourceFeedbackSource
kindFeedbackKind
titlestring
bodystring
namestring | null
emailstring | null
pagestring | null
statusFeedbackStatus
statusByobject | null
statusAtstring | null
archivedAtstring | null
contextFeedbackContext & object | null
madeFeedbackLink[]
fromFeedbackFrom
createdAtstring
takeBackstring | null

PatchFeedbackEntryBody

Fields

NameTypeDescription
statusoptionalFeedbackStatus
archivedoptionalboolean

PatchFlowBody

Fields

NameTypeDescription
nameoptionalstring
stepsoptionalFlowStep[]
scheduleoptionalstring | null
timezoneoptionalstring
activeoptionalboolean
environmentIdoptionalstring | null
alertsoptionalobject
rotateWebhookTokenoptionaltrue

PatchIncidentBody

Fields

NameTypeDescription
titleoptionalstring
statusoptionalIncidentStatus
impactoptionalIncidentImpact
componentIdsoptionalstring[]
publishedoptionalboolean
internalNoteoptionalstring | null
startedAtoptionalstring
dismissResolveProposaloptionaltrue

PatchInsightBoardBody

Fields

NameTypeDescription
nameoptionalstring
refreshMinutesoptionalinteger | null

PatchInsightCardBody

Fields

NameTypeDescription
titleoptionalstring
vizoptionalInsightViz
mappingoptionalInsightMapping
positionoptionalinteger
sqloptionalstring
refreshMinutesoptionalStatRefresh

PatchInsightSourceBody

Fields

NameTypeDescription
nameoptionalstring
urloptionalstring
sealedUrloptionalSealedSecret
targetoptionalInsightTarget
sslModeoptionalInsightSslMode
allowSelfSignedoptionalboolean
tablesoptionalobject[]

PatchMaintenanceBody

Fields

NameTypeDescription
titleoptionalstring
bodyoptionalstring | null
componentIdsoptionalstring[]
startsAtoptionalstring
endsAtoptionalstring

PatchMonitorEnvironmentBody

Fields

NameTypeDescription
nameoptionalstring
isDefaultoptionaltrue

PatchStatusComponentBody

Fields

NameTypeDescription
nameoptionalstring
descriptionoptionalstring | null
positionoptionalinteger
flowIdsoptionalstring[]
cronIdsoptionalstring[]

PatchStatusPageBody

Fields

NameTypeDescription
titleoptionalstring
slugoptionalstring
descriptionoptionalstring | null
publishedoptionalboolean
subscriptionsEnabledoptionalboolean
autoIncidentModeoptionalAutoIncidentMode

PauseActionBody

Fields

NameTypeDescription
pausedboolean

Plan

Fields

NameTypeDescription
idstring
namestring
summarystring
versioninteger
monthlyCentsinteger
yearlyCentsinteger
currencystring
limitsPlanLimits
isDefaultboolean
buyableobject
updatedAtstring

PlanLimits

Fields

NameTypeDescription
minSeatsinteger
coversOrgboolean

PlanList

Fields

NameTypeDescription
plansPlan[]
updatedAtstring | null

Postmortem

Fields

NameTypeDescription
incidentIdstring
summarystring | null
impactstring | null
rootCausestring | null
contributingFactorsstring | null
resolutionstring | null
lessonsstring | null
actionItemsPostmortemActionItem[]
publishedboolean
updatedBystring | null
updatedAtstring | null
markdownstring

PostmortemActionItem

Fields

NameTypeDescription
titlestring
owneroptionalstring | null
dueDateoptionalstring | null
doneoptionalboolean

Preferences

Fields

NameTypeDescription
layoutoptionalobject
filesoptionalobject
canvasoptionalobject
contextoptionalobject
pinsoptionalobject
recentoptionalRecentItem[]
previewsoptionalobject

PreferencesResponse

Fields

NameTypeDescription
preferencesPreferences

PreviewOpen

Fields

NameTypeDescription
urlstring
redirectstring
expiresAtstring

PreviewOpenBody

Fields

NameTypeDescription
pathoptionalstring

PreviewPort

Fields

NameTypeDescription
portinteger
addressstring
pidinteger | null
ancestorsinteger[]
commandstring
urlstring
publishedobject | null
proposalsPublishLabel[]

PreviewPorts

Fields

NameTypeDescription
enabledboolean
runningboolean
portsPreviewPort[]
publishingPublishOptions
publishedPublishedPort[]

ProcessList

Fields

NameTypeDescription
supportedboolean
processesobject[]

ProjectApps

Fields

NameTypeDescription
appsResolvedApp[]
hiddenobject[]
runsOnHostingRunnerChoice & object | null
blockedstring | null

ProjectNeeds

Fields

NameTypeDescription
needNeed & object | null
needKeystring | null
needLabelstring | null
metHereboolean
chosenobject | null
runnersRemoteRunner[]
canChooseboolean

ProjectPreview

Fields

NameTypeDescription
containerIdstring
slugstring
titlestring
repostring
namestring
instanceAppInstance

ProjectProgress

Fields

NameTypeDescription
state"planning" | "working" | "blocked" | "done" | null
currentPhaseinteger | null
updatedstring | null
lastActionstring | null
phasesobject[]

ProjectReview

Fields

NameTypeDescription
state"reviewing" | "done" | "failed"
agentstring
agentIdstring
chatIdstring | null
commentsinteger
summarystring | null
errorstring | null
atstring

PrototypePrefs

Fields

NameTypeDescription
kindoptional"web" | "mobile" | "tablet" | "dashboard" | "desktop" | "landing" | "email" | "slides"
directionsoptional1 | 2 | 3
lookoptional"wireframe" | "product" | "polished"
alsooptional("empty" | "errors" | "loading" | "dialogs")[]

PublicFeedbackForm

Fields

NameTypeDescription
slugstring
titlestring
descriptionstring | null
emailFeedbackEmailField
urlstring

PublicIncident

Fields

NameTypeDescription
idstring
titlestring
statusIncidentStatus
impactIncidentImpact
componentIdsstring[]
startedAtstring
resolvedAtstring | null
updatesPublicIncidentUpdate[]
postmortemPublicPostmortem

PublicIncidentDetail

Fields

NameTypeDescription
pagePublicStatusPageInfo
componentsobject[]
incidentPublicIncident

PublicIncidentUpdate

Fields

NameTypeDescription
idstring
statusIncidentStatus
bodystring
createdAtstring

PublicMaintenance

Fields

NameTypeDescription
idstring
titlestring
bodystring | null
componentIdsstring[]
startsAtstring
endsAtstring
activeboolean

PublicPostmortem

Fields

NameTypeDescription
summarystring | null
impactstring | null
rootCausestring | null
contributingFactorsstring | null
resolutionstring | null
lessonsstring | null
actionItemsobject[]
updatedAtstring | null

PublicStatusComponent

Fields

NameTypeDescription
idstring
namestring
descriptionstring | null
stateComponentState
uptime30dnumber | null
uptime90dnumber | null
daysobject[]

PublicStatusHistory

Fields

NameTypeDescription
pagePublicStatusPageInfo
componentsobject[]
incidentsPublicIncident[]
maintenancePublicMaintenance[]

PublicStatusPage

Fields

NameTypeDescription
pagePublicStatusPageInfo
stateComponentState
updatedAtstring
componentsPublicStatusComponent[]
incidentsPublicIncident[]
recentPublicIncident[]
maintenancePublicMaintenance[]

PublicStatusPageInfo

Fields

NameTypeDescription
slugstring
titlestring
descriptionstring | null
urlstring
subscriptionsEnabledboolean

PublishedPort

Fields

NameTypeDescription
portinteger
urlstring
hoststring
labelstring
domainstring
edgeboolean
visibilityPublishVisibility
untilPublishUntil
runnerobject
publishedByobject | null
publishedAtstring
commandstring | null

PublishLabel

Fields

NameTypeDescription
labelstring
domainstring
edgeboolean

PublishOptions

Fields

NameTypeDescription
possibleboolean
reason"viewer" | "no_hosting_runner" | "hosting_down" | "no_domain" | "runner_update" | null
messagestring | null
runnerobject | null

PublishPortBody

Fields

NameTypeDescription
labelstring
domainstring
visibilityoptionalPublishVisibility
untiloptionalPublishUntil

PublishUntil

"process" | "box" | "manual"

PublishVisibility

"team" | "public"

PullRequest

Fields

NameTypeDescription
numberinteger
urlstring
titlestring
state"open" | "closed" | "merged"
draftboolean

PullRequestState

Fields

NameTypeDescription
prPullRequest
pushedboolean
mergeable"mergeable" | "conflicting" | "unknown" | null

PutActionFolderBody

Fields

NameTypeDescription
pathstring
holdsoptionalstring
keepoptionalobject

PutActionSecretBody

Fields

NameTypeDescription
namestring
sealedoptionalSealedSecret
valueoptionalstring
scopeoptionalActionSecretScope
actionIdsoptionalstring[]
stepRefoptionalstring

PutActionToolBody

Fields

NameTypeDescription
namestring
versionoptionalstring
scriptstring
sourceoptionalstring

PutAppConfigBody

Fields

NameTypeDescription
specobject

PutAppEnvBody

Fields

NameTypeDescription
entriesobject[]

PutAppEnvVarBody

Fields

NameTypeDescription
valuestring | null
secretoptionalboolean
sealedoptionalSealedSecret

PutMonitorEnvVarBody

Fields

NameTypeDescription
valuestring | null
secretoptionalboolean
sealedoptionalSealedSecret

PutPostmortemBody

Fields

NameTypeDescription
summaryoptionalstring | null
impactoptionalstring | null
rootCauseoptionalstring | null
contributingFactorsoptionalstring | null
resolutionoptionalstring | null
lessonsoptionalstring | null
actionItemsoptionalPostmortemActionItem[]
publishedoptionalboolean

PutWorkspaceAppsSettingsBody

Fields

NameTypeDescription
runnerIdoptionalstring | null
domainoptionalstring | null
previewVisibilityoptionalAppVisibility

QuickStart

Fields

NameTypeDescription
stepsobject
doneinteger
totalinteger
hiddenAtstring | null

RecentItem

Fields

NameTypeDescription
kind"doc" | "prototype" | "project" | "research" | "file"
idstring
workspacestring
titlestring
atstring
countinteger
sincestring

RecoveryCodes

Fields

NameTypeDescription
recoveryCodesstring[]

RefreshAttachmentBody

Fields

NameTypeDescription
forceoptionalboolean

ReleaseRepoResult

Fields

NameTypeDescription
releasedboolean
kept"in_use" | "on_canvas" | null
messagestring | null

RemoteRun

Fields

NameTypeDescription
idstring
containerIdstring
runnerIdstring | null
runnerNamestring
needKeystring
commandstring
state"queued" | "running" | "passed" | "failed" | "cancelled" | "error"
exitCodeinteger | null
errorstring | null
probeboolean
artifactsobject[]
screenshotsstring[]
startedBystring | null
createdAtstring
finishedAtstring | null

RemoteRunList

Fields

NameTypeDescription
runsRemoteRun[]

RemoteRunLog

Fields

NameTypeDescription
runRemoteRun
linesstring[]
totalinteger

RemoteRunner

Fields

NameTypeDescription
idstring
namestring
kind"official" | "official-pro" | "org" | "personal"
onlineboolean
state"confirmed" | "reported" | "not-accepting" | "missing"
missingstring[]
confirmedAtstring | null
platformstring
outdatedboolean

RemovePathsBody

Fields

NameTypeDescription
pathsstring[]

RenameAgentAccountBody

Fields

NameTypeDescription
labelstring

ReplyBody

Fields

NameTypeDescription
bodyoptionalstring
attachmentsoptionalCommentAttachment[]

Repo

Fields

NameTypeDescription
idstring
slugstring
fullNamestring
descriptionstring | null
privateboolean
defaultBranchstring
createdAtstring

RepoBranch

Fields

NameTypeDescription
namestring
commitstring
datestring
subjectstring

RepoBranches

Fields

NameTypeDescription
branchesstring[]
currentstring
detailsoptionalRepoBranch[]

RepoIssue

Fields

NameTypeDescription
numberinteger
titlestring
urlstring
authorstring | null
labelsobject[]
updatedAtstring

RepoIssues

Fields

NameTypeDescription
issuesRepoIssue[]
unavailableoptionalboolean

RepoPull

Fields

NameTypeDescription
numberinteger
titlestring
urlstring
branchstring
basestring
authorstring | null
draftboolean
forkboolean
mergeable"mergeable" | "conflicting" | "unknown"
checks"success" | "failure" | "pending" | null
updatedAtstring

RepoPulls

Fields

NameTypeDescription
pullsRepoPull[]

ResetVaultBody

Fields

NameTypeDescription
runnerIdoptionalstring

ResolveConflictBody

object | object

ResolveConflictResult

Fields

NameTypeDescription
conflictFileConflict
keptAsstring | null
shastring | null

ResolvedApp

Fields

NameTypeDescription
repostring
repoIdstring
namestring
sourceAppConfigLayer
specobject
overridesAppConfigLayer & string | null
missingstring[]
noWorktreeboolean
envIssuesinteger
instanceAppInstance
hostRenameoptionalobject | null

RestartRunnerBody

Fields

NameTypeDescription
forceoptionalboolean

RestoreCriterionBody

Fields

NameTypeDescription
textstring

RetryFailedBody

Fields

NameTypeDescription
workspaceIdoptionalstring

RetryFailedResult

Fields

NameTypeDescription
chatsinteger
projectsinteger

RevertHunkBody

Fields

NameTypeDescription
pathstring
hunkstring

ReviewChange

Fields

NameTypeDescription
idstring
groupReviewGroup
kindstring
pathsstring[]
symbolobject | null
additionsinteger
deletionsinteger
contentHashstring
reachReviewReach
readAsstring
proofReviewProof
meaningReviewMeaning
riskobject
summarystring
hunksReviewHunk[]

ReviewChecklist

Fields

NameTypeDescription
markdownstring

ReviewDigest

Fields

NameTypeDescription
baseShastring
headShastring
truncatedboolean
statsReviewStats
changesReviewChange[]
setupReviewSetupItem[]

ReviewExplanations

Fields

NameTypeDescription
whatChangedobject[]
perChangeobject

ReviewGroup

"readFirst" | "moved" | "sameEdit" | "newCode" | "setup" | "tests" | "folded"

ReviewHunk

Fields

NameTypeDescription
pathstring
headerstring
linesReviewHunkLine[]
omittedinteger

ReviewHunkLine

Fields

NameTypeDescription
kind"context" | "add" | "del" | "rename" | "collapsed"
textstring
oldLineinteger | null
newLineinteger | null

ReviewMeaning

object | object | object | object | object | null

ReviewProof

Fields

NameTypeDescription
rulestring
holdsboolean
detailstring

ReviewReach

Fields

NameTypeDescription
callersinteger
testCallersinteger
throughstring | null
measured"syntax" | "text"
notestring

ReviewReadBody

Fields

NameTypeDescription
contentHashstring

ReviewRepo

Fields

NameTypeDescription
slugstring
namestring
basestring
prNumberinteger | null
prUrlstring | null

ReviewSetupItem

Fields

NameTypeDescription
typeReviewSetupType
titlestring
detailstring
pathsstring[]
snippetstring | null

ReviewSetupType

"migration" | "envNew" | "envRemoved" | "cron" | "routes" | "compose" | "versions" | "inputs" | "removed" | "guide"

ReviewState

Fields

NameTypeDescription
repostring
reposReviewRepo[]
statusReviewStatus
digestReviewDigest
explanationsReviewExplanations
explainingboolean
readsobject
errorstring | null
computedAtstring | null

ReviewStats

Fields

NameTypeDescription
linesChangedinteger
linesToReadinteger
setupStepsinteger
foldedLinesinteger
movedOrRepeatedinteger
filesinteger
parsersstring[]
unparsedobject[]

ReviewStatus

"pending" | "ready" | "failed"

RotateApiKeyBody

Fields

NameTypeDescription
graceHoursoptionalinteger

RotatedRunnerToken

Fields

NameTypeDescription
runnerRunner
tokenstring
commandstring
installCommandstring
installCommandWindowsstring
composeobject
deliveredboolean
fromEnvboolean

RunActionBody

Fields

NameTypeDescription
inputsoptionalobject
versionIdoptionalstring
fromStepoptionalstring
fromRunIdoptionalstring
skipoptionalstring[]
previewoptionalboolean

RunFlowBody

Fields

NameTypeDescription
environmentIdoptionalstring | null

Runner

Fields

NameTypeDescription
idstring
namestring
kind"official" | "official-pro" | "org" | "personal"
onlineboolean
capabilitiesobject | null
versionstring | null
lastSeenAtstring | null
workspaceCountinteger
createdAtstring
setupPendingboolean
deviceRunnerDevice
directRunnerDirect
ownerobject | null
mineboolean
othersCanEditboolean
agentConcurrencyinteger | null
loadRunnerLoadSettings
updatePendingboolean
acceptsRemoteRunsboolean
hostingobject
tokenobject | null
promotionobject | null

RunnerBusy

Fields

NameTypeDescription
workRunnerBusyItem[]
hiddeninteger
listedboolean
whenIdleboolean
versionstring | null

RunnerBusyItem

Fields

NameTypeDescription
kind"turn" | "cli" | "background" | "screenshot" | "export"
workspaceobject | null
projectobject | null
chatIdstring | null
sincestring

RunnerDevice

Fields

NameTypeDescription
state"pinned" | "unpinned" | "pending"
hostnamestring | null
osstring | null
pinnedAtstring | null
changeRunnerDeviceChange

RunnerDeviceChange

Fields

NameTypeDescription
idstring
hostnamestring
osstring
archstring
ipstring | null
firstSeenAtstring
lastSeenAtstring
waitingboolean

RunnerDirect

Fields

NameTypeDescription
urlstring
status"unverified" | "ok" | "unreachable"
checkedAtstring | null
errorstring | null

RunnerHosting

Fields

NameTypeDescription
enabledboolean
supportedboolean | null
domainHostingDomainStatus
domainsHostingDomainStatus[]
tls"off" | "manual" | "http01" | "dns01"
maxAppsinteger | null
maxAppsPerOrginteger | null
listenstring | null
publicSubdomainsboolean
publicMode"proxy" | "tunnel"
publicOriginstring | null
publicOriginStatus"unverified" | "ok" | "unreachable" | null
publicOriginErrorstring | null
acceptsWorkspacesboolean
edgeboolean
edgeDomainstring | null
stateHostingState

RunnerHostingBody

Fields

NameTypeDescription
enabledboolean
domainoptionalstring | null
tlsoptional"off" | "manual" | "http01" | "dns01"
maxAppsoptionalinteger | null
maxAppsPerOrgoptionalinteger | null
listenoptionalstring | null
publicSubdomainsoptionalboolean
publicModeoptional"proxy" | "tunnel"
publicOriginoptionalstring | null
acceptsWorkspacesoptionalboolean

RunnerHostingDoctorApplyBody

Fields

NameTypeDescription
proposalIdstring

RunnerHostingDomainBody

Fields

NameTypeDescription
domainstring

RunnerLoadPatch

Fields

NameTypeDescription
cpuThresholdoptionalinteger
memoryThresholdoptionalinteger
hysteresisoptionalinteger
maxQueueWaitMinutesoptionalinteger | null
autoPauseIdleBoxesoptionalboolean
busyIdleMinutesoptionalinteger

RunnerLoadSettings

Fields

NameTypeDescription
cpuThresholdinteger
memoryThresholdinteger
hysteresisinteger
maxQueueWaitMinutesinteger | null
autoPauseIdleBoxesboolean
busyIdleMinutesinteger

RunnerPromotion

Fields

NameTypeDescription
idstring
runnerobject
fromobject
requestedByobject
tier"standard" | "pro"
hostingRunnerPromotionHosting
releaseDomainsstring[]
notestring | null
createdAtstring
previewRunnerPromotionPreview

RunnerPromotionHosting

"keep" | "off" | "edge"

RunnerPromotionPreview

Fields

NameTypeDescription
orgsobject[]
workspacesinteger
runningAppsinteger
domainsobject[]
publishedPortsinteger
edgeLabelsinteger
nameTakenboolean
edgeTakenboolean

RunnerProxyConfig

Fields

NameTypeDescription
flavor"traefik" | "nginx" | "caddy"
textstring
pathstring | null
upstreamstring | null
domainsstring[]
bridgeUpstreamstring | null
needsDns01boolean
errorstring | null

RunnerQueue

Fields

NameTypeDescription
hostobject | null
hostedAppsinteger
countsobject
entriesRunnerQueueEntry[]

RunnerQueueEntry

Fields

NameTypeDescription
chatIdstring | null
workspaceobject
containerobject | null
ownerobject | null
state"running" | "queued" | "held" | "failed"
reason"concurrency" | "load" | "usage" | null
positioninteger | null
mode"chat" | "spec-draft" | "implement" | null
errorstring | null
sincestring | null

RunnerReleases

Fields

NameTypeDescription
latestobject | null
installScriptobject
composeFilestring
composeVersioninteger
desktopoptionalobject | null

RunnerRestartResult

Fields

NameTypeDescription
restart"service" | "container" | "self"

RunnerRouteCheck

Fields

NameTypeDescription
okboolean
causestring
hoststring | null
messagestring
fixstring | null

RunnerUpdatePending

Fields

NameTypeDescription
pendingtrue

RunnerUpdateResult

RunnerUpdateStarted | RunnerUpdatePending

RunnerUpdateStarted

Fields

NameTypeDescription
fromstring
tostring
restart"service" | "container" | "self"

RunStatsBody

Fields

NameTypeDescription
sheetIdoptionalstring | null

RunTrigger

"schedule" | "manual" | "webhook" | "agent"

SaveFeedbackFormBody

Fields

NameTypeDescription
titleoptionalstring
slugoptionalstring
descriptionoptionalstring | null
publishedoptionalboolean
emailoptionalFeedbackEmailField

SaveHistoryBody

Fields

NameTypeDescription
messageoptionalstring
containeroptionalstring

Screenshot

Fields

NameTypeDescription
pathstring
widthinteger
heightinteger
warningsstring[]
blockIdstring | null

ScreenshotBody

Fields

NameTypeDescription
containeroptionalstring
mode"url" | "screen"
urloptionalstring
widthoptionalinteger
heightoptionalinteger
fullPageoptionalboolean
addToCanvasoptionalboolean

SealedEnvelope

string

SealedSecret

Fields

NameTypeDescription
idstring
sealedSealedEnvelope

SealedSecretCopy

Fields

NameTypeDescription
vaultIdstring
idstring
sealedSealedEnvelope

SecondOpinionFollowUpBody

Fields

NameTypeDescription
textstring

SecondOpinionResult

Fields

NameTypeDescription
chatChat

SendChatBody

Fields

NameTypeDescription
textstring
contextBlockIdsoptionalstring[]
sheetIdoptionalstring | null
blocksoptionalBlockRef[]
attachmentsoptionalstring[]
placeoptional"quick-start"
monitorIdsoptionalstring[]
statIdsoptionalstring[]
allStatsoptionalboolean
reviewChangesoptionalobject[]
draftMonitorsoptionalobject
locationoptionalChatPlace
docIdoptionalstring
contextDocsoptionalChatContextDoc[]
contextCanvasesoptionalChatContextCanvas[]
contextLinksoptionalChatContextLink[]
contextoptionalContextEntity[]
contextPathsoptionalContextPath[]
prototypePrefsoptionalPrototypePrefs
addedoptionalChatAdded
commentThreadsoptionalstring[]
provideroptional"claude" | "codex" | "cursor" | "grok" | "fake"
modeloptionalstring
effortoptionalstring
accountIdoptionalstring
agentIdoptionalstring
ruleIdoptionalstring

SendSecondOpinionBody

Fields

NameTypeDescription
noteoptionalstring

SetPatBody

Fields

NameTypeDescription
tokenstring

SetQuickStartBody

Fields

NameTypeDescription
hiddenboolean

SetRepoBranchBody

Fields

NameTypeDescription
branchstring

SetRepoReadOnlyBody

Fields

NameTypeDescription
readOnlyboolean

SetRunnerDirectBody

Fields

NameTypeDescription
urlstring

SetShareRoleBody

Fields

NameTypeDescription
role"editor" | "viewer" | null

SetupFailureDetail

Fields

NameTypeDescription
stepoptionalstring
repooptionalstring
argsoptionalstring[]
cwdoptionalstring
codeoptionalinteger | null
timedOutoptionalboolean
durationMsoptionalnumber
outputoptionalstring
gitoptionalstring | null
gitLfsoptionalstring
pathoptionalstring
homeoptionalstring

SetUpVaultBody

Fields

NameTypeDescription
runnerIdoptionalstring

SetWorkspaceLogoBody

object | object

Share

Fields

NameTypeDescription
orgNamestring
orgAccess"edit" | "view" | "none"
membersShareMember[]

SharedDocs

Fields

NameTypeDescription
docIdsstring[]

ShareInviteBody

Fields

NameTypeDescription
emailstring
roleoptional"editor" | "viewer"

ShareInviteResult

Fields

NameTypeDescription
outcome"granted" | "invited"
urlstring | null

ShareMember

Fields

NameTypeDescription
userIdstring
namestring
emailstring
orgRole"owner" | "admin" | "member" | "viewer"
role"owner" | "editor" | "viewer" | null
explicitboolean

Sheet

Fields

NameTypeDescription
idstring | null
namestring
docIdstring
role"owner" | "editor" | "viewer"
canManageboolean
createdByobject | null
kind"tab" | "investigation" | "canvas"
investigationSheetInvestigation

SheetInvestigation

Fields

NameTypeDescription
questionstring
chatIdstring | null
state"running" | "finished" | "failed"
finishedAtstring | null
errorstring | null
blocksPostedinteger | null
docIdstring | null
answerstring | null

SheetList

Fields

NameTypeDescription
sheetsSheet[]

SignInBody

Fields

NameTypeDescription
emailstring
passwordstring

SignUpBody

Fields

NameTypeDescription
emailstring
passwordstring
namestring

SkipCriterionBody

Fields

NameTypeDescription
textstring
reasonoptionalstring

StartAgentLoginBody

Fields

NameTypeDescription
runnerIdoptionalstring
workspaceIdoptionalstring

StartContainerBody

Fields

NameTypeDescription
provideroptional"claude" | "codex" | "cursor" | "grok" | "fake"
modeloptionalstring
effortoptionalstring
accountIdoptionalstring
agentIdoptionalstring
ruleIdoptionalstring
focusoptional"open-criteria"

StartRemoteRunBody

Fields

NameTypeDescription
commandoptionalstring
probeoptionalboolean
runnerIdoptionalstring
timeoutMinutesoptionalinteger

StartStepsBody

Fields

NameTypeDescription
messageIdstring
stepsoptionalobject[]

StartStepsResult

Fields

NameTypeDescription
stepsChatStepRun[]

StartThreadBody

Fields

NameTypeDescription
containeroptionalstring
anchorobject | object | object
bodyoptionalstring
attachmentsoptionalCommentAttachment[]

StatAsked

Fields

NameTypeDescription
cardInsightCard
chatIdstring
blockIdstring

StatList

Fields

NameTypeDescription
statsInsightCard[]

StatRefresh

60 | 1440 | null

StatusComponent

Fields

NameTypeDescription
idstring
pageIdstring
namestring
descriptionstring | null
positioninteger
flowIdsstring[]
cronIdsstring[]
stateComponentState
createdAtstring

StatusPage

Fields

NameTypeDescription
idstring
workspaceIdstring
slugstring
titlestring
descriptionstring | null
publishedboolean
subscriptionsEnabledboolean
autoIncidentModeAutoIncidentMode
publicUrlstring
componentsStatusComponent[]
subscribersinteger
openIncidentsinteger
createdAtstring
updatedAtstring

StatusPageList

Fields

NameTypeDescription
pagesStatusPage[]

StatusSubscribeBody

Fields

NameTypeDescription
emailstring

StatusSubscriber

Fields

NameTypeDescription
idstring
emailstring
confirmedboolean
confirmedAtstring | null
createdAtstring

StatusSubscriberList

Fields

NameTypeDescription
subscribersStatusSubscriber[]

StatusSubscriptionAnswer

Fields

NameTypeDescription
oktrue
pageobject
messagestring

StatusSummary

Fields

NameTypeDescription
pageobject
statusComponentState
descriptionstring
updatedAtstring
componentsobject[]
activeIncidentsobject[]
nextMaintenanceobject | null

StepResult

Fields

NameTypeDescription
indexinteger
stepIdstring | null
namestring | null
methodstring
urlstring
statusStepStatus
statusCodeinteger | null
responseTimeMsinteger | null
responseBodystring | null
responseHeadersobject | null
responseContentTypestring | null
assertionResultsAssertionResult[]
logOutputstring[]
errorstring | null
attemptsoptionalinteger
skipReasonoptional"condition" | "previous_failure" | null
isCleanupoptionalboolean
failureSourceoptional"target" | "runner" | null

StepStatus

"passed" | "failed" | "timeout" | "error" | "skipped"

StorageBucket

Fields

NameTypeDescription
idstring
scope"instance" | "org"
namestring
provider"r2" | "s3" | "gcs" | "s3c"
isDefaultboolean
acceptsNewboolean
source"env" | "legacy" | "added"
endpointstring | null
regionstring | null
bucketstring | null
accessKeyIdstring | null
hasSecretboolean
workspacesinteger | null

StorageTestResult

Fields

NameTypeDescription
okboolean
stepstring | null
detailstring | null

SttStatus

Fields

NameTypeDescription
availableboolean
source"account" | "org" | null

SubmitFeedbackBody

Fields

NameTypeDescription
kindoptionalFeedbackKind
titleoptionalstring
bodyoptionalstring
nameoptionalstring
emailoptionalstring
pageoptionalstring

SubmitRunnerPromotionBody

Fields

NameTypeDescription
tieroptional"standard" | "pro"
hostingoptionalRunnerPromotionHosting
releaseDomainsoptionalstring[]
noteoptionalstring | null

SubProjects

Fields

NameTypeDescription
containersContainer[]

SyncBackResult

Fields

NameTypeDescription
copiedinteger
mergedinteger
conflictsFileConflict[]

TakeBackFeedbackBody

Fields

NameTypeDescription
tokenstring

Terminal

Fields

NameTypeDescription
idstring
containerstring | null
titlestring
agentoptionalobject

TestBaseline

Fields

NameTypeDescription
idstring
repostring
branchstring
shastring
status"running" | "ready" | "failed"
failuresTestFailure[]
perCommandTestCommandResult[]
errorstring | null
startedAtstring
finishedAtstring | null
staleboolean

TestBaselineView

Fields

NameTypeDescription
baselineTestBaseline
configuredboolean
progressTestRun[]

TestCommand

Fields

NameTypeDescription
namestring
runstring
formatTestFormat
timeoutMinoptionalinteger

TestCommandResult

Fields

NameTypeDescription
namestring
exitinteger | null
okboolean
countinteger
oomKilledboolean
whystring | null

TestConfig

Fields

NameTypeDescription
setupoptionalstring | null
commandsTestCommand[]
repostring
updatedAtstring

TestConfigBody

Fields

NameTypeDescription
setupoptionalstring | null
commandsTestCommand[]

TestFailure

Fields

NameTypeDescription
kind"test" | "type"
filestring
namestring
commandoptionalstring

TestFormat

"bun-test" | "playwright" | "tsc" | "junit"

TestRun

Fields

NameTypeDescription
idstring
commandstring
labelstring
repostring | null
diroptionalstring
origin"agent" | "compare" | "baseline" | "base"
processIdstring | null
turnIdoptionalstring
chatIdoptionalstring
source"output" | "file" | "activity"
tool"playwright" | "bun-test" | "vitest" | "jest" | "pytest" | "go-test" | "cypress" | "tap" | null
unit"tests" | "files" | "packages"
passedinteger
failedinteger
skippedinteger
totalinteger | null
totalKind"exact" | "estimate" | null
currentstring | null
failuresTestRunFailure[]
lastLinestring | null
startedAtstring
lastReportAtstring | null
stateTestRunState
endedAtstring | null
exitCodeinteger | null
causeoptionalstring | null
baseoptionalTestRunBase

TestRunBase

Fields

NameTypeDescription
branchstring
shastring
state"checking" | "checked" | "no_result"
alsoOnBaseTestRunFailure[]
newTestRunFailure[]
whystring | null
checkedAtstring

TestRunFailure

Fields

NameTypeDescription
filestring
namestring

TestRunState

"running" | "passed" | "failed" | "stopped" | "timed_out" | "oom" | "killed"

TestStepBody

Fields

NameTypeDescription
stepFlowStep
withPreviousoptionalboolean
indexoptionalinteger
environmentIdoptionalstring | null

TotpCodeBody

Fields

NameTypeDescription
codestring

TotpSetup

Fields

NameTypeDescription
secretstring
otpauthUrlstring

TranscribeBody

Fields

NameTypeDescription
audiostring
mimeTypeoptionalstring
orgoptionalstring

Transcription

Fields

NameTypeDescription
textstring

TransferBody

Fields

NameTypeDescription
fromobject
toobject
diroptionalstring
moveoptionalboolean

TransferResult

Fields

NameTypeDescription
pathstring
filesinteger
mergedoptionalinteger
conflictsoptionalFileConflict[]

TurnOnMonitorsBody

Fields

NameTypeDescription
sheetIdoptionalstring | null
idsoptionalstring[]

TurnOnMonitorsResult

Fields

NameTypeDescription
turnedOnMonitorOutput[]
waitingMonitorOutput[]

TwoFactorChallenge

Fields

NameTypeDescription
twoFactorobject

TwoFactorEmailSendBody

Fields

NameTypeDescription
challengeIdstring

TwoFactorPreferredBody

Fields

NameTypeDescription
method"totp" | "passkey" | "email"

TwoFactorVerifyBody

Fields

NameTypeDescription
challengeIdstring
codestring

UnarchiveBody

Fields

NameTypeDescription
runnerIdoptionalstring

UpdateAttachmentBody

Fields

NameTypeDescription
keptAsoptionalAttachmentKeptAs
pinnedRefoptionalstring | null

UpdateContainerBody

Fields

NameTypeDescription
titleoptionalstring
limitsoptionalContainerLimits
verificationDepthoptional"quick" | "standard" | "thorough" | null
parentIdoptionalstring | null

UpdateCrewRuleBody

Fields

NameTypeDescription
nameoptionalstring
instructionsoptionalstring | null
agentIdsoptionalstring[]
modeoptional"in_order" | "agent_picks"
isDefaultoptionalboolean

UpdateCrewSettingsBody

Fields

NameTypeDescription
crewNoOneLeftoptional"ask" | "wait"
agentsMayMessageoptionalboolean
askBeforeAgentDocEditsoptionalboolean
agentTurnLimitoptionalinteger
delegateMaxChildrenoptionalinteger
delegateMaxDepthoptionalinteger
askBeforeoptionalGoalAlwaysAsk[]
reviewerAgentIdoptionalstring | null

UpdateEmailPreferencesBody

Fields

NameTypeDescription
securityoptionalboolean
commentsoptionalboolean
agent_inputoptionalboolean
agent_resultoptionalboolean
conflictsoptionalboolean
monitorsoptionalboolean

UpdateFollowUpBody

Fields

NameTypeDescription
autoRebaseboolean

UpdateGoalBody

Fields

NameTypeDescription
titleoptionalstring
autonomyoptional"ask" | "autopilot"
alwaysAskoptionalGoalAlwaysAsk[]
reviewCapoptionalinteger
concurrencyoptionalinteger
contextoptionalGoalContextItem[]
boardDocOnoptionalboolean
reposoptionalobject[]

UpdateMemberBody

Fields

NameTypeDescription
role"owner" | "admin" | "member" | "viewer"

UpdateOrgBody

Fields

NameTypeDescription
nameoptionalstring
slugoptionalstring
retentionDaysoptional0 | 3 | 7 | 14 | 30 | 90 | 365
defaultAgentoptionalstring | null
defaultModeloptionalstring | null
defaultEffortoptionalstring | null
allowedEmailDomainsoptionalstring[]
agentFeedbackoptionalboolean
publicReadableNamesoptionalboolean
allowPublicDocLinksoptionalboolean

UpdateOrgStorageBody

Fields

NameTypeDescription
kind"managed" | "r2" | "s3" | "gcs"
endpointoptionalstring
regionoptionalstring
bucketoptionalstring
accessKeyIdoptionalstring
secretAccessKeyoptionalstring
sealedSecretAccessKeyoptionalSealedSecret

UpdatePersonalRunnerBody

Fields

NameTypeDescription
othersCanEditoptionalboolean
agentConcurrencyoptionalinteger | null
loadoptionalRunnerLoadPatch
acceptsRemoteRunsoptionalboolean

UpdatePreferencesBody

Fields

NameTypeDescription
layoutoptionalobject
filesoptionalobject
canvasoptionalobject
contextoptionalobject
pinsoptionalobject
recentoptionalRecentItem[]
previewsoptionalobject

UpdateProfileBody

Fields

NameTypeDescription
namestring

UpdateRunnerBody

Fields

NameTypeDescription
agentConcurrencyoptionalinteger | null
loadoptionalRunnerLoadPatch
acceptsRemoteRunsoptionalboolean

UpdateRunnerNowBody

Fields

NameTypeDescription
forceoptionalboolean
whenIdleoptionalboolean

UpdateSheetBody

Fields

NameTypeDescription
nameoptionalstring
positionoptionalinteger

UpdateStorageBucketBody

Fields

NameTypeDescription
nameoptionalstring
isDefaultoptionalboolean
acceptsNewoptionalboolean
accessKeyIdoptionalstring
secretAccessKeyoptionalstring
sealedSecretAccessKeyoptionalSealedSecret

UpdateWorkspaceAgentBody

Fields

NameTypeDescription
nameoptionalstring
modeloptionalstring | null
effortoptionalstring | null
instructionsoptionalstring | null
enabledoptionalboolean

UpdateWorkspaceBody

Fields

NameTypeDescription
nameoptionalstring
runnerIdoptionalstring
orgAccessoptional"edit" | "view" | "none"
defaultAgentoptionalstring | null
defaultModeloptionalstring | null
defaultEffortoptionalstring | null
useGpuoptionalboolean
useDockeroptionalboolean
useKvmoptionalboolean
deleteWorktreesWhenDoneoptionalboolean
closedProjectRetentionDaysoptionalClosedProjectRetentionDays
autoApproveSpecoptionalboolean
autoPushoptionalboolean
autoOpenProptionalboolean
prProjectContextoptionalboolean
autoResumeoptionalboolean
verificationDepthoptionalVerificationDepth
mergeQueueWaitForChecksoptionalboolean
limitsoptionalWorkspaceLimits
historyRemoteoptionalstring | null

UploadResult

Fields

NameTypeDescription
pathstring
sizenumber

UploadTicket

Fields

NameTypeDescription
idstring
mode"bucket" | "relay"
urlstring
pathstring

User

Fields

NameTypeDescription
idstring
emailstring
namestring
emailVerifiedboolean
isAdminboolean
pendingApprovalboolean
onboardedboolean
twoFactorobject
createdAtstring

UserResponse

Fields

NameTypeDescription
userUser

VaultCandidate

Fields

NameTypeDescription
runnerIdstring
namestring
scope"official" | "org" | "personal"
onlineboolean
hostnamestring | null
fingerprintstring | null

VaultHolder

Fields

NameTypeDescription
runnerIdstring
namestring
scope"official" | "org" | "personal"
onlineboolean
readyboolean
loadedboolean
errorstring | null
fingerprintstring | null
approvedBystring | null
createdAtstring

VaultKey

Fields

NameTypeDescription
idstring
publicKeystring
fingerprintstring
createdAtstring

VerificationDepth

"quick" | "standard" | "thorough"

VerifyBody

Fields

NameTypeDescription
codestring

Workspace

Fields

NameTypeDescription
idstring
orgIdstring
slugstring
namestring
status"provisioning" | "ready" | "error" | "archived"
errorstring | null
runnerWorkspaceRunner
role"owner" | "editor" | "viewer"
orgAccess"edit" | "view" | "none"
defaultAgentstring | null
defaultModelstring | null
defaultEffortstring | null
useGpuboolean
useDockerboolean
useKvmboolean
deleteWorktreesWhenDoneboolean
closedProjectRetentionDaysClosedProjectRetentionDays
autoApproveSpecboolean
autoPushboolean
autoOpenPrboolean
prProjectContextboolean
autoResumeboolean
verificationDepthVerificationDepth
mergeQueueWaitForChecksboolean
limitsWorkspaceLimits
historyRemotestring | null
logostring | null
logoSource"github" | "upload" | "file" | null
logoRefstring | null
blockCountinteger
repoCountinteger
containerCountinteger
agentWorkingboolean
headstring | null
lastSyncedAtstring | null
storageConnectedboolean
quickStartQuickStart
archivedAtstring | null
updatedAtstring
createdAtstring

WorkspaceAgent

Fields

NameTypeDescription
idstring
workspaceIdstring
provider"claude" | "codex" | "cursor" | "grok" | "fake"
namestring
modelstring | null
effortstring | null
instructionsstring | null
enabledboolean
positioninteger

WorkspaceAgentList

Fields

NameTypeDescription
agentsWorkspaceAgent[]

WorkspaceApps

Fields

NameTypeDescription
appsResolvedApp[]
hiddenobject[]
runsOnHostingRunnerChoice & object | null
blockedstring | null
previewsProjectPreview[]

WorkspaceAppsDomain

Fields

NameTypeDescription
domainstring
runnerIdstring
runnerNamestring
reach"direct" | "tunnel"
proxiedBystring | null

WorkspaceAppsRunning

Fields

NameTypeDescription
runninginteger

WorkspaceAppsSettings

Fields

NameTypeDescription
runnerIdstring | null
runnersHostingRunnerChoice[]
hostedOnobject | null
domainstring | null
domainsWorkspaceAppsDomain[]
previewVisibilityAppVisibility

WorkspaceLimits

Fields

NameTypeDescription
cpusnumber | null
memoryMbinteger | null
checkMemoryMboptionalinteger | null
shmMboptionalinteger | null

WorkspaceRepo

Fields

NameTypeDescription
repoRepo
status"cloning" | "ready" | "error"
state"cloning" | "fetching" | "ready" | "error" | "offline"
errorstring | null
progressoptionalobject | null
errorAtstring | null
checkedAtstring | null
headstring | null
branchstring
readOnlyboolean

WorkspaceRunner

Fields

NameTypeDescription
idstring
namestring
kind"official" | "official-pro" | "org" | "personal"
onlineboolean
load"normal" | "high" | "critical" | null
lastSeenAtstring | null
gpuboolean
sandboxedDockerboolean
kvmboolean
personalobject | null

WorkspaceStorage

Fields

NameTypeDescription
bucketStorageBucket & object | null
migrationobject | null
choicesStorageBucket[]

WorkspaceUsage

Fields

NameTypeDescription
supportedboolean
measuredAtstring
boxesobject[]
gpuobject[]
diskobject
limitsWorkspaceLimits

WorkspaceVault

Fields

NameTypeDescription
orgIdstring
vaultVaultKey

WriteFileBody

Fields

NameTypeDescription
contentstring
baseoptionalstring

WriteFileResult

Fields

NameTypeDescription
oktrue
mergedboolean
conflictFileConflict
Was this page useful?
Edit this page