API reference
Yard's HTTP API, generated from its OpenAPI document; authenticating with API keys, scopes, limits and errors.
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:
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 inplan(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
| Name | Type | Description |
|---|---|---|
u | string | |
c | EmailCategory | |
t | string |
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
| Name | Type | Description |
|---|---|---|
ticket | string |
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
| Name | Type | Description |
|---|---|---|
passkeys | Passkey[] |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
orgs | Org[] |
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
| Name | Type | Description |
|---|---|---|
org | string | Organization 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
| Name | Type | Description |
|---|---|---|
org | string | Organization 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
| Name | Type | Description |
|---|---|---|
org | string | Organization 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
| Name | Type | Description |
|---|---|---|
org | string | Organization id or slug |
200 OK
| Name | Type | Description |
|---|---|---|
members | Member[] |
Errors: 400, 401, 403, 404, 409, 429 with an error body
PATCH /v1/orgs/{org}/members/{userId}
Change a member's role
Path parameters
| Name | Type | Description |
|---|---|---|
org | string | Organization id or slug |
userId | string |
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
| Name | Type | Description |
|---|---|---|
org | string | Organization id or slug |
userId | string |
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
| Name | Type | Description |
|---|---|---|
keys | ApiKey[] |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
200 OK
| Name | Type | Description |
|---|---|---|
keys | ApiKey[] |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
deviceToken | string |
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
| Name | Type | Description |
|---|---|---|
code | string |
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
| Name | Type | Description |
|---|---|---|
code | string |
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
| Name | Type | Description |
|---|---|---|
code | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
200 OK
| Name | Type | Description |
|---|---|---|
invites | Invite[] |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
token | string |
200 OK: InvitePreview
Errors: 400, 401, 403, 404, 409, 429 with an error body
POST /v1/invites/{token}/accept
Join the organization
Path parameters
| Name | Type | Description |
|---|---|---|
token | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | Organization 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
| Name | Type | Description |
|---|---|---|
org | string | Organization 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
| Name | Type | Description |
|---|---|---|
org | string | Organization 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
| Name | Type | Description |
|---|---|---|
org | string | Organization 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
| Name | Type | Description |
|---|---|---|
org | string | Organization id or slug |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | Organization id or slug |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | Organization 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
| Name | Type | Description |
|---|---|---|
org | string | Organization 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
| Name | Type | Description |
|---|---|---|
org | string | Organization 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
| Name | Type | Description |
|---|---|---|
org | string |
200 OK
| Name | Type | Description |
|---|---|---|
runners | Runner[] |
Errors: 400, 401, 403, 404, 409, 429 with an error body
POST /v1/orgs/{org}/runners
Register a runner for this organization
Path parameters
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
runners | Runner[] |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
Query parameters
| Name | Type | Description |
|---|---|---|
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
| Name | Type | Description |
|---|---|---|
id | string |
Query parameters
| Name | Type | Description |
|---|---|---|
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string | |
domain | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
domain | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
runner | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
runner | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
200 OK
| Name | Type | Description |
|---|---|---|
buckets | StorageBucket[] |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Request body
| Name | Type | Description |
|---|---|---|
bucketId | string |
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
| Name | Type | Description |
|---|---|---|
provider | IntegrationProvider |
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
| Name | Type | Description |
|---|---|---|
provider | IntegrationProvider |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
provider | IntegrationProvider |
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
| Name | Type | Description |
|---|---|---|
org | string | |
provider | IntegrationProvider |
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
| Name | Type | Description |
|---|---|---|
orgoptional | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
Query parameters
| Name | Type | Description |
|---|---|---|
archivedoptional | "true" | "false" |
200 OK
| Name | Type | Description |
|---|---|---|
workspaces | Workspace[] |
Errors: 400, 401, 403, 404, 409, 429 with an error body
POST /v1/orgs/{org}/workspaces
Create a workspace on a runner
Path parameters
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
slug | string |
200 OK: Workspace
Errors: 400, 401, 403, 404, 409, 429 with an error body
GET /v1/workspaces/{ws}
One workspace
Path parameters
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Request body: SetQuickStartBody
200 OK: Workspace
Errors: 400, 401, 403, 404, 409, 429 with an error body
PUT /v1/workspaces/{ws}/logo
Set the workspace's logo
Path parameters
| Name | Type | Description |
|---|---|---|
ws | string |
Request body: SetWorkspaceLogoBody
200 OK: Workspace
Errors: 400, 401, 403, 404, 409, 429 with an error body
DELETE /v1/workspaces/{ws}/logo
Remove the workspace's logo (its initials show)
Path parameters
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
200 OK: Workspace
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
containeroptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
sha | string |
Request body
| Name | Type | Description |
|---|---|---|
containeroptional | string |
200 OK: HistoryResult
Errors: 400, 401, 403, 404, 409, 429 with an error body
POST /v1/workspaces/{ws}/uploads
Start an upload
Path parameters
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
containeroptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
200 OK
| Name | Type | Description |
|---|---|---|
stopped | integer | |
skipped | integer |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
containeroptional | string | |
sheetoptional | string |
200 OK: SnapshotLink
Errors: 400, 401, 403, 404, 409, 429 with an error body
GET /v1/workspaces/{ws}/terminals
Open terminals
Path parameters
| Name | Type | Description |
|---|---|---|
ws | string |
200 OK
| Name | Type | Description |
|---|---|---|
terminals | Terminal[] |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Request body: DocNameSuggestionsBody
200 OK: DocNameSuggestions
Errors: 400, 401, 403, 404, 409, 429, 502, 503 with an error body
Docs
GET /v1/workspaces/{ws}/doc-edits
Edits agents made or proposed to docs: of one doc, one chat, or one state
Path parameters
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
docoptional | string | |
chatoptional | string | |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
batch | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
change | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
stage | integer |
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
| Name | Type | Description |
|---|---|---|
id | string | |
stage | integer |
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
| Name | Type | Description |
|---|---|---|
id | string | |
stage | integer |
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
| Name | Type | Description |
|---|---|---|
id | string | |
stage | integer |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
project | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
project | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
project | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
Query parameters
| Name | Type | Description |
|---|---|---|
nextoptional | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
nextoptional | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
Query parameters
| Name | Type | Description |
|---|---|---|
qoptional | string |
200 OK
| Name | Type | Description |
|---|---|---|
repos | GithubRepo[] |
Errors: 400, 401, 403, 404, 409, 429 with an error body
GET /v1/orgs/{org}/repos
Repositories connected to the organization
Path parameters
| Name | Type | Description |
|---|---|---|
org | string |
200 OK
| Name | Type | Description |
|---|---|---|
repos | Repo[] |
Errors: 400, 401, 403, 404, 409, 429 with an error body
POST /v1/orgs/{org}/repos
Connect a GitHub repository
Path parameters
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
200 OK
| Name | Type | Description |
|---|---|---|
repos | WorkspaceRepo[] |
Errors: 400, 401, 403, 404, 409, 429 with an error body
POST /v1/workspaces/{ws}/repos
Mount a repository in a workspace
Path parameters
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
url | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string | |
path | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string | |
path | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string | |
q | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string | |
baseoptional | string | |
refoptional | string | A branch of the remote to read instead of the checked-out one (`origin/<ref>`): a repository's pushes to its default branch |
200 OK
| Name | Type | Description |
|---|---|---|
commits | GitCommit[] |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string | |
target | string |
200 OK
| Name | Type | Description |
|---|---|---|
files | GitFileChange[] |
Errors: 400, 401, 403, 404, 409, 429 with an error body
GET /v1/workspaces/{ws}/git/diff
Unified diff
Path parameters
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string | |
target | string | |
pathoptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string | |
ref | string | |
path | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
Request body
| Name | Type | Description |
|---|---|---|
sha | string |
200 OK
| Name | Type | Description |
|---|---|---|
sha | string |
Errors: 400, 401, 403, 404, 409, 429 with an error body
POST /v1/workspaces/{ws}/git/commit
Commit everything, as the caller
Path parameters
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
Request body: CommitBody
200 OK
| Name | Type | Description |
|---|---|---|
sha | string | null |
Errors: 400, 401, 403, 404, 409, 429 with an error body
POST /v1/workspaces/{ws}/git/discard
Discard uncommitted changes
Path parameters
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
200 OK
| Name | Type | Description |
|---|---|---|
branch | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
scope | "workspace" | "container" | "worktree" | "repo" | |
containeroptional | string | |
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
agents | object[] |
Errors: 400, 401, 403, 404, 409, 429 with an error body
GET /v1/agent-accounts
The caller's agent accounts
200 OK
| Name | Type | Description |
|---|---|---|
accounts | AgentAccount[] |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
containeroptional | string | |
canvasoptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
containeroptional | string | |
canvasoptional | string | |
docoptional | "none" | string |
200 OK
| Name | Type | Description |
|---|---|---|
chats | ChatSummary[] |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
containeroptional | string | |
canvasoptional | string | |
docoptional | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
200 OK
| Name | Type | Description |
|---|---|---|
chats | ChatOverview[] |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
sheetoptional | string |
200 OK
| Name | Type | Description |
|---|---|---|
chats | BlockChatState[] |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
200 OK: Chat
Errors: 400, 401, 403, 404, 409, 429 with an error body
GET /v1/chats/{id}/messages
Older messages
Path parameters
| Name | Type | Description |
|---|---|---|
id | string |
Query parameters
| Name | Type | Description |
|---|---|---|
before | integer |
200 OK
| Name | Type | Description |
|---|---|---|
messages | ChatMessage[] | |
hasMore | boolean |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
Request body: SendChatBody
200 OK
| Name | Type | Description |
|---|---|---|
chat | Chat | |
item | ChatQueueItem |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
200 OK
| Name | Type | Description |
|---|---|---|
ended | boolean |
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
| Name | Type | Description |
|---|---|---|
id | string | |
item | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
item | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
item | string |
200 OK
| Name | Type | Description |
|---|---|---|
steered | boolean |
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
| Name | Type | Description |
|---|---|---|
id | string |
200 OK
| Name | Type | Description |
|---|---|---|
removed | integer |
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
| Name | Type | Description |
|---|---|---|
id | string |
200 OK
| Name | Type | Description |
|---|---|---|
stopped | boolean |
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
| Name | Type | Description |
|---|---|---|
id | string | |
subagentId | string |
200 OK
| Name | Type | Description |
|---|---|---|
stopped | boolean |
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
| Name | Type | Description |
|---|---|---|
id | string | |
processId | string |
200 OK
| Name | Type | Description |
|---|---|---|
stopped | boolean |
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
| Name | Type | Description |
|---|---|---|
id | string |
Query parameters
| Name | Type | Description |
|---|---|---|
confirmLoadoptional | "true" | "false" |
200 OK
| Name | Type | Description |
|---|---|---|
started | boolean |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
200 OK
| Name | Type | Description |
|---|---|---|
queue | ChatQueueItem[] |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
200 OK
| Name | Type | Description |
|---|---|---|
chats | integer |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
child | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
child | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
child | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
rule | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
rule | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
closedoptional | "true" | "false" | |
parentIdoptional | string |
200 OK
| Name | Type | Description |
|---|---|---|
containers | Container[] |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
200 OK
| Name | Type | Description |
|---|---|---|
deleted | integer |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
slug | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
200 OK
| Name | Type | Description |
|---|---|---|
logs | object[] |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
Query parameters
| Name | Type | Description |
|---|---|---|
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
| Name | Type | Description |
|---|---|---|
id | string |
Query parameters
| Name | Type | Description |
|---|---|---|
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
runId | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
Request body: ContainerBlocksBody
200 OK
| Name | Type | Description |
|---|---|---|
copied | integer |
Errors: 400, 401, 403, 404, 409, 429 with an error body
DELETE /v1/containers/{id}/links/{block}
Unlink a block from the container
Path parameters
| Name | Type | Description |
|---|---|---|
id | string | |
block | string |
200 OK: Ok
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
linkId | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
attachmentId | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
attachmentId | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
attachmentId | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
Request body: ContainerBlocksBody
200 OK
| Name | Type | Description |
|---|---|---|
copied | integer |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
containerId | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
containerId | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string | |
name | string | |
var | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string | |
name | string | |
var | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string | |
var | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string | |
var | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string | |
repo | string | |
name | string | |
var | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string | |
repo | string | |
name | string | |
var | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
repo | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
org | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
messageId | string | |
indexoptional | integer | 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
| Name | Type | Description |
|---|---|---|
id | string | |
messageId | string | |
indexoptional | integer | 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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string | |
name | string |
Query parameters
| Name | Type | Description |
|---|---|---|
sinceoptional | integer | null | |
tailoptional | integer |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
Query parameters
| Name | Type | Description |
|---|---|---|
sinceoptional | integer | null | |
tailoptional | integer |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
200 OK
| Name | Type | Description |
|---|---|---|
tables | DbTable[] |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
Query parameters
| Name | Type | Description |
|---|---|---|
table | string | |
offsetoptional | integer | null | |
limitoptional | integer |
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
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string | |
repo | string | |
name | string |
Query parameters
| Name | Type | Description |
|---|---|---|
sinceoptional | integer | null | |
tailoptional | integer |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
env | string | |
repo | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
Query parameters
| Name | Type | Description |
|---|---|---|
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
changeId | string |
Query parameters
| Name | Type | Description |
|---|---|---|
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
changeId | string |
Query parameters
| Name | Type | Description |
|---|---|---|
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
Query parameters
| Name | Type | Description |
|---|---|---|
repooptional | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
port | integer |
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
| Name | Type | Description |
|---|---|---|
id | string | |
port | integer |
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
| Name | Type | Description |
|---|---|---|
id | string | |
port | integer |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
run | string |
Query parameters
| Name | Type | Description |
|---|---|---|
sinceoptional | integer | 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
| Name | Type | Description |
|---|---|---|
id | string | |
run | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
name | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
Query parameters
| Name | Type | Description |
|---|---|---|
limitoptional | integer | |
beforeoptional | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
token | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
200 OK: CronExecutionList
Errors: 400, 401, 403, 404, 409, 429 with an error body
GET /v1/ping/{token}
A job succeeded
Path parameters
| Name | Type | Description |
|---|---|---|
token | string |
200 OK: CronPingAccepted
Errors: 400, 401, 403, 404, 409, 429 with an error body
POST /v1/ping/{token}
A job succeeded
Path parameters
| Name | Type | Description |
|---|---|---|
token | string |
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
| Name | Type | Description |
|---|---|---|
token | string |
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
| Name | Type | Description |
|---|---|---|
token | string |
200 OK: CronPingAccepted
Errors: 400, 401, 403, 404, 409, 429 with an error body
GET /v1/ping/{token}/fail
A job failed
Path parameters
| Name | Type | Description |
|---|---|---|
token | string |
200 OK: CronPingAccepted
Errors: 400, 401, 403, 404, 409, 429 with an error body
POST /v1/ping/{token}/fail
A job failed
Path parameters
| Name | Type | Description |
|---|---|---|
token | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string | |
messageId | string | |
indexoptional | integer | 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
| Name | Type | Description |
|---|---|---|
id | string | |
messageId | string | |
indexoptional | integer | 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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
Query parameters
| Name | Type | Description |
|---|---|---|
refoptional | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
Query parameters
| Name | Type | Description |
|---|---|---|
path | string | |
refoptional | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
filteroptional | ActionRunFilter | |
actionoptional | string | |
limitoptional | integer |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
Query parameters
| Name | Type | Description |
|---|---|---|
step | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
containeroptional | string | |
chatoptional | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
200 OK: StatusSubscriberList
Errors: 400, 401, 403, 404, 409, 429 with an error body
DELETE /v1/status-subscribers/{id}
Remove a subscriber
Path parameters
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
token | string |
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
| Name | Type | Description |
|---|---|---|
token | string |
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
| Name | Type | Description |
|---|---|---|
token | string |
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
| Name | Type | Description |
|---|---|---|
slug | string |
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
| Name | Type | Description |
|---|---|---|
slug | string |
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
| Name | Type | Description |
|---|---|---|
slug | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
slug | string |
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
| Name | Type | Description |
|---|---|---|
slug | string |
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
| Name | Type | Description |
|---|---|---|
slug | string |
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
| Name | Type | Description |
|---|---|---|
slug | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
sheetoptional | string | |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
Request body: AskStatBody
200 OK
| Name | Type | Description |
|---|---|---|
card | InsightCard | |
chatId | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
Request body: FixStatBody
200 OK
| Name | Type | Description |
|---|---|---|
card | InsightCard | |
chatId | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string | |
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
containeroptional | string |
200 OK
| Name | Type | Description |
|---|---|---|
threads | CommentThread[] |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
200 OK: CommentThread
Errors: 400, 401, 403, 404, 409, 429 with an error body
PATCH /v1/comments/{id}
Change your own comment
Path parameters
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
notifications | Notification[] | |
unread | integer |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
Query parameters
| Name | Type | Description |
|---|---|---|
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
slug | string |
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
| Name | Type | Description |
|---|---|---|
slug | string |
Request body: SubmitFeedbackBody
200 OK
| Name | Type | Description |
|---|---|---|
id | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
ws | string |
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
| Name | Type | Description |
|---|---|---|
error | string | |
code | string | |
planoptional | string |
Schemas
AcceptedInvite
Fields
| Name | Type | Description |
|---|---|---|
org | object | |
workspaceId | string | null |
ActionChatRef
Fields
| Name | Type | Description |
|---|---|---|
chatId | string |
ActionDetail
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
slug | string | |
kind | "action" | "workflow" | |
title | string | |
description | string | |
draft | boolean | |
draftBy | string | null | |
draftBranch | string | null | |
version | ActionVersionRef | |
stepCount | integer | |
agentSteps | integer | |
approvals | integer | |
triggers | ActionTrigger[] | |
inputs | ActionInput[] | |
lastRun | ActionLastRun | |
runCount | integer | |
toolName | string | |
toolEnabled | boolean | |
toolAccess | ActionToolAccess | |
pausedAt | string | null | |
archivedAt | string | null | |
createdAt | string | |
manifest | ActionManifest | |
draftManifest | ActionManifest | |
toolDescription | string | |
toolProjects | string[] | |
chatId | string | null | |
canEdit | boolean |
ActionDiagnosis
Fields
| Name | Type | Description |
|---|---|---|
text | string | |
agent | string | |
at | string | |
versionId | string | null |
ActionFileChange
Fields
| Name | Type | Description |
|---|---|---|
path | string | |
added | integer | |
removed | integer |
ActionFileContent
Fields
| Name | Type | Description |
|---|---|---|
ref | string | |
path | string | |
content | string |
ActionFileEntry
Fields
| Name | Type | Description |
|---|---|---|
path | string | |
size | integer |
ActionFiles
Fields
| Name | Type | Description |
|---|---|---|
ref | string | |
files | ActionFileEntry[] |
ActionFileWrite
Fields
| Name | Type | Description |
|---|---|---|
path | string | |
content | string | null |
ActionFolder
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
path | string | |
holds | string | null | |
keep | object | null | |
usedBy | object[] | |
bytes | integer | null |
ActionGitState
Fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | |
remote | string | null | |
branch | string | |
pushedAt | string | null | |
pushError | string | null |
ActionInbound
"apply" | "apply_after_review" | "ignore"
ActionInput
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
labeloptional | string | |
type | ActionInputType | |
requiredoptional | boolean | |
defaultoptional | string | number | boolean | |
optionsoptional | string[] | |
acceptoptional | string[] | |
descriptionoptional | string |
ActionInputType
"text" | "choice" | "files" | "bool" | "number"
ActionLastRun
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
number | integer | |
status | ActionRunStatus | |
label | string | null | |
at | string | |
waitingLabel | string | null |
ActionList
Fields
| Name | Type | Description |
|---|---|---|
actions | ActionSummary[] | |
git | ActionGitState |
ActionLog
Fields
| Name | Type | Description |
|---|---|---|
stepId | string | |
text | string | |
truncated | boolean |
ActionManifest
Fields
| Name | Type | Description |
|---|---|---|
kindoptional | "action" | "workflow" | |
title | string | |
descriptionoptional | string | |
inputsoptional | ActionInput[] | |
steps | ActionStep[] | |
outputsoptional | string[] | |
triggersoptional | ActionTrigger[] | |
tooloptional | ActionToolSettings | |
reposoptional | ActionRepo[] |
ActionOutputFile
Fields
| Name | Type | Description |
|---|---|---|
path | string | |
bytes | integer |
ActionRepo
Fields
| Name | Type | Description |
|---|---|---|
repo | string | |
refoptional | string |
ActionRunDetail
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
actionId | string | |
actionTitle | string | |
actionSlug | string | |
versionNumber | integer | null | |
number | integer | |
status | ActionRunStatus | |
waitingFor | "approval" | "person" | null | |
waitingLabel | string | null | |
stepIndex | integer | null | |
stepCount | integer | |
preview | boolean | |
triggeredBy | ActionRunTrigger | |
startedBy | string | null | |
startedByName | string | null | |
caller | object | null | |
parentRunId | string | null | |
label | string | null | |
outputs | ActionOutputFile[] | |
error | string | null | |
createdAt | string | |
startedAt | string | null | |
finishedAt | string | null | |
inputs | object | |
steps | ActionStepResult[] | |
diagnosis | ActionDiagnosis | |
repos | object[] | |
runnerId | string | null | |
canApprove | boolean |
ActionRunFilter
"all" | "waiting" | "failed" | "agents" | "mine"
ActionRunList
Fields
| Name | Type | Description |
|---|---|---|
runs | ActionRunSummary[] |
ActionRunStatus
"queued" | "running" | "waiting" | "succeeded" | "failed" | "cancelled"
ActionRunSummary
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
actionId | string | |
actionTitle | string | |
actionSlug | string | |
versionNumber | integer | null | |
number | integer | |
status | ActionRunStatus | |
waitingFor | "approval" | "person" | null | |
waitingLabel | string | null | |
stepIndex | integer | null | |
stepCount | integer | |
preview | boolean | |
triggeredBy | ActionRunTrigger | |
startedBy | string | null | |
startedByName | string | null | |
caller | object | null | |
parentRunId | string | null | |
label | string | null | |
outputs | ActionOutputFile[] | |
error | string | null | |
createdAt | string | |
startedAt | string | null | |
finishedAt | string | null |
ActionRunTrigger
"manual" | "form" | "schedule" | "tag" | "files" | "workflow" | "agent" | "cli"
ActionSecret
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
scope | ActionSecretScope | |
actionIds | string[] | |
stepRef | string | null | |
empty | boolean | |
usedBy | object[] | |
askedBy | object | null | |
setBy | string | null | |
updatedAt | string | |
lastUsedAt | string | null |
ActionSecretList
Fields
| Name | Type | Description |
|---|---|---|
secrets | ActionSecret[] |
ActionSecretScope
"workspace" | "actions" | "step"
ActionSettings
Fields
| Name | Type | Description |
|---|---|---|
gitEnabled | boolean | |
remoteRepo | string | null | |
branch | string | |
inbound | ActionInbound | |
runnerId | string | null | |
maxParallel | integer | |
keepRunsDays | integer | |
agentsMayEdit | boolean | |
notifyUserIds | string[] |
ActionSlug
string
ActionsPulled
Fields
| Name | Type | Description |
|---|---|---|
versions | integer |
ActionStep
Fields
| Name | Type | Description |
|---|---|---|
id | ActionSlug | |
name | string | |
kind | ActionStepKind | |
runoptional | string | |
withoptional | object | |
toolsoptional | string[] | |
readsoptional | string[] | |
writesoptional | string[] | |
secretsoptional | string[] | |
repooptional | string | |
ifoptional | string | |
optionaloptional | boolean | |
optionalInputoptional | string | |
waitoptional | ActionWait | |
approversoptional | string[] | |
promptoptional | string | |
timeoutMsoptional | integer |
ActionStepEvent
Fields
| Name | Type | Description |
|---|---|---|
at | string | |
kind | "info" | "ok" | "wait" | "error" | |
text | string |
ActionStepKind
"script" | "action" | "approval" | "wait" | "agent" | "if" | "notify"
ActionStepResult
Fields
| Name | Type | Description |
|---|---|---|
stepId | string | |
name | string | |
kind | ActionStepKind | |
status | ActionStepStatus | |
startedAt | string | null | |
durationMs | integer | null | |
exitCode | integer | null | |
summary | string | null | |
events | ActionStepEvent[] | |
waitingLabel | string | null | |
approvedBy | string | null | |
childRunId | string | null | |
outputs | ActionOutputFile[] |
ActionStepStatus
"pending" | "running" | "waiting" | "passed" | "failed" | "skipped" | "not_run"
ActionSummary
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
slug | string | |
kind | "action" | "workflow" | |
title | string | |
description | string | |
draft | boolean | |
draftBy | string | null | |
draftBranch | string | null | |
version | ActionVersionRef | |
stepCount | integer | |
agentSteps | integer | |
approvals | integer | |
triggers | ActionTrigger[] | |
inputs | ActionInput[] | |
lastRun | ActionLastRun | |
runCount | integer | |
toolName | string | |
toolEnabled | boolean | |
toolAccess | ActionToolAccess | |
pausedAt | string | null | |
archivedAt | string | null | |
createdAt | string |
ActionToolAccess
"all" | "projects" | "people"
ActionToolbox
Fields
| Name | Type | Description |
|---|---|---|
tools | ActionToolboxItem[] | |
folders | ActionFolder[] |
ActionToolboxItem
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
version | string | null | |
installScript | string | |
source | string | null | |
cachedOn | object[] |
ActionToolInstall
Fields
| Name | Type | Description |
|---|---|---|
ok | boolean | |
log | string |
ActionToolList
Fields
| Name | Type | Description |
|---|---|---|
tools | ActionToolSpec[] |
ActionToolParam
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
type | ActionInputType | |
required | boolean | |
description | string | |
optionsoptional | string[] |
ActionToolSettings
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
descriptionoptional | string |
ActionToolSpec
Fields
| Name | Type | Description |
|---|---|---|
actionId | string | |
name | string | |
title | string | |
description | string | |
params | ActionToolParam[] | |
returns | string[] | |
scriptOnly | boolean | |
approvals | integer |
ActionTrigger
object | object | object | object
ActionVersion
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
actionId | string | |
number | integer | null | |
status | "proposed" | "applied" | "discarded" | |
branch | string | |
commitSha | string | |
summary | string | null | |
filesChanged | ActionFileChange[] | |
byUserName | string | null | |
byAgent | string | null | |
chatId | string | null | |
fromRunId | string | null | |
testRunId | string | null | |
appliedBy | string | null | |
createdAt | string | |
problems | string[] |
ActionVersionDetail
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
actionId | string | |
number | integer | null | |
status | "proposed" | "applied" | "discarded" | |
branch | string | |
commitSha | string | |
summary | string | null | |
filesChanged | ActionFileChange[] | |
byUserName | string | null | |
byAgent | string | null | |
chatId | string | null | |
fromRunId | string | null | |
testRunId | string | null | |
appliedBy | string | null | |
createdAt | string | |
problems | string[] | |
diff | string |
ActionVersionList
Fields
| Name | Type | Description |
|---|---|---|
versions | ActionVersion[] |
ActionVersionRef
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
number | integer | null | |
commitSha | string | |
summary | string | null | |
createdAt | string |
ActionWait
Fields
| Name | Type | Description |
|---|---|---|
matchoptional | string | |
label | string | |
timeoutMsoptional | integer | |
keepoptional | string[] |
AddFeedbackLinkBody
object | object
AddMonitorSourceBody
Fields
| Name | Type | Description |
|---|---|---|
repoId | string | |
path | string |
AgentAccount
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
provider | "claude" | "codex" | "cursor" | "grok" | "fake" | |
label | string | |
status | "pending" | "active" | "expired" | |
auth | "login" | "api_key" | |
isActive | boolean | |
workspaces | object[] | |
email | string | null | |
lastUsedAt | string | null | |
createdAt | string |
AgentLimits
Fields
| Name | Type | Description |
|---|---|---|
provider | "claude" | "codex" | "cursor" | "grok" | "fake" | |
accountId | string | null | |
windows | AgentLimitWindow[] | |
observedAt | string |
AgentLimitWindow
Fields
| Name | Type | Description |
|---|---|---|
kind | string | |
usedPercent | number | null | |
resetsAt | string | null | |
statusoptional | "allowed" | "warning" | "rejected" |
AgentLoginCodeBody
Fields
| Name | Type | Description |
|---|---|---|
code | string |
AgentLoginState
Fields
| Name | Type | Description |
|---|---|---|
accountId | string | |
phase | "none" | "starting" | "awaiting_code" | "awaiting_device" | "verifying" | "authorized" | "error" | "expired" | |
url | string | null | |
userCode | string | null | |
error | string | null | |
runneroptional | object | null | |
runnersoptional | object[] |
AgentLoginTerminal
Fields
| Name | Type | Description |
|---|---|---|
terminalId | string |
AlertChannel
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
kind | AlertChannelKind | |
name | string | |
target | string | null | |
enabled | boolean | |
createdAt | string |
AlertChannelKind
"email" | "webhook" | "slack" | "discord"
AlertChannelList
Fields
| Name | Type | Description |
|---|---|---|
channels | AlertChannel[] |
AlertChannelTestResult
Fields
| Name | Type | Description |
|---|---|---|
ok | boolean | |
error | string | null |
ApiKey
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
kind | "user" | "org" | |
name | string | |
prefix | string | |
scopes | ("read" | "write" | "runners" | "admin")[] | |
role | "admin" | "member" | null | |
createdBy | object | null | |
createdAt | string | |
expiresAt | string | null | |
lastUsedAt | string | null | |
lastUsedIp | string | null | |
previousExpiresAt | string | null |
AppActionBody
Fields
| Name | Type | Description |
|---|---|---|
keepDataoptional | boolean | |
renameHostoptional | boolean |
AppConfig
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
layer | AppConfigLayer | |
repo | string | |
repoId | string | |
name | string | |
spec | object | |
disabled | boolean | |
updatedBy | string | null | |
updatedAt | string |
AppConfigLayer
"org" | "workspace" | "project"
AppConfigList
Fields
| Name | Type | Description |
|---|---|---|
configs | AppConfig[] |
AppEnvEntry
Fields
| Name | Type | Description |
|---|---|---|
repo | string | null | |
app | string | null | |
name | string | |
value | string | null | |
secret | boolean | |
set | boolean |
AppEnvironment
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
slug | string | |
sources | AppEnvironmentSource[] | |
running | integer | |
total | integer | |
createdAt | string |
AppEnvironmentApps
Fields
| Name | Type | Description |
|---|---|---|
apps | ResolvedApp[] | |
hidden | object[] | |
runsOn | HostingRunnerChoice & object | null | |
blocked | string | null | |
environment | AppEnvironment |
AppEnvironmentList
Fields
| Name | Type | Description |
|---|---|---|
environments | AppEnvironment[] | |
max | integer |
AppEnvironmentSource
Fields
| Name | Type | Description |
|---|---|---|
repo | string | |
branch | string | null | |
baseBranch | string | null | |
gone | boolean |
AppEnvList
Fields
| Name | Type | Description |
|---|---|---|
entries | AppEnvEntry[] |
AppEnvVar
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
value | string | null | |
raw | string | null | |
secret | boolean | |
source | object | |
status | "ok" | "needs-value" | "broken-link" | |
detail | string | null |
AppInstance
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
state | "pending" | "fetching" | "building" | "starting" | "running" | "sleeping" | "stopped" | "error" | |
urls | AppUrl[] | |
sourceSha | string | null | |
runnerId | string | |
startedBy | string | null | |
error | string | null | |
updatedAt | string |
AppLogs
Fields
| Name | Type | Description |
|---|---|---|
lines | object[] |
ApplyIncidentDraftBody
Fields
| Name | Type | Description |
|---|---|---|
fields | IncidentDraftField[] |
AppResolvedEnv
Fields
| Name | Type | Description |
|---|---|---|
repo | string | |
app | string | |
vars | AppEnvVar[] | |
issues | integer |
ApproveStatBody
Fields
| Name | Type | Description |
|---|---|---|
sqloptional | string |
AppSecretProposal
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
generateoptional | object | |
whyoptional | string |
AppUrl
Fields
| Name | Type | Description |
|---|---|---|
port | string | |
url | string | |
visibility | "team" | "public" | |
kind | "domain" | "edge" |
AppVisibility
"team" | "public"
ArchiveActionBody
Fields
| Name | Type | Description |
|---|---|---|
archived | boolean |
ArchivedBlock
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
type | string | |
title | string | |
detail | string | null |
AskConflictAgentResult
Fields
| Name | Type | Description |
|---|---|---|
chatId | string |
AskInsightBody
Fields
| Name | Type | Description |
|---|---|---|
question | string |
AskSecondOpinionBody
Fields
| Name | Type | Description |
|---|---|---|
text | string | |
sourceSeqoptional | integer | |
provideroptional | "claude" | "codex" | "cursor" | "grok" | "fake" | |
modeloptional | string | |
effortoptional | string | |
accountIdoptional | string | |
agentIdoptional | string | |
ruleIdoptional | string |
AskStatBody
Fields
| Name | Type | Description |
|---|---|---|
question | string | |
provideroptional | "claude" | "codex" | "cursor" | "grok" | "fake" | |
modeloptional | string | |
effortoptional | string |
Assertion
object | object | object | object | object | object
AssertionResult
Fields
| Name | Type | Description |
|---|---|---|
type | string | |
targetoptional | string | |
expectedoptional | unknown | |
actualoptional | unknown | |
passed | boolean |
AttachContainerFileBody
Fields
| Name | Type | Description |
|---|---|---|
path | string | |
nameoptional | string |
AttachContainerReposBody
Fields
| Name | Type | Description |
|---|---|---|
repos | object[] |
AttachmentKeptAs
"live" | "copy" | "link" | "commit"
AttachmentSince
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
changed | boolean | |
localEdits | boolean | |
originMissing | boolean |
AttachmentsSince
Fields
| Name | Type | Description |
|---|---|---|
since | AttachmentSince[] | |
runnerOnline | boolean |
AttachOriginBody
Fields
| Name | Type | Description |
|---|---|---|
origin | string | |
nameoptional | string | |
keptAsoptional | AttachmentKeptAs | |
pinnedRefoptional | string | |
repooptional | string | |
addedBecauseoptional | string |
AuthProviders
Fields
| Name | Type | Description |
|---|---|---|
github | boolean | |
earlyAccess | boolean |
AutoIncidentMode
"off" | "draft" | "publish"
Billing
Fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | |
paymentsReady | boolean | |
plans | Plan[] | |
enterprise | object | null | |
people | object[] | |
licenses | License[] | |
legacy | object | null | |
caller | object | |
pendingInvites | integer | |
canManage | boolean | |
hasCustomer | boolean |
BillingCheckoutBody
Fields
| Name | Type | Description |
|---|---|---|
intervaloptional | "month" | "year" |
BillingLicenseBody
Fields
| Name | Type | Description |
|---|---|---|
userId | string | |
intervaloptional | "month" | "year" |
BillingRedirect
Fields
| Name | Type | Description |
|---|---|---|
url | string |
BindAccountsBody
Fields
| Name | Type | Description |
|---|---|---|
accounts | object[] |
BlockRef
Fields
| Name | Type | Description |
|---|---|---|
sheetId | string | null | |
blockId | string |
BoundAccount
Fields
| Name | Type | Description |
|---|---|---|
accountId | string | |
provider | "claude" | "codex" | "cursor" | "grok" | "fake" | |
label | string | |
status | "pending" | "active" | "expired" | |
position | integer | |
allowedRules | string[] | null |
BoundAccountList
Fields
| Name | Type | Description |
|---|---|---|
accounts | BoundAccount[] |
BulkFeedbackEntriesBody
Fields
| Name | Type | Description |
|---|---|---|
ids | string[] | |
statusoptional | FeedbackStatus | |
archivedoptional | boolean |
BulkFeedbackEntriesResult
Fields
| Name | Type | Description |
|---|---|---|
entries | FeedbackEntry[] | |
takeBackoptional | string | null |
Capture
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
path | string |
ChangePasswordBody
Fields
| Name | Type | Description |
|---|---|---|
current | string | |
next | string |
Chat
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
containerId | string | null | |
owner | object | null | |
kindoptional | "main" | "child" | "second_opinion" | |
parentChatIdoptional | string | null | |
stepIdoptional | string | null | |
sourceSeqoptional | integer | null | |
forkedFrom | ChatFork | |
blockId | string | null | |
sheetId | string | null | |
blockTitle | string | null | |
docId | string | null | |
scope | ChatScopeKind | |
scopeId | string | null | |
status | "idle" | "running" | "awaiting_input" | "error" | "background" | "terminal" | |
messages | ChatMessage[] | |
hasMore | boolean | |
queue | ChatQueueItem[] | |
live | ChatLive | |
terminalPendingoptional | boolean | |
background | ChatBackgroundProcess[] |
ChatActivity
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
kind | "read" | "edit" | "run" | "search" | "other" | |
label | string | |
detailoptional | string | |
okoptional | boolean | |
done | boolean | |
inputoptional | string | |
outputoptional | string | |
parentoptional | string |
ChatAdded
Fields
| Name | Type | Description |
|---|---|---|
blockIdsoptional | string[] | |
reposoptional | string[] |
ChatAppSaved
Fields
| Name | Type | Description |
|---|---|---|
index | integer | |
layer | "workspace" | "project" | |
containerId | string | null | |
name | string | |
savedBy | string | |
at | string |
ChatBackgroundProcess
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
pid | integer | |
command | string | |
startedAt | string | |
state | "running" | "exited" | "stopped" | |
endedAtoptional | string | |
stoppedByoptional | string | |
portsoptional | integer[] | |
turnId | string |
ChatChildren
Fields
| Name | Type | Description |
|---|---|---|
children | ChatSummary[] |
ChatContextCanvas
Fields
| Name | Type | Description |
|---|---|---|
sheetId | string |
ChatContextDoc
Fields
| Name | Type | Description |
|---|---|---|
docId | string | |
whole | boolean | |
sectionsoptional | string[] |
ChatContextLink
Fields
| Name | Type | Description |
|---|---|---|
kind | "project" | "goal" | "repo" | "doc" | "canvas" | "block" | "prototype" | "chat" | "research" | "monitor" | "file" | |
id | string | |
label | string | |
fromoptional | string |
ChatFiledAction
Fields
| Name | Type | Description |
|---|---|---|
kind | "filed" | |
items | object[] | |
docIdoptional | string |
ChatFinding
Fields
| Name | Type | Description |
|---|---|---|
finding | string | |
byoptional | string | |
verdict | "confirmed" | "rejected" | "unsure" | |
pathoptional | string | |
lineoptional | integer | |
noteoptional | string |
ChatFollowUp
Fields
| Name | Type | Description |
|---|---|---|
containerId | string | |
slug | string | |
title | string | |
href | string |
ChatFork
Fields
| Name | Type | Description |
|---|---|---|
chatId | string | |
owner | object | null | |
seq | integer |
ChatFromChat
Fields
| Name | Type | Description |
|---|---|---|
chatId | string | |
title | string | |
scope | "workspace" | "doc" | "prototype" | "project" | "investigation" | "canvas" | |
agentIdoptional | string | |
agentNameoptional | string | |
replyoptional | boolean |
ChatGitEvent
Fields
| Name | Type | Description |
|---|---|---|
kind | "pushed" | "pr_opened" | "pr_merged" | "pr_closed" | "pr_reopened" | "pr_conflicting" | |
repo | string | |
branch | string | |
baseoptional | string | |
commitsoptional | integer | |
numberoptional | integer | |
urloptional | string | |
by | string | null | |
onGitHub | boolean | |
openCriteriaoptional | string |
ChatLive
Fields
| Name | Type | Description |
|---|---|---|
turnId | string | |
text | string | |
activity | ChatActivity[] | |
subagents | ChatSubagent[] | |
todos | object[] | |
queuedPosition | integer | null | |
queuedReason | "concurrency" | "load" | null | |
load | object | null | |
startedBy | string | |
canSteer | boolean | |
terminaloptional | object |
ChatLoadNotice
Fields
| Name | Type | Description |
|---|---|---|
state | "queued" | "started" | "paused" | "restarted" | "expired" | |
positionoptional | integer | |
cpuPercentoptional | number | null | |
memPercentoptional | number | null |
ChatMemoryNotice
Fields
| Name | Type | Description |
|---|---|---|
command | string | null | |
limitBytes | number | null | |
peakBytes | number | null | |
countoptional | integer |
ChatMessage
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
chatId | string | |
seq | integer | |
role | "user" | "agent" | "system" | |
author | object | null | |
text | string | |
context | object[] | |
attachments | string[] | |
activity | ChatActivity[] | |
subagents | ChatSubagent[] | |
questions | object[] | |
actions | (object | object | object | object | object | object | object | object)[] | |
feedbackSent | string[] | |
specsCreated | object[] | |
appsSavedoptional | ChatAppSaved[] | |
appsSkippedoptional | integer[] | |
monitorsCreatedoptional | ChatMonitorCreated[] | |
monitorsSkippedoptional | integer[] | |
error | object | null | |
cancelled | boolean | |
agent | object | null | |
workspaceAgentIdoptional | string | null | |
ruleIdoptional | string | null | |
effortoptional | string | null | |
fromAgentIdoptional | string | null | |
toAgentIdoptional | string | null | |
stepsoptional | ChatStepRun[] | |
findingsoptional | ChatFinding[] | |
handoffoptional | object | |
secondOpinionoptional | object | |
childChatoptional | object | |
actionVersionoptional | object | |
actionRunoptional | object | |
turnLimitoptional | integer | |
crewFallthroughoptional | object | |
git | ChatGitEvent | |
load | ChatLoadNotice | |
usage | ChatUsageNotice | |
steeredoptional | boolean | |
viaoptional | "terminal" | |
continuedoptional | boolean | |
resumeoptional | boolean | |
memory | ChatMemoryNotice | |
resourcesoptional | ChatResourcesNotice | |
followUpoptional | ChatFollowUp | |
fromProjectoptional | ChatProjectRef | |
fromChatoptional | ChatFromChat | |
sentTooptional | ChatProjectRef | |
turnUsage | ChatTurnUsage | |
filedoptional | ChatFiledAction | |
createdAt | string |
ChatMonitorCreated
Fields
| Name | Type | Description |
|---|---|---|
index | integer | |
monitor | "flow" | "cron" | "environment" | |
id | string | |
createdBy | string | |
at | string |
ChatPlace
Fields
| Name | Type | Description |
|---|---|---|
page | "workspace" | "docs" | "doc" | "prototypes" | "prototype" | "projects" | "project" | "investigate" | "investigation" | "canvas" | "monitors" | "files" | "other" | |
idoptional | string | |
sheetIdoptional | string | null | |
taboptional | string | |
titleoptional | string |
ChatProjectRef
Fields
| Name | Type | Description |
|---|---|---|
containerId | string | |
slug | string | |
title | string | |
href | string | |
relationoptional | "parent" | "sibling" | "sub-project" |
ChatQueueItem
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
chatId | string | |
author | object | |
text | string | |
held | boolean | |
steerable | boolean | |
editable | boolean | |
createdAt | string |
ChatResourcesNotice
Fields
| Name | Type | Description |
|---|---|---|
cpus | number | null | |
memoryMb | number | null | |
shmMb | number |
ChatScopeKind
"workspace" | "doc" | "prototype" | "project" | "investigation" | "canvas"
ChatStepRun
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
title | string | |
task | string | |
ruleoptional | string | |
agentoptional | string | |
afteroptional | string[] | |
state | "proposed" | "waiting" | "running" | "done" | "failed" | "stopped" | "skipped" | |
chatId | string | null | |
erroroptional | string |
ChatSubagent
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
taskIdoptional | string | |
description | string | |
agentTypeoptional | string | |
backgroundoptional | boolean | |
status | "running" | "completed" | "failed" | "stopped" | |
promptoptional | string | |
lastStepoptional | string | |
summaryoptional | string | |
toolUsesoptional | integer | |
durationMsoptional | number | |
startedAt | string | |
endedAtoptional | string | |
textoptional | string | |
canStop | boolean |
ChatSummary
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
containerId | string | null | |
owner | object | null | |
kindoptional | "main" | "child" | "second_opinion" | |
parentChatIdoptional | string | null | |
stepIdoptional | string | null | |
sourceSeqoptional | integer | null | |
forkedFrom | ChatFork | |
blockId | string | null | |
sheetId | string | null | |
blockTitle | string | null | |
docId | string | null | |
scope | ChatScopeKind | |
scopeId | string | null | |
title | string | null | |
status | "idle" | "running" | "awaiting_input" | "error" | "background" | "terminal" | |
messages | integer | |
lastActivityAt | string | |
createdAt | string |
ChatTerminal
Fields
| Name | Type | Description |
|---|---|---|
terminalId | string | null | |
pendingoptional | boolean |
ChatTurnUsage
Fields
| Name | Type | Description |
|---|---|---|
inputTokens | number | |
outputTokens | number | |
cacheReadTokens | number | |
cacheWriteTokens | number | |
costUsd | number | null | |
contextTokensoptional | number | null | |
contextWindowoptional | number | null |
ChatUsage
Fields
| Name | Type | Description |
|---|---|---|
chatId | string | |
totals | object | |
limits | AgentLimits | |
contextoptional | object | null |
ChatUsageNotice
Fields
| Name | Type | Description |
|---|---|---|
resetsAt | string | null | |
held | boolean |
ChooseHeldBody
Fields
| Name | Type | Description |
|---|---|---|
agentId | string |
ChooseRemoteRunnerBody
Fields
| Name | Type | Description |
|---|---|---|
runnerId | string | null |
CitedClaim
Fields
| Name | Type | Description |
|---|---|---|
text | string | |
citations | string[] |
CliLoginPoll
Fields
| Name | Type | Description |
|---|---|---|
status | "pending" | "approved" | "denied" | "expired" | |
keyoptional | string | |
keyIdoptional | string |
CliLoginRequest
Fields
| Name | Type | Description |
|---|---|---|
code | string | |
hostname | string | |
scopes | ("read" | "write" | "runners" | "admin")[] | |
status | "pending" | "approved" | "denied" | "expired" | |
expiresAt | string |
CliLoginStart
Fields
| Name | Type | Description |
|---|---|---|
code | string | |
deviceToken | string | |
verifyUrl | string | |
interval | integer | |
expiresAt | string |
CliLoginStartBody
Fields
| Name | Type | Description |
|---|---|---|
hostname | string | |
scopesoptional | ("read" | "write" | "runners" | "admin")[] |
ClosedProjectRetentionDays
integer | null
Comment
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
author | object | null | |
body | string | |
createdAt | string | |
editedAt | string | null | |
deleted | boolean | |
attachmentsoptional | CommentAttachment[] |
CommentAttachment
object | object | object
CommentThread
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
containerId | string | null | |
anchor | object | object | object | |
resolved | boolean | |
resolvedBy | object | null | |
createdAt | string | |
comments | Comment[] | |
sent | CommentThreadSent |
CommentThreadSent
Fields
| Name | Type | Description |
|---|---|---|
at | string | |
by | object | null | |
agent | string | |
chatId | string | null | |
messageId | string | null |
CommitActionFilesBody
Fields
| Name | Type | Description |
|---|---|---|
branch | string | |
files | ActionFileWrite[] | |
message | string | |
proposeoptional | boolean |
CommitBody
Fields
| Name | Type | Description |
|---|---|---|
message | string |
ComponentState
"operational" | "degraded" | "down" | "maintenance" | "unknown"
ConfirmAppProposalBody
Fields
| Name | Type | Description |
|---|---|---|
layer | "workspace" | "project" | |
projectIdoptional | string | |
name | string | |
spec | object | |
secretsoptional | AppSecretProposal[] |
ConfirmMonitorProposalBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
scheduleoptional | string | null | |
activeoptional | boolean | |
sheetIdoptional | string | null |
ConflictList
Fields
| Name | Type | Description |
|---|---|---|
conflicts | FileConflict[] |
ConflictSide
Fields
| Name | Type | Description |
|---|---|---|
kind | "person" | "agent" | "project" | "disk" | |
name | string | |
userIdoptional | string | |
containeroptional | string | |
containerIdoptional | string |
ConnectIntegrationBody
Fields
| Name | Type | Description |
|---|---|---|
apiKeyoptional | string | |
sealedoptional | SealedSecret | |
sealedCopiesoptional | SealedSecretCopy[] |
ConnectRepoBody
Fields
| Name | Type | Description |
|---|---|---|
fullName | string |
Container
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
slug | string | |
title | string | |
instructions | string | |
flow | "spec" | "direct" | |
status | "creating" | "draft" | "ready" | "done" | |
agentState | "idle" | "running" | "awaiting_input" | "error" | "background" | |
error | string | null | |
errorAuth | boolean | |
errorDetailoptional | SetupFailureDetail | |
activity | ContainerActivity | |
setupoptional | string | null | |
plan | object[] | |
background | ChatBackgroundProcess[] | |
testRuns | TestRun[] | |
progress | ProjectProgress | |
reportAt | string | null | |
criteria | object | |
chatId | string | |
blockId | string | null | |
links | string[] | |
chatLogBlockId | string | null | |
specBlockIdoptional | string | null | |
sourceSheetIdoptional | string | null | |
sourceDocIdoptional | string | null | |
linkedItemsoptional | ProjectLink[] | |
contextoptional | ContextManifestEntry[] | |
closedAt | string | null | |
parentIdoptional | string | null | |
childCountoptional | object | |
unstarted | boolean | |
convertedAt | string | null | |
agent | object | |
repos | ContainerRepo[] | |
limits | ContainerLimits | |
verificationDepth | "quick" | "standard" | "thorough" | null | |
mergeQueue | object | null | |
reviewoptional | ProjectReview | |
additions | integer | |
deletions | integer | |
projectAppsoptional | integer | |
attachmentsoptional | ContainerAttachment[] | |
createdBy | object | null | |
createdAt | string | |
updatedAt | string |
ContainerActivity
Fields
| Name | Type | Description |
|---|---|---|
text | string | |
steps | string[] | |
writingSpec | boolean |
ContainerArchive
Fields
| Name | Type | Description |
|---|---|---|
spec | string | null | |
blocks | ArchivedBlock[] | |
savedAt | string | null |
ContainerAttachment
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
size | integer | |
attachedBy | object | null | |
attachedAt | string | |
path | string | |
keptAs | AttachmentKeptAs | |
pinnedRef | string | null | |
originPath | string | null | |
originVersion | string | null | |
addedBecause | string | null |
ContainerAttachments
Fields
| Name | Type | Description |
|---|---|---|
attachments | ContainerAttachment[] |
ContainerBlocksBody
Fields
| Name | Type | Description |
|---|---|---|
blockIdsoptional | string[] | |
sheetIdoptional | string | null | |
contextoptional | ContextEntity[] | |
contextPathsoptional | ContextPath[] |
ContainerFollowUpEntries
Fields
| Name | Type | Description |
|---|---|---|
entries | ContainerFollowUpEntry[] |
ContainerFollowUpEntry
Fields
| Name | Type | Description |
|---|---|---|
title | string | |
entryId | string |
ContainerLimits
Fields
| Name | Type | Description |
|---|---|---|
cpus | number | null | |
memoryMb | integer | null | |
shmMb | integer | null |
ContainerMergeBody
Fields
| Name | Type | Description |
|---|---|---|
methodoptional | MergeMethod |
ContainerOutputs
Fields
| Name | Type | Description |
|---|---|---|
outputs | MonitorOutput[] | |
target | OutputTarget |
ContainerPrsBody
Fields
| Name | Type | Description |
|---|---|---|
titleoptional | string | |
bodyoptional | string | |
allowOpenCriteriaoptional | boolean |
ContainerRepo
Fields
| Name | Type | Description |
|---|---|---|
linkId | string | |
repoSlug | string | |
deployOrder | integer | null | |
followsId | string | null | |
part | integer | null | |
autoRebase | boolean | |
repoId | string | |
slug | string | |
fullName | string | |
mode | "worktree" | "readonly" | |
branch | string | |
base | string | |
additions | integer | |
deletions | integer | |
commits | integer | |
dirty | integer | |
pushed | boolean | |
unpushed | integer | |
aheadBase | integer | |
behindBase | integer | |
upstreamBehind | integer | |
operation | "merge" | "rebase" | "cherry_pick" | "revert" | null | |
conflicted | string[] | |
worktreeRemoved | boolean | |
checkedOutoptional | boolean | |
pr | object | null |
ContainerRepoOrderBody
Fields
| Name | Type | Description |
|---|---|---|
repos | string[] |
ContainerReport
Fields
| Name | Type | Description |
|---|---|---|
text | string | |
updatedAt | string | |
followUps | ContainerFollowUpEntry[] |
ContextEntity
Fields
| Name | Type | Description |
|---|---|---|
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" | |
id | string | |
labeloptional | string | |
blockTypeoptional | string | |
scopeoptional | object | |
repooptional | object | |
partsoptional | string[] |
ContextManifestEntry
Fields
| Name | Type | Description |
|---|---|---|
key | string | |
kind | string | |
title | string | |
viaoptional | string | |
files | string[] | |
aboutoptional | string |
ContextPath
string
ContinueChatBody
Fields
| Name | Type | Description |
|---|---|---|
textoptional | string | |
provideroptional | "claude" | "codex" | "cursor" | "grok" | "fake" | |
modeloptional | string | |
effortoptional | string | |
accountIdoptional | string | |
agentIdoptional | string | |
ruleIdoptional | string |
ContinueChatResult
Fields
| Name | Type | Description |
|---|---|---|
chat | Chat |
ContinueInvestigationBody
Fields
| Name | Type | Description |
|---|---|---|
as | "work" | "spec" | "prototype" | |
textoptional | string | |
suggestionoptional | string | |
provideroptional | "claude" | "codex" | "cursor" | "grok" | "fake" | |
modeloptional | string | |
effortoptional | string | |
accountIdoptional | string | |
agentIdoptional | string | |
ruleIdoptional | string |
ContinueInvestigationResult
object | object
CreateActionBody
Fields
| Name | Type | Description |
|---|---|---|
title | string | |
slugoptional | ActionSlug | |
kindoptional | "action" | "workflow" | |
filesoptional | ActionFileWrite[] | |
describeoptional | string | |
contextoptional | ContextEntity[] | |
contextPathsoptional | ContextPath[] | |
agentIdoptional | string | |
runnerIdoptional | string |
CreateAgentAccountBody
Fields
| Name | Type | Description |
|---|---|---|
provider | "claude" | "codex" | "cursor" | "grok" | "fake" | |
labeloptional | string | |
apiKeyoptional | string | |
sealedApiKeyoptional | SealedSecretCopy[] |
CreateAlertChannelBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
kindoptional | AlertChannelKind | |
urloptional | string | |
sealedUrloptional | SealedSecret | |
hostoptional | string | |
addressoptional | string |
CreateApiKeyBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
scopes | ("read" | "write" | "runners" | "admin")[] | |
expiresInDaysoptional | integer | |
roleoptional | "admin" | "member" |
CreateAppEnvironmentBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
slugoptional | string | |
sourcesoptional | object[] | |
startoptional | boolean |
CreateChatBody
Fields
| Name | Type | Description |
|---|---|---|
docIdoptional | string | |
sheetIdoptional | string | |
titleoptional | string | |
canvasIdoptional | string |
CreateContainerBody
Fields
| Name | Type | Description |
|---|---|---|
instructionsoptional | string | |
startoptional | boolean | |
flowoptional | "spec" | "direct" | |
titleoptional | string | |
parentIdoptional | string | |
blockIdsoptional | string[] | |
sheetIdoptional | string | null | |
blocksoptional | BlockRef[] | |
docIdoptional | string | |
linkedItemsoptional | ProjectLink[] | |
contextoptional | ContextEntity[] | |
contextPathsoptional | ContextPath[] | |
reposoptional | object[] | |
attachmentsoptional | string[] | |
specBlockIdoptional | string | |
xoptional | number | |
yoptional | number | |
fromChatoptional | object | |
provideroptional | "claude" | "codex" | "cursor" | "grok" | "fake" | |
modeloptional | string | |
effortoptional | string | |
accountIdoptional | string | |
agentIdoptional | string | |
ruleIdoptional | string |
CreateCrewRuleBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
instructionsoptional | string | null | |
agentIds | string[] | |
modeoptional | "in_order" | "agent_picks" | |
isDefaultoptional | boolean |
CreateCronMonitorBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
schedule | string | |
timezoneoptional | string | |
graceSecondsoptional | integer | |
maxRuntimeSecondsoptional | integer | null | |
activeoptional | boolean | |
alertsoptional | object |
CreatedApiKey
Fields
| Name | Type | Description |
|---|---|---|
key | ApiKey | |
secret | string |
CreatedInvite
Fields
| Name | Type | Description |
|---|---|---|
invite | Invite | |
url | string |
CreatedRunner
Fields
| Name | Type | Description |
|---|---|---|
runner | Runner | |
token | string | |
command | string | |
installCommand | string | |
installCommandWindows | string | |
compose | object |
CreateFeedbackEntryBody
Fields
| Name | Type | Description |
|---|---|---|
kindoptional | FeedbackKind | |
titleoptional | string | |
bodyoptional | string | |
nameoptional | string | |
emailoptional | string | |
pageoptional | string |
CreateFlowBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
stepsoptional | FlowStep[] | |
scheduleoptional | string | null | |
timezoneoptional | string | |
activeoptional | boolean | |
environmentIdoptional | string | null | |
alertsoptional | object |
CreateFollowUpBody
Fields
| Name | Type | Description |
|---|---|---|
linkId | string |
CreateGoalBody
Fields
| Name | Type | Description |
|---|---|---|
statement | string | |
titleoptional | string | |
autonomyoptional | "ask" | "autopilot" | |
alwaysAskoptional | GoalAlwaysAsk[] | |
reposoptional | object[] | |
placeBlockoptional | boolean | |
blocksoptional | BlockRef[] | |
contextDocsoptional | ChatContextDoc[] | |
contextCanvasesoptional | ChatContextCanvas[] | |
attachmentsoptional | string[] | |
contextoptional | ContextEntity[] | |
contextPathsoptional | ContextPath[] | |
provideroptional | "claude" | "codex" | "cursor" | "grok" | "fake" | |
modeloptional | string | |
effortoptional | string | |
accountIdoptional | string | |
agentIdoptional | string | |
ruleIdoptional | string |
CreateIncidentBody
Fields
| Name | Type | Description |
|---|---|---|
title | string | |
body | string | |
statusoptional | IncidentStatus | |
impactoptional | IncidentImpact | |
componentIdsoptional | string[] | |
publishedoptional | boolean | |
startedAtoptional | string |
CreateIncidentDraftBody
Fields
| Name | Type | Description |
|---|---|---|
kind | IncidentDraftKind |
CreateIncidentUpdateBody
Fields
| Name | Type | Description |
|---|---|---|
status | IncidentStatus | |
body | string |
CreateInsightBoardBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
sourceId | string | |
refreshMinutesoptional | integer | null |
CreateInsightSourceBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
urloptional | string | |
sealedUrloptional | SealedSecret | |
targetoptional | InsightTarget | |
sslModeoptional | InsightSslMode | |
allowSelfSignedoptional | boolean |
CreateInvestigationBody
Fields
| Name | Type | Description |
|---|---|---|
question | string | |
blocksoptional | BlockRef[] | |
reposoptional | object[] | |
attachmentsoptional | string[] | |
monitorIdsoptional | string[] | |
contextoptional | ContextEntity[] | |
contextPathsoptional | ContextPath[] | |
provideroptional | "claude" | "codex" | "cursor" | "grok" | "fake" | |
modeloptional | string | |
effortoptional | string | |
accountIdoptional | string | |
agentIdoptional | string | |
ruleIdoptional | string |
CreateInviteBody
Fields
| Name | Type | Description |
|---|---|---|
emailoptional | string | |
roleoptional | "admin" | "member" | "viewer" | |
maxUsesoptional | integer |
CreateMaintenanceBody
Fields
| Name | Type | Description |
|---|---|---|
title | string | |
bodyoptional | string | null | |
componentIdsoptional | string[] | |
startsAt | string | |
endsAt | string |
CreateMonitorEnvironmentBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
isDefaultoptional | boolean |
CreateOrgBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
slugoptional | string |
CreateRepoBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
privateoptional | boolean | |
owneroptional | string |
CreateRunnerBody
Fields
| Name | Type | Description |
|---|---|---|
name | string |
CreateSheetBody
Fields
| Name | Type | Description |
|---|---|---|
name | string |
CreateStatBody
Fields
| Name | Type | Description |
|---|---|---|
sheetIdoptional | string | null | |
placeoptional | "insights" | |
blockIdoptional | string | |
sourceId | string | |
question | string | |
vizoptional | InsightViz | |
provideroptional | "claude" | "codex" | "cursor" | "grok" | "fake" | |
modeloptional | string | |
effortoptional | string |
CreateStatusComponentBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
descriptionoptional | string | null | |
positionoptional | integer | |
flowIdsoptional | string[] | |
cronIdsoptional | string[] |
CreateStatusPageBody
Fields
| Name | Type | Description |
|---|---|---|
title | string | |
slugoptional | string | |
descriptionoptional | string | null | |
publishedoptional | boolean | |
subscriptionsEnabledoptional | boolean | |
autoIncidentModeoptional | AutoIncidentMode |
CreateStorageBucketBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
provider | "r2" | "s3" | "gcs" | "s3c" | |
endpointoptional | string | |
regionoptional | string | |
bucket | string | |
accessKeyId | string | |
secretAccessKeyoptional | string | |
sealedSecretAccessKeyoptional | SealedSecret | |
isDefaultoptional | boolean | |
acceptsNewoptional | boolean |
CreateSubProjectsBody
Fields
| Name | Type | Description |
|---|---|---|
items | object[] | |
baseoptional | "parent" | "main" |
CreateTerminalBody
Fields
| Name | Type | Description |
|---|---|---|
containeroptional | string | |
newoptional | boolean |
CreateUploadBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
size | integer | |
contentTypeoptional | string | |
containeroptional | string | |
purposeoptional | "uploads" | "attachments" | |
placeoptional | "uploads" |
CreateWorkspaceAgentBody
Fields
| Name | Type | Description |
|---|---|---|
provider | "claude" | "codex" | "cursor" | "grok" | "fake" | |
name | string | |
modeloptional | string | null | |
effortoptional | string | null | |
instructionsoptional | string | null | |
enabledoptional | boolean |
CreateWorkspaceBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
runnerId | string | |
useGpuoptional | boolean | |
storageBucketIdoptional | string | |
closedProjectRetentionDaysoptional | ClosedProjectRetentionDays |
CrewOverview
Fields
| Name | Type | Description |
|---|---|---|
rules | CrewRule[] | |
settings | CrewSettings |
CrewRule
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
name | string | |
instructions | string | null | |
agentIds | string[] | |
mode | "in_order" | "agent_picks" | |
isDefault | boolean | |
position | integer | |
changedoptional | boolean | |
removedoptional | boolean |
CrewRuleOverrideBody
Fields
| Name | Type | Description |
|---|---|---|
agentIdsoptional | string[] | null | |
modeoptional | "in_order" | "agent_picks" | null | |
instructionsoptional | string | null | |
nameoptional | string | null | |
removedoptional | boolean |
CrewSettings
Fields
| Name | Type | Description |
|---|---|---|
crewNoOneLeft | "ask" | "wait" | |
agentsMayMessage | boolean | |
askBeforeAgentDocEdits | boolean | |
agentTurnLimit | integer | |
delegateMaxChildren | integer | |
delegateMaxDepth | integer | |
askBefore | GoalAlwaysAsk[] | |
reviewerAgentId | string | null |
CronExecution
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
status | CronExecutionStatus | |
startedAt | string | null | |
finishedAt | string | null | |
durationMs | integer | null | |
slow | boolean |
CronExecutionList
Fields
| Name | Type | Description |
|---|---|---|
executions | CronExecution[] |
CronExecutionStatus
"running" | "succeeded" | "failed" | "stuck"
CronMonitor
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
name | string | |
pingToken | string | null | |
pingUrl | string | null | |
schedule | string | |
timezone | string | |
graceSeconds | integer | |
maxRuntimeSeconds | integer | null | |
active | boolean | |
status | CronMonitorStatus | |
alerts | MonitorAlertSettings | |
lastPingAt | string | null | |
lastDurationMs | integer | null | |
nextExpectedAt | string | null | |
recent | CronExecution[] | |
liveAt | string | null | |
containerId | string | null | |
docId | string | null | |
missing | string[] | |
ready | boolean | |
sources | MonitorSource[] | |
changedCount | integer | |
createdAt | string | |
updatedAt | string |
CronMonitorList
Fields
| Name | Type | Description |
|---|---|---|
monitors | CronMonitor[] |
CronMonitorStatus
"new" | "healthy" | "late" | "stuck" | "failed" | "paused"
CronPing
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
kind | CronPingKind | |
durationMs | integer | null | |
payload | string | null | |
sourceIp | string | null | |
receivedAt | string |
CronPingAccepted
Fields
| Name | Type | Description |
|---|---|---|
ok | true |
CronPingKind
"start" | "success" | "fail"
CronPingList
Fields
| Name | Type | Description |
|---|---|---|
pings | CronPing[] |
DbQueryBody
Fields
| Name | Type | Description |
|---|---|---|
sql | string |
DbRows
Fields
| Name | Type | Description |
|---|---|---|
columns | string[] | |
rows | ((string | null)[])[] | |
truncated | boolean |
DirectTicket
Fields
| Name | Type | Description |
|---|---|---|
url | string | |
ticket | string | |
expiresAt | string |
DirectTicketBody
Fields
| Name | Type | Description |
|---|---|---|
purpose | "terminal" | "file" | |
terminalIdoptional | string | |
containeroptional | string |
DiscardBody
Fields
| Name | Type | Description |
|---|---|---|
paths | string[] |
DnsRecord
Fields
| Name | Type | Description |
|---|---|---|
type | "TXT" | "A" | "CNAME" | |
name | string | |
value | string | null | |
purpose | string |
DocEdit
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
docId | string | |
chatId | string | |
chatMessageId | string | null | |
batchId | string | |
position | integer | |
mode | "direct" | "proposed" | |
agent | string | null | |
userId | string | null | |
userName | string | null | |
before | string | |
after | string | |
state | "proposed" | "accepted" | "applied" | "undone" | |
createdAt | string |
DocEditList
Fields
| Name | Type | Description |
|---|---|---|
edits | DocEdit[] |
DocNameSuggestions
Fields
| Name | Type | Description |
|---|---|---|
suggestions | string[] |
DocNameSuggestionsBody
Fields
| Name | Type | Description |
|---|---|---|
text | string |
EdgeOrgUsage
Fields
| Name | Type | Description |
|---|---|---|
month | string | |
bytes | number | |
requests | number | |
limitBytes | number | |
labels | integer | |
labelLimit | integer |
EditCommentBody
Fields
| Name | Type | Description |
|---|---|---|
body | string |
EditQueuedBody
Fields
| Name | Type | Description |
|---|---|---|
text | string |
EmailCategory
"security" | "comments" | "agent_input" | "agent_result" | "conflicts" | "monitors"
EmailFactorDisableBody
Fields
| Name | Type | Description |
|---|---|---|
password | string |
EmailPreferences
Fields
| Name | Type | Description |
|---|---|---|
security | boolean | |
comments | boolean | |
agent_input | boolean | |
agent_result | boolean | |
conflicts | boolean | |
monitors | boolean |
EmailUnsubscribed
Fields
| Name | Type | Description |
|---|---|---|
category | EmailCategory |
EnqueueMergeBody
Fields
| Name | Type | Description |
|---|---|---|
containerIds | string[] | |
methodoptional | MergeMethod | |
closeAfteroptional | boolean | |
forceoptional | boolean |
EnqueueMergeResult
Fields
| Name | Type | Description |
|---|---|---|
queue | MergeQueue | |
skipped | object[] |
FeedbackBody
Fields
| Name | Type | Description |
|---|---|---|
kind | "feature" | "bug" | "other" | |
titleoptional | string | |
bodyoptional | string | |
workspaceIdoptional | string | |
chatIdoptional | string | |
messageIdoptional | string | |
areaoptional | "environment" | |
contextoptional | FeedbackContext |
FeedbackContext
Fields
| Name | Type | Description |
|---|---|---|
areaoptional | "environment" | |
runneroptional | FeedbackRunner | |
byoptional | "agent" | |
pathoptional | string | |
orgIdoptional | string | |
workspaceIdoptional | string | |
containerIdoptional | string | |
appVersionoptional | string | |
viewportoptional | object |
FeedbackEmailField
"off" | "optional" | "required"
FeedbackEntry
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
source | FeedbackSource | |
kind | FeedbackKind | |
title | string | |
body | string | |
name | string | null | |
email | string | null | |
page | string | null | |
status | FeedbackStatus | |
statusBy | object | null | |
statusAt | string | null | |
archivedAt | string | null | |
context | FeedbackContext & object | null | |
made | FeedbackLink[] | |
from | FeedbackFrom | |
createdAt | string |
FeedbackEntryList
Fields
| Name | Type | Description |
|---|---|---|
entries | FeedbackEntry[] | |
inbox | integer | |
archived | integer |
FeedbackForm
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
slug | string | |
title | string | |
description | string | null | |
published | boolean | |
email | FeedbackEmailField | |
publicUrl | string | |
submitUrl | string |
FeedbackFrom
Fields
| Name | Type | Description |
|---|---|---|
id | string | null | |
slug | string | null | |
title | string | |
removed | boolean |
FeedbackKind
"feature" | "bug" | "other"
FeedbackLink
Fields
| Name | Type | Description |
|---|---|---|
kind | "project" | "prototype" | |
id | string | |
title | string | |
slug | string | null | |
sheetId | string | null | |
by | object | null | |
at | string | |
removed | boolean |
FeedbackRunner
Fields
| Name | Type | Description |
|---|---|---|
kind | "official" | "official-pro" | "org" | "personal" | |
version | string | null | |
driver | "docker" | "process" | null | |
os | string | null | |
arch | string | null | |
gpu | boolean | |
useGpu | boolean | |
kvmoptional | boolean | |
useKvmoptional | boolean |
FeedbackSettings
Fields
| Name | Type | Description |
|---|---|---|
form | FeedbackForm | |
yardConnected | boolean |
FeedbackSource
"form" | "api" | "yard" | "project"
FeedbackStatus
"new" | "seen" | "in_progress" | "done"
FileConflict
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
container | string | null | |
path | string | |
title | string | null | |
kind | "text" | "image" | "binary" | |
source | "save" | "sync-back" | "transfer" | "canvas" | |
blockId | string | null | |
ours | ConflictSide | |
theirs | ConflictSide | |
hasBase | boolean | |
status | "open" | "resolved" | |
resolution | "ours" | "theirs" | "both" | "merged" | "superseded" | null | |
resolvedBy | string | null | |
resolvedAt | string | null | |
createdAt | string |
FileConflictDetail
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
container | string | null | |
path | string | |
title | string | null | |
kind | "text" | "image" | "binary" | |
source | "save" | "sync-back" | "transfer" | "canvas" | |
blockId | string | null | |
ours | ConflictSide | |
theirs | ConflictSide | |
hasBase | boolean | |
status | "open" | "resolved" | |
resolution | "ours" | "theirs" | "both" | "merged" | "superseded" | null | |
resolvedBy | string | null | |
resolvedAt | string | null | |
createdAt | string | |
text | object | null | |
proposal | string | null |
FileContent
Fields
| Name | Type | Description |
|---|---|---|
path | string | |
content | string | |
binary | boolean | |
size | number | |
truncated | boolean |
FileList
Fields
| Name | Type | Description |
|---|---|---|
files | string[] | |
truncated | boolean |
FixStatBody
Fields
| Name | Type | Description |
|---|---|---|
provideroptional | "claude" | "codex" | "cursor" | "grok" | "fake" | |
modeloptional | string | |
effortoptional | string |
Flow
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
name | string | |
steps | FlowStep[] | |
schedule | string | null | |
timezone | string | |
active | boolean | |
environmentId | string | null | |
webhookToken | string | null | |
alerts | MonitorAlertSettings | |
health | MonitorHealth | |
nextRunAt | string | null | |
lastRun | FlowRunSummary | |
liveAt | string | null | |
containerId | string | null | |
docId | string | null | |
missing | string[] | |
ready | boolean | |
sources | MonitorSource[] | |
changedCount | integer | |
createdAt | string | |
updatedAt | string |
FlowHookAccepted
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
flowId | string | |
status | "running" |
FlowList
Fields
| Name | Type | Description |
|---|---|---|
flows | FlowListItem[] |
FlowListItem
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
name | string | |
schedule | string | null | |
timezone | string | |
active | boolean | |
environmentId | string | null | |
webhookToken | string | null | |
alerts | MonitorAlertSettings | |
health | MonitorHealth | |
nextRunAt | string | null | |
lastRun | FlowRunSummary | |
liveAt | string | null | |
containerId | string | null | |
docId | string | null | |
missing | string[] | |
ready | boolean | |
sources | MonitorSource[] | |
changedCount | integer | |
createdAt | string | |
updatedAt | string | |
stepCount | integer | |
recent | object[] | |
failingSince | string | null | |
failStreak | integer |
FlowRunDetail
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
flowId | string | |
status | FlowRunStatus | |
triggeredBy | RunTrigger | |
environmentId | string | null | |
runnerId | string | null | |
reason | string | null | |
durationMs | integer | null | |
responseTimeMs | integer | null | |
failedStep | integer | null | |
startedAt | string | |
finishedAt | string | null | |
steps | StepResult[] | |
stepCount | integer |
FlowRunList
Fields
| Name | Type | Description |
|---|---|---|
runs | FlowRunSummary[] | |
nextCursor | string | null |
FlowRunStatus
"running" | "passed" | "failed" | "timeout" | "error" | "inconclusive"
FlowRunSummary
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
flowId | string | |
status | FlowRunStatus | |
triggeredBy | RunTrigger | |
environmentId | string | null | |
runnerId | string | null | |
reason | string | null | |
durationMs | integer | null | |
responseTimeMs | integer | null | |
failedStep | integer | null | |
startedAt | string | |
finishedAt | string | null |
FlowStep
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
method | HttpMethod | |
url | string | |
headersoptional | object | |
bodyTypeoptional | "json" | "text" | "form" | |
bodyoptional | string | null | |
bodyWrappedoptional | boolean | |
sensitiveBodyoptional | boolean | |
assertionsoptional | Assertion[] | |
logsoptional | string[] | |
timeoutMsoptional | integer | |
retriesoptional | integer | |
retryDelayMsoptional | integer | |
runIfoptional | string | null | |
alwaysRunoptional | boolean | |
capturesoptional | Capture[] |
GitAbortResult
Fields
| Name | Type | Description |
|---|---|---|
aborted | "merge" | "rebase" | "cherry_pick" | "revert" |
GitConflicts
Fields
| Name | Type | Description |
|---|---|---|
conflicts | boolean | |
files | string[] | |
base | string |
GitDiff
Fields
| Name | Type | Description |
|---|---|---|
diff | string | |
truncated | boolean |
GitFileAtRef
Fields
| Name | Type | Description |
|---|---|---|
exists | boolean | |
text | string | null | |
size | integer | |
truncated | boolean | |
sha | string | null |
GithubDisconnectPreview
Fields
| Name | Type | Description |
|---|---|---|
repos | GithubDisconnectRepo[] |
GithubDisconnectRepo
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
fullName | string | |
orgSlug | string | |
orgName | string | |
workspaces | object[] | |
blockedBy | string | null |
GithubDisconnectResult
Fields
| Name | Type | Description |
|---|---|---|
ok | true | |
removed | integer | |
kept | string[] |
GithubIdentity
Fields
| Name | Type | Description |
|---|---|---|
connected | boolean | |
login | string | null | |
name | string | null | |
email | string | null | |
kind | "app" | "pat" | null | |
usable | boolean |
GithubInstallation
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
installationId | integer | |
accountLogin | string | |
accountType | string | |
suspended | boolean |
GithubPeek
object | object | object | object | object
GithubSigninBody
Fields
| Name | Type | Description |
|---|---|---|
nextoptional | string |
GithubSignupBody
Fields
| Name | Type | Description |
|---|---|---|
ticket | string | |
email | string | |
password | string | |
name | string |
GithubSignupPending
Fields
| Name | Type | Description |
|---|---|---|
login | string | |
name | string | null | |
email | string | null |
GitPullResult
Fields
| Name | Type | Description |
|---|---|---|
updated | boolean | |
head | string | null |
GitStatus
Fields
| Name | Type | Description |
|---|---|---|
branch | string | null | |
head | string | null | |
dirty | integer | |
ahead | integer | |
behind | integer | |
upstream | string | null | |
additions | integer | |
deletions | integer | |
aheadBase | integer | |
behindBase | integer | |
operation | "merge" | "rebase" | "cherry_pick" | "revert" | null | |
conflicted | string[] | |
base | string | null |
GitUpdateResult
Fields
| Name | Type | Description |
|---|---|---|
result | "merged" | "up_to_date" | "conflict" | |
head | string | null | |
files | string[] | |
base | string | |
renumberedoptional | object[] |
GiveActionToChatBody
Fields
| Name | Type | Description |
|---|---|---|
chatId | string |
Goal
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
slug | string | |
title | string | |
statement | string | |
autonomy | "ask" | "autopilot" | |
alwaysAsk | GoalAlwaysAsk[] | |
state | "running" | "waiting" | "paused" | "done" | "error" | |
pausedAt | string | null | |
pausedBy | object | null | |
pausedReason | "person" | "budget" | null | |
budgetCents | integer | null | |
chatId | string | null | |
docId | string | null | |
repos | object[] | |
health | "on-track" | "at-risk" | "off-track" | null | |
healthText | string | null | |
healthAt | string | null | |
reviewCap | integer | |
concurrency | integer | |
context | GoalContextItem[] | |
boardDocOn | boolean | |
createdBy | object | null | |
createdAt | string | |
updatedAt | string | |
closedAt | string | null | |
changes | GoalChange[] | |
usage | GoalUsage | |
criteria | object | |
projects | object | |
openQuestion | string | null | |
needsYou | boolean | |
appChanges | integer | |
decisions | GoalDecisions | |
waiting | GoalWaiting[] | |
lastCheck | GoalCheck | |
iteration | GoalIteration | null | |
iterations | GoalIteration[] | |
waitingFor | "question" | "apps" | "design" | "merge" | "stage-question" | "paused" | "always-ask" | "review" | "stuck" | "met" | null | |
stalls | integer |
GoalAlwaysAsk
Fields
| Name | Type | Description |
|---|---|---|
kind | "apps" | "secrets" | "delete-data" | "spend" | "merge" | "custom" | |
label | string | |
amountoptional | integer |
GoalAppDiffLine
Fields
| Name | Type | Description |
|---|---|---|
op | "+" | "-" | |
key | string | |
text | string |
GoalAppProposal
Fields
| Name | Type | Description |
|---|---|---|
chatId | string | |
messageId | string | |
index | integer | |
containerId | string | null | |
stage | integer | null | |
repo | string | |
name | string | |
kind | "add" | "change" | |
why | string | null | |
lines | GoalAppDiffLine[] | |
spec | object | |
secrets | string[] |
GoalApps
Fields
| Name | Type | Description |
|---|---|---|
repos | string[] | |
apps | ResolvedApp[] | |
runsOn | object | null | |
proposals | GoalAppProposal[] | |
secretsNeeded | object[] |
GoalBoard
Fields
| Name | Type | Description |
|---|---|---|
goalId | string | |
columns | object | |
reviewCap | integer | |
reviewCount | integer | |
concurrency | integer | |
running | integer |
GoalBudgetBody
Fields
| Name | Type | Description |
|---|---|---|
budgetCents | integer | null |
GoalChange
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
kind | "plan" | "section" | |
summary | string | |
diff | GoalDiffLine[] | |
heading | string | null | |
chatMessageId | string | null | |
createdAt | string | |
undoneAt | string | null |
GoalCheck
Fields
| Name | Type | Description |
|---|---|---|
branch | string | null | |
command | string | |
ok | boolean | |
at | string |
GoalContextItem
Fields
| Name | Type | Description |
|---|---|---|
ref | ContextEntity | |
keptAs | "live" | "copy" | "link" | "commit" |
GoalDecision
Fields
| Name | Type | Description |
|---|---|---|
section | string | |
key | string | |
value | string | |
state | "you" | "recommended" | "assumed" | "open" | "limit" | |
why | string |
GoalDecisions
Fields
| Name | Type | Description |
|---|---|---|
total | integer | |
decided | integer | |
open | integer | |
limits | integer | |
readiness | number | |
confidence | "Low" | "Fair" | "Good" | "High" | |
sections | object[] | |
assumed | GoalDecision[] | |
openRows | GoalDecision[] | |
limitRows | GoalDecision[] |
GoalDiffLine
Fields
| Name | Type | Description |
|---|---|---|
op | "+" | "-" | "~" | |
text | string |
GoalIteration
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
index | integer | |
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" | |
detail | string | null | |
phase | "goal" | "decisions" | "design" | "build" | "met" | |
summary | string | null | |
startedAt | string | |
endedAt | string | null | |
outcome | "progress" | "waiting" | "no-change" | "error" | null | |
running | boolean |
GoalList
Fields
| Name | Type | Description |
|---|---|---|
goals | Goal[] | |
closedDocIds | string[] |
GoalStageFeedbackBody
Fields
| Name | Type | Description |
|---|---|---|
text | string |
GoalStageRun
Fields
| Name | Type | Description |
|---|---|---|
containerId | string | |
slug | string |
GoalUsage
Fields
| Name | Type | Description |
|---|---|---|
agentMs | number | |
costUsd | number | |
turns | integer |
GoalWaiting
Fields
| Name | Type | Description |
|---|---|---|
kind | "question" | "secret" | "apps" | "design" | "stage" | "merge" | |
title | string | |
detail | string | |
appoptional | string | |
nameoptional | string |
GrepResult
Fields
| Name | Type | Description |
|---|---|---|
matches | object[] | |
truncated | boolean |
Health
Fields
| Name | Type | Description |
|---|---|---|
ok | boolean | |
version | string | |
time | string |
History
Fields
| Name | Type | Description |
|---|---|---|
head | string | null | |
dirty | string[] | |
commits | HistoryCommit[] |
HistoryCommit
Fields
| Name | Type | Description |
|---|---|---|
sha | string | |
short | string | |
message | string | |
author | string | |
date | string | |
isHead | boolean |
HistoryResult
Fields
| Name | Type | Description |
|---|---|---|
sha | string | null |
HostedTicket
Fields
| Name | Type | Description |
|---|---|---|
redirect | string | |
ticket | string | |
expiresAt | string |
HostedTicketBody
Fields
| Name | Type | Description |
|---|---|---|
url | string |
HostingDoctorApplyResult
Fields
| Name | Type | Description |
|---|---|---|
applied | string[] | |
report | HostingDoctorReport |
HostingDoctorReport
Fields
| Name | Type | Description |
|---|---|---|
mode | "host-direct" | "container" | "coolify" | "host-proxy" | "standalone" | |
modeSummary | string | |
checks | object[] | |
skipped | object[] | |
proposal | object | null | |
route | object | null |
HostingDomainStatus
Fields
| Name | Type | Description |
|---|---|---|
domain | string | |
status | "pending" | "verified" | "failed" | |
method | "txt" | "admin" | "migrated" | null | |
verifiedAt | string | null | |
lastCheckedAt | string | null | |
lastError | string | null | |
graceUntil | string | null | |
records | DnsRecord[] |
HostingRunnerChoice
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
kind | "org" | "personal" | "official" | |
online | boolean | |
domain | string | null | |
edgeDomain | string | null |
HostingState
Fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | |
docker | boolean | |
dockerReasonoptional | string | null | |
proxy | "off" | "starting" | "up" | "down" | |
ports | string[] | |
certificate | "none" | "manual" | "acme" | "self-signed" | |
originCertificate | string | null | |
fingerprint | string | null | |
tunnel | "off" | "connecting" | "connected" | "error" | |
tunnels | integer | null | |
maxApps | integer | |
lastError | string | null | |
listenoptional | string | null | |
listenFromoptional | "env" | "machine" | "yard" | "default" | "auto" | null | |
listenSuggestionoptional | string | null | |
behindProxyoptional | object | null | |
proxyInfooptional | object | null | |
problemsoptional | object[] | null |
HttpMethod
"GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS"
ImportFlowBody
Fields
| Name | Type | Description |
|---|---|---|
format | "curl" | "postman" | "openapi" | |
source | string | |
nameoptional | string |
ImportFlowResult
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
steps | FlowStep[] | |
warnings | string[] |
Incident
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
pageId | string | |
pageSlug | string | |
pageTitle | string | |
workspaceId | string | |
title | string | |
status | IncidentStatus | |
impact | IncidentImpact | |
componentIds | string[] | |
published | boolean | |
autoCreated | boolean | |
autoMonitorKeys | string[] | |
resolveProposedAt | string | null | |
internalNote | string | null | |
startedAt | string | |
resolvedAt | string | null | |
updates | IncidentUpdate[] | |
hasPostmortem | boolean | |
createdAt | string | |
updatedAt | string |
IncidentDraft
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
incidentId | string | |
evidenceId | string | |
kind | IncidentDraftKind | |
status | IncidentDraftStatus | |
draft | IncidentDraftContent | |
dropped | integer | |
error | string | null | |
agent | string | null | |
model | string | null | |
requestedBy | string | null | |
reviewedBy | string | null | |
reviewedAt | string | null | |
createdAt | string |
IncidentDraftContent
Fields
| Name | Type | Description |
|---|---|---|
observations | CitedClaim[] | |
hypotheses | CitedClaim[] | |
summaryoptional | string | |
impactoptional | string | |
rootCauseoptional | string | |
contributingFactorsoptional | string | |
resolutionoptional | string | |
lessonsoptional | string | |
actionItemsoptional | object[] |
IncidentDraftDetail
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
incidentId | string | |
evidenceId | string | |
kind | IncidentDraftKind | |
status | IncidentDraftStatus | |
draft | IncidentDraftContent | |
dropped | integer | |
error | string | null | |
agent | string | null | |
model | string | null | |
requestedBy | string | null | |
reviewedBy | string | null | |
reviewedAt | string | null | |
createdAt | string | |
evidence | IncidentEvidenceItem[] |
IncidentDraftField
"summary" | "impact" | "rootCause" | "contributingFactors" | "resolution" | "lessons" | "actionItems"
IncidentDraftKind
"brief" | "postmortem"
IncidentDraftList
Fields
| Name | Type | Description |
|---|---|---|
drafts | IncidentDraft[] |
IncidentDraftStatus
"pending" | "ready" | "error" | "reviewed" | "applied"
IncidentEvidenceItem
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
sourceType | string | |
sourceId | string | |
occurredAt | string | |
title | string | |
detailoptional | unknown |
IncidentImpact
"none" | "minor" | "major" | "critical"
IncidentList
Fields
| Name | Type | Description |
|---|---|---|
incidents | Incident[] |
IncidentStatus
"investigating" | "identified" | "monitoring" | "resolved"
IncidentUpdate
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
status | IncidentStatus | |
body | string | |
createdBy | string | null | |
createdAt | string |
InsightAccess
"ai" | "people"
InsightBoard
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
sourceId | string | |
name | string | |
holder | boolean | |
sheetId | string | null | |
refreshMinutes | integer | null | |
lastRefreshedAt | string | null | |
cards | InsightCard[] | |
createdAt | string |
InsightBoardList
Fields
| Name | Type | Description |
|---|---|---|
boards | object[] |
InsightCard
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
boardId | string | |
sourceId | string | |
sheetId | string | null | |
blockId | string | null | |
question | string | |
title | string | |
sql | string | |
viz | InsightViz | |
mapping | InsightMapping | |
status | InsightCardStatus | |
proposal | InsightProposal | |
askedQuestion | string | null | |
error | string | null | |
refreshMinutes | integer | null | |
lastRunAt | string | null | |
position | integer | |
latest | InsightSnapshot | |
trend | number[] | |
columns | InsightResultColumn[] | |
sourceName | string | |
tables | string[] | |
createdAt | string |
InsightCardStatus
"proposed" | "approved"
InsightColumn
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
type | string | |
nullable | boolean | |
visible | boolean | |
access | InsightAccess | |
detected | InsightDetected |
InsightDetected
"personal" | null
InsightMapping
Fields
| Name | Type | Description |
|---|---|---|
xoptional | string | |
yoptional | string[] | |
valueoptional | string | |
labeloptional | string | |
horizontaloptional | boolean |
InsightProposal
Fields
| Name | Type | Description |
|---|---|---|
question | string | |
sql | string | |
title | string | |
viz | InsightViz | |
mapping | InsightMapping | |
at | string |
InsightResult
Fields
| Name | Type | Description |
|---|---|---|
columns | string[] | |
rows | object[] | |
truncated | boolean | |
durationMs | integer |
InsightResultColumn
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
type | string | |
access | InsightAccess | |
detected | InsightDetected | |
own | boolean | |
derived | boolean |
InsightSnapshot
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
result | InsightResult | |
error | string | null | |
takenAt | string |
InsightSource
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
name | string | |
display | string | |
sslMode | InsightSslMode | |
allowSelfSigned | boolean | |
tables | InsightTable[] | |
introspectedAt | string | null | |
stats | integer | |
createdAt | string |
InsightSourceList
Fields
| Name | Type | Description |
|---|---|---|
sources | InsightSource[] |
InsightSslMode
"disable" | "require" | "verify-full"
InsightTable
Fields
| Name | Type | Description |
|---|---|---|
schema | string | |
name | string | |
visible | boolean | |
columns | InsightColumn[] |
InsightTarget
Fields
| Name | Type | Description |
|---|---|---|
host | string | |
port | integer | null | |
database | string |
InsightViz
"stat" | "table" | "line" | "bar"
InstallUrl
Fields
| Name | Type | Description |
|---|---|---|
url | string |
Integration
Fields
| Name | Type | Description |
|---|---|---|
provider | IntegrationProvider | |
connected | boolean | |
hint | string | null | |
connectedAt | string | null | |
unreadable | boolean |
IntegrationList
Fields
| Name | Type | Description |
|---|---|---|
integrations | Integration[] |
IntegrationProvider
"mistral"
Investigation
Fields
| Name | Type | Description |
|---|---|---|
sheetId | string | |
name | string | |
chatId | string | null | |
question | string | |
state | "running" | "finished" | "failed" | |
error | string | null | |
blocksPosted | integer | null | |
createdBy | object | null | |
createdAt | string | |
finishedAt | string | null | |
docId | string | null | |
answer | string | null |
InvestigationList
Fields
| Name | Type | Description |
|---|---|---|
investigations | Investigation[] |
Invite
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
email | string | null | |
role | "owner" | "admin" | "member" | "viewer" | |
workspaceId | string | null | |
workspaceRole | "owner" | "editor" | "viewer" | null | |
maxUses | integer | null | |
uses | integer | |
expiresAt | string | |
createdAt | string | |
invitedBy | string |
InvitePreview
Fields
| Name | Type | Description |
|---|---|---|
orgName | string | |
orgSlug | string | |
role | "owner" | "admin" | "member" | "viewer" | |
email | string | null | |
invitedBy | string | |
workspaceName | string | null |
KillProcessBody
Fields
| Name | Type | Description |
|---|---|---|
containeroptional | string | |
pid | integer |
Library
Fields
| Name | Type | Description |
|---|---|---|
docs | object[] | |
prototypes | object[] |
License
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
userId | string | |
name | string | |
paidBy | "self" | "org" | |
orgName | string | null | |
plan | string | |
interval | "month" | "year" | null | |
status | "active" | "past_due" | "ended" | |
renewsAt | string | null | |
cancelAtPeriodEnd | boolean | |
expiresAt | string | null | |
free | boolean |
LinkPreview
Fields
| Name | Type | Description |
|---|---|---|
url | string | |
title | string | null | |
description | string | null | |
image | string | null | |
site | string | null | |
frameableoptional | boolean |
LinkPreviewBody
Fields
| Name | Type | Description |
|---|---|---|
url | string |
MaintenanceList
Fields
| Name | Type | Description |
|---|---|---|
maintenance | MaintenanceWindow[] |
MaintenanceWindow
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
pageId | string | |
componentIds | string[] | |
title | string | |
body | string | null | |
startsAt | string | |
endsAt | string | |
state | "scheduled" | "in_progress" | "completed" | |
createdAt | string |
Me
Fields
| Name | Type | Description |
|---|---|---|
user | User | |
orgs | OrgSummary[] |
Member
Fields
| Name | Type | Description |
|---|---|---|
userId | string | |
name | string | |
email | string | |
role | "owner" | "admin" | "member" | "viewer" | |
joinedAt | string |
MergeMethod
"merge" | "squash" | "rebase"
MergeOutputsBody
Fields
| Name | Type | Description |
|---|---|---|
idsoptional | string[] | |
sheetIdoptional | string | null |
MergeOutputsResult
Fields
| Name | Type | Description |
|---|---|---|
merged | MonitorOutput[] | |
stayed | MonitorOutput[] | |
target | OutputTarget |
MergePrBody
Fields
| Name | Type | Description |
|---|---|---|
methodoptional | "merge" | "squash" | "rebase" |
MergeQueue
Fields
| Name | Type | Description |
|---|---|---|
items | MergeQueueItem[] | |
waitForChecks | boolean | |
paused | object | null |
MergeQueueItem
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
containerId | string | |
slug | string | |
title | string | |
state | MergeQueueState | |
position | integer | null | |
method | MergeMethod | |
closeAfter | boolean | |
attempts | integer | |
error | string | null | |
queuedBy | object | null | |
createdAt | string | |
updatedAt | string | |
finishedAt | string | null |
MergeQueueState
"queued" | "preparing" | "resolving" | "waiting" | "checks" | "merging" | "merged" | "failed" | "removed"
MigrateDocsResult
Fields
| Name | Type | Description |
|---|---|---|
made | integer |
MonitorAlert
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
monitorKind | "flow" | "cron" | "runner" | |
monitorId | string | |
monitorName | string | |
event | MonitorAlertEvent | |
message | string | |
createdAt | string |
MonitorAlertEvent
"failing" | "recovered" | "late" | "failed" | "stuck" | "slow" | "runner_offline" | "runner_online"
MonitorAlertList
Fields
| Name | Type | Description |
|---|---|---|
alerts | MonitorAlert[] |
MonitorAlertSettings
Fields
| Name | Type | Description |
|---|---|---|
enabledoptional | boolean | |
failThresholdoptional | integer | |
cooldownMinutesoptional | integer | |
notifyRecoveryoptional | boolean |
MonitorEnvironment
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
name | string | |
isDefault | boolean | |
vars | MonitorEnvVar[] | |
liveAt | string | null | |
containerId | string | null | |
docId | string | null | |
missing | string[] | |
ready | boolean | |
sources | MonitorSource[] | |
changedCount | integer | |
createdAt | string | |
updatedAt | string |
MonitorEnvironmentList
Fields
| Name | Type | Description |
|---|---|---|
environments | MonitorEnvironment[] |
MonitorEnvVar
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
secret | boolean | |
value | string | null | |
set | boolean | |
updatedAt | string |
MonitorHealth
"new" | "passing" | "failing" | "paused" | "unknown"
MonitorKind
"flow" | "cron" | "environment"
MonitorOutput
Fields
| Name | Type | Description |
|---|---|---|
kind | MonitorKind | |
id | string | |
name | string | |
liveAt | string | null | |
ready | boolean | |
missing | string[] | |
sources | MonitorSource[] |
MonitorProposalCreated
Fields
| Name | Type | Description |
|---|---|---|
monitor | "flow" | "cron" | "environment" | |
id | string | |
docId | string | |
message | ChatMessage |
MonitorSettings
Fields
| Name | Type | Description |
|---|---|---|
runRetentionDays | integer |
MonitorSource
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
repoId | string | |
repo | string | |
repoFullName | string | |
path | string | |
linkedBlob | string | null | |
currentBlob | string | null | |
changed | boolean | |
gone | boolean | |
commit | object | null | |
checkedAt | string | null |
MonitorSourceList
Fields
| Name | Type | Description |
|---|---|---|
sources | MonitorSource[] | |
changedCount | integer | |
note | string | null |
MonitorsWaiting
Fields
| Name | Type | Description |
|---|---|---|
sheets | object[] | |
projects | object[] | |
count | integer |
MountRepoBody
Fields
| Name | Type | Description |
|---|---|---|
repoId | string |
MoveGoalProjectBody
Fields
| Name | Type | Description |
|---|---|---|
columnoptional | "forYou" | "nextUp" | "working" | "done" | |
position | integer |
MyLicense
Fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | |
paymentsReady | boolean | |
plan | Plan | |
licenses | License[] | |
licensed | boolean | |
hasCustomer | boolean |
MyVaults
Fields
| Name | Type | Description |
|---|---|---|
userId | string | |
vaults | object[] |
Need
Fields
| Name | Type | Description |
|---|---|---|
desktopoptional | boolean | |
osoptional | "linux" | "macos" | "windows" | |
realScreenoptional | boolean | |
gpuoptional | boolean | |
kvmoptional | boolean | |
whyoptional | string |
Ok
Fields
| Name | Type | Description |
|---|---|---|
ok | true |
OpenBlockChatBody
Fields
| Name | Type | Description |
|---|---|---|
blockId | string | |
sheetIdoptional | string | null | |
titleoptional | string |
OpenChatTerminalBody
Fields
| Name | Type | Description |
|---|---|---|
colsoptional | integer | |
rowsoptional | integer | |
provideroptional | "claude" | "codex" | "cursor" | "grok" | "fake" | |
modeloptional | string | |
effortoptional | string | |
accountIdoptional | string | |
agentIdoptional | string | |
ruleIdoptional | string |
OpenPrBody
Fields
| Name | Type | Description |
|---|---|---|
title | string | |
bodyoptional | string |
OrderBody
Fields
| Name | Type | Description |
|---|---|---|
ids | string[] |
Org
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
slug | string | |
name | string | |
plan | string | |
retentionDays | integer | |
defaultAgent | string | null | |
defaultModel | string | null | |
defaultEffort | string | null | |
allowedEmailDomains | string[] | |
agentFeedback | boolean | |
publicReadableNames | boolean | |
allowPublicDocLinks | boolean | |
role | "owner" | "admin" | "member" | "viewer" | |
memberCount | integer | |
createdAt | string |
OrgGithub
Fields
| Name | Type | Description |
|---|---|---|
configured | boolean | |
appSlug | string | null | |
installations | GithubInstallation[] | |
me | GithubIdentity |
OrgStorage
Fields
| Name | Type | Description |
|---|---|---|
kind | "managed" | "r2" | "s3" | "gcs" | |
endpoint | string | null | |
region | string | null | |
bucket | string | null | |
accessKeyId | string | null | |
hasSecret | boolean | |
usable | boolean |
OrgSummary
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
slug | string | |
name | string | |
role | "owner" | "admin" | "member" | "viewer" |
OrgUsage
Fields
| Name | Type | Description |
|---|---|---|
measuredAt | string | |
totals | object | |
workspaces | object[] | |
publicHosting | EdgeOrgUsage & object | null |
OrgVault
Fields
| Name | Type | Description |
|---|---|---|
orgId | string | |
vault | VaultKey | |
holders | VaultHolder[] | |
pending | VaultCandidate[] | |
canManage | boolean | |
legacySecrets | integer | |
reachable | boolean | |
sealedSecrets | integer |
OutputTarget
Fields
| Name | Type | Description |
|---|---|---|
sheetId | string | null | |
docId | string | |
name | string |
Passkey
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
createdAt | string | |
lastUsedAt | string | null |
PasskeyLoginBody
Fields
| Name | Type | Description |
|---|---|---|
ticket | string | |
challengeIdoptional | string | |
response | object |
PasskeyLoginOptionsBody
Fields
| Name | Type | Description |
|---|---|---|
challengeIdoptional | string |
PasskeyRegisterBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
response | object |
PatchActionBody
Fields
| Name | Type | Description |
|---|---|---|
titleoptional | string | |
toolEnabledoptional | boolean | |
toolNameoptional | string | |
toolDescriptionoptional | string | |
toolAccessoptional | ActionToolAccess | |
toolProjectsoptional | string[] |
PatchActionSettingsBody
Fields
| Name | Type | Description |
|---|---|---|
gitEnabledoptional | boolean | |
remoteRepooptional | string | null | |
branchoptional | string | |
inboundoptional | ActionInbound | |
runnerIdoptional | string | null | |
maxParalleloptional | integer | |
keepRunsDaysoptional | integer | |
agentsMayEditoptional | boolean | |
notifyUserIdsoptional | string[] |
PatchAlertChannelBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
enabledoptional | boolean |
PatchAppEnvironmentBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
sourcesoptional | object[] |
PatchCardColumnsBody
Fields
| Name | Type | Description |
|---|---|---|
columns | object |
PatchCronMonitorBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
scheduleoptional | string | |
timezoneoptional | string | |
graceSecondsoptional | integer | |
maxRuntimeSecondsoptional | integer | null | |
activeoptional | boolean | |
alertsoptional | object | |
rotatePingTokenoptional | true |
PatchedFeedbackEntry
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
source | FeedbackSource | |
kind | FeedbackKind | |
title | string | |
body | string | |
name | string | null | |
email | string | null | |
page | string | null | |
status | FeedbackStatus | |
statusBy | object | null | |
statusAt | string | null | |
archivedAt | string | null | |
context | FeedbackContext & object | null | |
made | FeedbackLink[] | |
from | FeedbackFrom | |
createdAt | string | |
takeBack | string | null |
PatchFeedbackEntryBody
Fields
| Name | Type | Description |
|---|---|---|
statusoptional | FeedbackStatus | |
archivedoptional | boolean |
PatchFlowBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
stepsoptional | FlowStep[] | |
scheduleoptional | string | null | |
timezoneoptional | string | |
activeoptional | boolean | |
environmentIdoptional | string | null | |
alertsoptional | object | |
rotateWebhookTokenoptional | true |
PatchIncidentBody
Fields
| Name | Type | Description |
|---|---|---|
titleoptional | string | |
statusoptional | IncidentStatus | |
impactoptional | IncidentImpact | |
componentIdsoptional | string[] | |
publishedoptional | boolean | |
internalNoteoptional | string | null | |
startedAtoptional | string | |
dismissResolveProposaloptional | true |
PatchInsightBoardBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
refreshMinutesoptional | integer | null |
PatchInsightCardBody
Fields
| Name | Type | Description |
|---|---|---|
titleoptional | string | |
vizoptional | InsightViz | |
mappingoptional | InsightMapping | |
positionoptional | integer | |
sqloptional | string | |
refreshMinutesoptional | StatRefresh |
PatchInsightSourceBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
urloptional | string | |
sealedUrloptional | SealedSecret | |
targetoptional | InsightTarget | |
sslModeoptional | InsightSslMode | |
allowSelfSignedoptional | boolean | |
tablesoptional | object[] |
PatchMaintenanceBody
Fields
| Name | Type | Description |
|---|---|---|
titleoptional | string | |
bodyoptional | string | null | |
componentIdsoptional | string[] | |
startsAtoptional | string | |
endsAtoptional | string |
PatchMonitorEnvironmentBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
isDefaultoptional | true |
PatchStatusComponentBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
descriptionoptional | string | null | |
positionoptional | integer | |
flowIdsoptional | string[] | |
cronIdsoptional | string[] |
PatchStatusPageBody
Fields
| Name | Type | Description |
|---|---|---|
titleoptional | string | |
slugoptional | string | |
descriptionoptional | string | null | |
publishedoptional | boolean | |
subscriptionsEnabledoptional | boolean | |
autoIncidentModeoptional | AutoIncidentMode |
PauseActionBody
Fields
| Name | Type | Description |
|---|---|---|
paused | boolean |
Plan
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
summary | string | |
version | integer | |
monthlyCents | integer | |
yearlyCents | integer | |
currency | string | |
limits | PlanLimits | |
isDefault | boolean | |
buyable | object | |
updatedAt | string |
PlanLimits
Fields
| Name | Type | Description |
|---|---|---|
minSeats | integer | |
coversOrg | boolean |
PlanList
Fields
| Name | Type | Description |
|---|---|---|
plans | Plan[] | |
updatedAt | string | null |
Postmortem
Fields
| Name | Type | Description |
|---|---|---|
incidentId | string | |
summary | string | null | |
impact | string | null | |
rootCause | string | null | |
contributingFactors | string | null | |
resolution | string | null | |
lessons | string | null | |
actionItems | PostmortemActionItem[] | |
published | boolean | |
updatedBy | string | null | |
updatedAt | string | null | |
markdown | string |
PostmortemActionItem
Fields
| Name | Type | Description |
|---|---|---|
title | string | |
owneroptional | string | null | |
dueDateoptional | string | null | |
doneoptional | boolean |
Preferences
Fields
| Name | Type | Description |
|---|---|---|
layoutoptional | object | |
filesoptional | object | |
canvasoptional | object | |
contextoptional | object | |
pinsoptional | object | |
recentoptional | RecentItem[] | |
previewsoptional | object |
PreferencesResponse
Fields
| Name | Type | Description |
|---|---|---|
preferences | Preferences |
PreviewOpen
Fields
| Name | Type | Description |
|---|---|---|
url | string | |
redirect | string | |
expiresAt | string |
PreviewOpenBody
Fields
| Name | Type | Description |
|---|---|---|
pathoptional | string |
PreviewPort
Fields
| Name | Type | Description |
|---|---|---|
port | integer | |
address | string | |
pid | integer | null | |
ancestors | integer[] | |
command | string | |
url | string | |
published | object | null | |
proposals | PublishLabel[] |
PreviewPorts
Fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | |
running | boolean | |
ports | PreviewPort[] | |
publishing | PublishOptions | |
published | PublishedPort[] |
ProcessList
Fields
| Name | Type | Description |
|---|---|---|
supported | boolean | |
processes | object[] |
ProjectApps
Fields
| Name | Type | Description |
|---|---|---|
apps | ResolvedApp[] | |
hidden | object[] | |
runsOn | HostingRunnerChoice & object | null | |
blocked | string | null |
ProjectLink
Fields
| Name | Type | Description |
|---|---|---|
kind | "doc" | "prototype" | "file" | "project" | "research" | |
id | string | |
labeloptional | string |
ProjectNeeds
Fields
| Name | Type | Description |
|---|---|---|
need | Need & object | null | |
needKey | string | null | |
needLabel | string | null | |
metHere | boolean | |
chosen | object | null | |
runners | RemoteRunner[] | |
canChoose | boolean |
ProjectPreview
Fields
| Name | Type | Description |
|---|---|---|
containerId | string | |
slug | string | |
title | string | |
repo | string | |
name | string | |
instance | AppInstance |
ProjectProgress
Fields
| Name | Type | Description |
|---|---|---|
state | "planning" | "working" | "blocked" | "done" | null | |
currentPhase | integer | null | |
updated | string | null | |
lastAction | string | null | |
phases | object[] |
ProjectReview
Fields
| Name | Type | Description |
|---|---|---|
state | "reviewing" | "done" | "failed" | |
agent | string | |
agentId | string | |
chatId | string | null | |
comments | integer | |
summary | string | null | |
error | string | null | |
at | string |
PrototypePrefs
Fields
| Name | Type | Description |
|---|---|---|
kindoptional | "web" | "mobile" | "tablet" | "dashboard" | "desktop" | "landing" | "email" | "slides" | |
directionsoptional | 1 | 2 | 3 | |
lookoptional | "wireframe" | "product" | "polished" | |
alsooptional | ("empty" | "errors" | "loading" | "dialogs")[] |
PublicFeedbackForm
Fields
| Name | Type | Description |
|---|---|---|
slug | string | |
title | string | |
description | string | null | |
email | FeedbackEmailField | |
url | string |
PublicIncident
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
title | string | |
status | IncidentStatus | |
impact | IncidentImpact | |
componentIds | string[] | |
startedAt | string | |
resolvedAt | string | null | |
updates | PublicIncidentUpdate[] | |
postmortem | PublicPostmortem |
PublicIncidentDetail
Fields
| Name | Type | Description |
|---|---|---|
page | PublicStatusPageInfo | |
components | object[] | |
incident | PublicIncident |
PublicIncidentUpdate
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
status | IncidentStatus | |
body | string | |
createdAt | string |
PublicMaintenance
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
title | string | |
body | string | null | |
componentIds | string[] | |
startsAt | string | |
endsAt | string | |
active | boolean |
PublicPostmortem
Fields
| Name | Type | Description |
|---|---|---|
summary | string | null | |
impact | string | null | |
rootCause | string | null | |
contributingFactors | string | null | |
resolution | string | null | |
lessons | string | null | |
actionItems | object[] | |
updatedAt | string | null |
PublicStatusComponent
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
description | string | null | |
state | ComponentState | |
uptime30d | number | null | |
uptime90d | number | null | |
days | object[] |
PublicStatusHistory
Fields
| Name | Type | Description |
|---|---|---|
page | PublicStatusPageInfo | |
components | object[] | |
incidents | PublicIncident[] | |
maintenance | PublicMaintenance[] |
PublicStatusPage
Fields
| Name | Type | Description |
|---|---|---|
page | PublicStatusPageInfo | |
state | ComponentState | |
updatedAt | string | |
components | PublicStatusComponent[] | |
incidents | PublicIncident[] | |
recent | PublicIncident[] | |
maintenance | PublicMaintenance[] |
PublicStatusPageInfo
Fields
| Name | Type | Description |
|---|---|---|
slug | string | |
title | string | |
description | string | null | |
url | string | |
subscriptionsEnabled | boolean |
PublishedPort
Fields
| Name | Type | Description |
|---|---|---|
port | integer | |
url | string | |
host | string | |
label | string | |
domain | string | |
edge | boolean | |
visibility | PublishVisibility | |
until | PublishUntil | |
runner | object | |
publishedBy | object | null | |
publishedAt | string | |
command | string | null |
PublishLabel
Fields
| Name | Type | Description |
|---|---|---|
label | string | |
domain | string | |
edge | boolean |
PublishOptions
Fields
| Name | Type | Description |
|---|---|---|
possible | boolean | |
reason | "viewer" | "no_hosting_runner" | "hosting_down" | "no_domain" | "runner_update" | null | |
message | string | null | |
runner | object | null |
PublishPortBody
Fields
| Name | Type | Description |
|---|---|---|
label | string | |
domain | string | |
visibilityoptional | PublishVisibility | |
untiloptional | PublishUntil |
PublishUntil
"process" | "box" | "manual"
PublishVisibility
"team" | "public"
PullRequest
Fields
| Name | Type | Description |
|---|---|---|
number | integer | |
url | string | |
title | string | |
state | "open" | "closed" | "merged" | |
draft | boolean |
PullRequestState
Fields
| Name | Type | Description |
|---|---|---|
pr | PullRequest | |
pushed | boolean | |
mergeable | "mergeable" | "conflicting" | "unknown" | null |
PutActionFolderBody
Fields
| Name | Type | Description |
|---|---|---|
path | string | |
holdsoptional | string | |
keepoptional | object |
PutActionSecretBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
sealedoptional | SealedSecret | |
valueoptional | string | |
scopeoptional | ActionSecretScope | |
actionIdsoptional | string[] | |
stepRefoptional | string |
PutActionToolBody
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
versionoptional | string | |
script | string | |
sourceoptional | string |
PutAppConfigBody
Fields
| Name | Type | Description |
|---|---|---|
spec | object |
PutAppEnvBody
Fields
| Name | Type | Description |
|---|---|---|
entries | object[] |
PutAppEnvVarBody
Fields
| Name | Type | Description |
|---|---|---|
value | string | null | |
secretoptional | boolean | |
sealedoptional | SealedSecret |
PutMonitorEnvVarBody
Fields
| Name | Type | Description |
|---|---|---|
value | string | null | |
secretoptional | boolean | |
sealedoptional | SealedSecret |
PutPostmortemBody
Fields
| Name | Type | Description |
|---|---|---|
summaryoptional | string | null | |
impactoptional | string | null | |
rootCauseoptional | string | null | |
contributingFactorsoptional | string | null | |
resolutionoptional | string | null | |
lessonsoptional | string | null | |
actionItemsoptional | PostmortemActionItem[] | |
publishedoptional | boolean |
PutWorkspaceAppsSettingsBody
Fields
| Name | Type | Description |
|---|---|---|
runnerIdoptional | string | null | |
domainoptional | string | null | |
previewVisibilityoptional | AppVisibility |
QuickStart
Fields
| Name | Type | Description |
|---|---|---|
steps | object | |
done | integer | |
total | integer | |
hiddenAt | string | null |
RecentItem
Fields
| Name | Type | Description |
|---|---|---|
kind | "doc" | "prototype" | "project" | "research" | "file" | |
id | string | |
workspace | string | |
title | string | |
at | string | |
count | integer | |
since | string |
RecoveryCodes
Fields
| Name | Type | Description |
|---|---|---|
recoveryCodes | string[] |
RefreshAttachmentBody
Fields
| Name | Type | Description |
|---|---|---|
forceoptional | boolean |
ReleaseRepoResult
Fields
| Name | Type | Description |
|---|---|---|
released | boolean | |
kept | "in_use" | "on_canvas" | null | |
message | string | null |
RemoteRun
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
containerId | string | |
runnerId | string | null | |
runnerName | string | |
needKey | string | |
command | string | |
state | "queued" | "running" | "passed" | "failed" | "cancelled" | "error" | |
exitCode | integer | null | |
error | string | null | |
probe | boolean | |
artifacts | object[] | |
screenshots | string[] | |
startedBy | string | null | |
createdAt | string | |
finishedAt | string | null |
RemoteRunList
Fields
| Name | Type | Description |
|---|---|---|
runs | RemoteRun[] |
RemoteRunLog
Fields
| Name | Type | Description |
|---|---|---|
run | RemoteRun | |
lines | string[] | |
total | integer |
RemoteRunner
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
kind | "official" | "official-pro" | "org" | "personal" | |
online | boolean | |
state | "confirmed" | "reported" | "not-accepting" | "missing" | |
missing | string[] | |
confirmedAt | string | null | |
platform | string | |
outdated | boolean |
RemovePathsBody
Fields
| Name | Type | Description |
|---|---|---|
paths | string[] |
RenameAgentAccountBody
Fields
| Name | Type | Description |
|---|---|---|
label | string |
ReplyBody
Fields
| Name | Type | Description |
|---|---|---|
bodyoptional | string | |
attachmentsoptional | CommentAttachment[] |
Repo
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
slug | string | |
fullName | string | |
description | string | null | |
private | boolean | |
defaultBranch | string | |
createdAt | string |
RepoBranch
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
commit | string | |
date | string | |
subject | string |
RepoBranches
Fields
| Name | Type | Description |
|---|---|---|
branches | string[] | |
current | string | |
detailsoptional | RepoBranch[] |
RepoIssue
Fields
| Name | Type | Description |
|---|---|---|
number | integer | |
title | string | |
url | string | |
author | string | null | |
labels | object[] | |
updatedAt | string |
RepoIssues
Fields
| Name | Type | Description |
|---|---|---|
issues | RepoIssue[] | |
unavailableoptional | boolean |
RepoPull
Fields
| Name | Type | Description |
|---|---|---|
number | integer | |
title | string | |
url | string | |
branch | string | |
base | string | |
author | string | null | |
draft | boolean | |
fork | boolean | |
mergeable | "mergeable" | "conflicting" | "unknown" | |
checks | "success" | "failure" | "pending" | null | |
updatedAt | string |
RepoPulls
Fields
| Name | Type | Description |
|---|---|---|
pulls | RepoPull[] |
ResetVaultBody
Fields
| Name | Type | Description |
|---|---|---|
runnerIdoptional | string |
ResolveConflictBody
object | object
ResolveConflictResult
Fields
| Name | Type | Description |
|---|---|---|
conflict | FileConflict | |
keptAs | string | null | |
sha | string | null |
ResolvedApp
Fields
| Name | Type | Description |
|---|---|---|
repo | string | |
repoId | string | |
name | string | |
source | AppConfigLayer | |
spec | object | |
overrides | AppConfigLayer & string | null | |
missing | string[] | |
noWorktree | boolean | |
envIssues | integer | |
instance | AppInstance | |
hostRenameoptional | object | null |
RestartRunnerBody
Fields
| Name | Type | Description |
|---|---|---|
forceoptional | boolean |
RestoreCriterionBody
Fields
| Name | Type | Description |
|---|---|---|
text | string |
RetryFailedBody
Fields
| Name | Type | Description |
|---|---|---|
workspaceIdoptional | string |
RetryFailedResult
Fields
| Name | Type | Description |
|---|---|---|
chats | integer | |
projects | integer |
RevertHunkBody
Fields
| Name | Type | Description |
|---|---|---|
path | string | |
hunk | string |
ReviewChange
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
group | ReviewGroup | |
kind | string | |
paths | string[] | |
symbol | object | null | |
additions | integer | |
deletions | integer | |
contentHash | string | |
reach | ReviewReach | |
readAs | string | |
proof | ReviewProof | |
meaning | ReviewMeaning | |
risk | object | |
summary | string | |
hunks | ReviewHunk[] |
ReviewChecklist
Fields
| Name | Type | Description |
|---|---|---|
markdown | string |
ReviewDigest
Fields
| Name | Type | Description |
|---|---|---|
baseSha | string | |
headSha | string | |
truncated | boolean | |
stats | ReviewStats | |
changes | ReviewChange[] | |
setup | ReviewSetupItem[] |
ReviewExplanations
Fields
| Name | Type | Description |
|---|---|---|
whatChanged | object[] | |
perChange | object |
ReviewGroup
"readFirst" | "moved" | "sameEdit" | "newCode" | "setup" | "tests" | "folded"
ReviewHunk
Fields
| Name | Type | Description |
|---|---|---|
path | string | |
header | string | |
lines | ReviewHunkLine[] | |
omitted | integer |
ReviewHunkLine
Fields
| Name | Type | Description |
|---|---|---|
kind | "context" | "add" | "del" | "rename" | "collapsed" | |
text | string | |
oldLine | integer | null | |
newLine | integer | null |
ReviewMeaning
object | object | object | object | object | null
ReviewProof
Fields
| Name | Type | Description |
|---|---|---|
rule | string | |
holds | boolean | |
detail | string |
ReviewReach
Fields
| Name | Type | Description |
|---|---|---|
callers | integer | |
testCallers | integer | |
through | string | null | |
measured | "syntax" | "text" | |
note | string |
ReviewReadBody
Fields
| Name | Type | Description |
|---|---|---|
contentHash | string |
ReviewRepo
Fields
| Name | Type | Description |
|---|---|---|
slug | string | |
name | string | |
base | string | |
prNumber | integer | null | |
prUrl | string | null |
ReviewSetupItem
Fields
| Name | Type | Description |
|---|---|---|
type | ReviewSetupType | |
title | string | |
detail | string | |
paths | string[] | |
snippet | string | null |
ReviewSetupType
"migration" | "envNew" | "envRemoved" | "cron" | "routes" | "compose" | "versions" | "inputs" | "removed" | "guide"
ReviewState
Fields
| Name | Type | Description |
|---|---|---|
repo | string | |
repos | ReviewRepo[] | |
status | ReviewStatus | |
digest | ReviewDigest | |
explanations | ReviewExplanations | |
explaining | boolean | |
reads | object | |
error | string | null | |
computedAt | string | null |
ReviewStats
Fields
| Name | Type | Description |
|---|---|---|
linesChanged | integer | |
linesToRead | integer | |
setupSteps | integer | |
foldedLines | integer | |
movedOrRepeated | integer | |
files | integer | |
parsers | string[] | |
unparsed | object[] |
ReviewStatus
"pending" | "ready" | "failed"
RotateApiKeyBody
Fields
| Name | Type | Description |
|---|---|---|
graceHoursoptional | integer |
RotatedRunnerToken
Fields
| Name | Type | Description |
|---|---|---|
runner | Runner | |
token | string | |
command | string | |
installCommand | string | |
installCommandWindows | string | |
compose | object | |
delivered | boolean | |
fromEnv | boolean |
RunActionBody
Fields
| Name | Type | Description |
|---|---|---|
inputsoptional | object | |
versionIdoptional | string | |
fromStepoptional | string | |
fromRunIdoptional | string | |
skipoptional | string[] | |
previewoptional | boolean |
RunFlowBody
Fields
| Name | Type | Description |
|---|---|---|
environmentIdoptional | string | null |
Runner
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
kind | "official" | "official-pro" | "org" | "personal" | |
online | boolean | |
capabilities | object | null | |
version | string | null | |
lastSeenAt | string | null | |
workspaceCount | integer | |
createdAt | string | |
setupPending | boolean | |
device | RunnerDevice | |
direct | RunnerDirect | |
owner | object | null | |
mine | boolean | |
othersCanEdit | boolean | |
agentConcurrency | integer | null | |
load | RunnerLoadSettings | |
updatePending | boolean | |
acceptsRemoteRuns | boolean | |
hosting | object | |
token | object | null | |
promotion | object | null |
RunnerBusy
Fields
| Name | Type | Description |
|---|---|---|
work | RunnerBusyItem[] | |
hidden | integer | |
listed | boolean | |
whenIdle | boolean | |
version | string | null |
RunnerBusyItem
Fields
| Name | Type | Description |
|---|---|---|
kind | "turn" | "cli" | "background" | "screenshot" | "export" | |
workspace | object | null | |
project | object | null | |
chatId | string | null | |
since | string |
RunnerDevice
Fields
| Name | Type | Description |
|---|---|---|
state | "pinned" | "unpinned" | "pending" | |
hostname | string | null | |
os | string | null | |
pinnedAt | string | null | |
change | RunnerDeviceChange |
RunnerDeviceChange
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
hostname | string | |
os | string | |
arch | string | |
ip | string | null | |
firstSeenAt | string | |
lastSeenAt | string | |
waiting | boolean |
RunnerDirect
Fields
| Name | Type | Description |
|---|---|---|
url | string | |
status | "unverified" | "ok" | "unreachable" | |
checkedAt | string | null | |
error | string | null |
RunnerHosting
Fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | |
supported | boolean | null | |
domain | HostingDomainStatus | |
domains | HostingDomainStatus[] | |
tls | "off" | "manual" | "http01" | "dns01" | |
maxApps | integer | null | |
maxAppsPerOrg | integer | null | |
listen | string | null | |
publicSubdomains | boolean | |
publicMode | "proxy" | "tunnel" | |
publicOrigin | string | null | |
publicOriginStatus | "unverified" | "ok" | "unreachable" | null | |
publicOriginError | string | null | |
acceptsWorkspaces | boolean | |
edge | boolean | |
edgeDomain | string | null | |
state | HostingState |
RunnerHostingBody
Fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | |
domainoptional | string | null | |
tlsoptional | "off" | "manual" | "http01" | "dns01" | |
maxAppsoptional | integer | null | |
maxAppsPerOrgoptional | integer | null | |
listenoptional | string | null | |
publicSubdomainsoptional | boolean | |
publicModeoptional | "proxy" | "tunnel" | |
publicOriginoptional | string | null | |
acceptsWorkspacesoptional | boolean |
RunnerHostingDoctorApplyBody
Fields
| Name | Type | Description |
|---|---|---|
proposalId | string |
RunnerHostingDomainBody
Fields
| Name | Type | Description |
|---|---|---|
domain | string |
RunnerLoadPatch
Fields
| Name | Type | Description |
|---|---|---|
cpuThresholdoptional | integer | |
memoryThresholdoptional | integer | |
hysteresisoptional | integer | |
maxQueueWaitMinutesoptional | integer | null | |
autoPauseIdleBoxesoptional | boolean | |
busyIdleMinutesoptional | integer |
RunnerLoadSettings
Fields
| Name | Type | Description |
|---|---|---|
cpuThreshold | integer | |
memoryThreshold | integer | |
hysteresis | integer | |
maxQueueWaitMinutes | integer | null | |
autoPauseIdleBoxes | boolean | |
busyIdleMinutes | integer |
RunnerPromotion
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
runner | object | |
from | object | |
requestedBy | object | |
tier | "standard" | "pro" | |
hosting | RunnerPromotionHosting | |
releaseDomains | string[] | |
note | string | null | |
createdAt | string | |
preview | RunnerPromotionPreview |
RunnerPromotionHosting
"keep" | "off" | "edge"
RunnerPromotionPreview
Fields
| Name | Type | Description |
|---|---|---|
orgs | object[] | |
workspaces | integer | |
runningApps | integer | |
domains | object[] | |
publishedPorts | integer | |
edgeLabels | integer | |
nameTaken | boolean | |
edgeTaken | boolean |
RunnerProxyConfig
Fields
| Name | Type | Description |
|---|---|---|
flavor | "traefik" | "nginx" | "caddy" | |
text | string | |
path | string | null | |
upstream | string | null | |
domains | string[] | |
bridgeUpstream | string | null | |
needsDns01 | boolean | |
error | string | null |
RunnerQueue
Fields
| Name | Type | Description |
|---|---|---|
host | object | null | |
hostedApps | integer | |
counts | object | |
entries | RunnerQueueEntry[] |
RunnerQueueEntry
Fields
| Name | Type | Description |
|---|---|---|
chatId | string | null | |
workspace | object | |
container | object | null | |
owner | object | null | |
state | "running" | "queued" | "held" | "failed" | |
reason | "concurrency" | "load" | "usage" | null | |
position | integer | null | |
mode | "chat" | "spec-draft" | "implement" | null | |
error | string | null | |
since | string | null |
RunnerReleases
Fields
| Name | Type | Description |
|---|---|---|
latest | object | null | |
installScript | object | |
composeFile | string | |
composeVersion | integer | |
desktopoptional | object | null |
RunnerRestartResult
Fields
| Name | Type | Description |
|---|---|---|
restart | "service" | "container" | "self" |
RunnerRouteCheck
Fields
| Name | Type | Description |
|---|---|---|
ok | boolean | |
cause | string | |
host | string | null | |
message | string | |
fix | string | null |
RunnerUpdatePending
Fields
| Name | Type | Description |
|---|---|---|
pending | true |
RunnerUpdateResult
RunnerUpdateStarted
Fields
| Name | Type | Description |
|---|---|---|
from | string | |
to | string | |
restart | "service" | "container" | "self" |
RunStatsBody
Fields
| Name | Type | Description |
|---|---|---|
sheetIdoptional | string | null |
RunTrigger
"schedule" | "manual" | "webhook" | "agent"
SaveFeedbackFormBody
Fields
| Name | Type | Description |
|---|---|---|
titleoptional | string | |
slugoptional | string | |
descriptionoptional | string | null | |
publishedoptional | boolean | |
emailoptional | FeedbackEmailField |
SaveHistoryBody
Fields
| Name | Type | Description |
|---|---|---|
messageoptional | string | |
containeroptional | string |
Screenshot
Fields
| Name | Type | Description |
|---|---|---|
path | string | |
width | integer | |
height | integer | |
warnings | string[] | |
blockId | string | null |
ScreenshotBody
Fields
| Name | Type | Description |
|---|---|---|
containeroptional | string | |
mode | "url" | "screen" | |
urloptional | string | |
widthoptional | integer | |
heightoptional | integer | |
fullPageoptional | boolean | |
addToCanvasoptional | boolean |
SealedEnvelope
string
SealedSecret
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
sealed | SealedEnvelope |
SealedSecretCopy
Fields
| Name | Type | Description |
|---|---|---|
vaultId | string | |
id | string | |
sealed | SealedEnvelope |
SecondOpinionFollowUpBody
Fields
| Name | Type | Description |
|---|---|---|
text | string |
SecondOpinionResult
Fields
| Name | Type | Description |
|---|---|---|
chat | Chat |
SendChatBody
Fields
| Name | Type | Description |
|---|---|---|
text | string | |
contextBlockIdsoptional | string[] | |
sheetIdoptional | string | null | |
blocksoptional | BlockRef[] | |
attachmentsoptional | string[] | |
placeoptional | "quick-start" | |
monitorIdsoptional | string[] | |
statIdsoptional | string[] | |
allStatsoptional | boolean | |
reviewChangesoptional | object[] | |
draftMonitorsoptional | object | |
locationoptional | ChatPlace | |
docIdoptional | string | |
contextDocsoptional | ChatContextDoc[] | |
contextCanvasesoptional | ChatContextCanvas[] | |
contextLinksoptional | ChatContextLink[] | |
contextoptional | ContextEntity[] | |
contextPathsoptional | ContextPath[] | |
prototypePrefsoptional | PrototypePrefs | |
addedoptional | ChatAdded | |
commentThreadsoptional | string[] | |
provideroptional | "claude" | "codex" | "cursor" | "grok" | "fake" | |
modeloptional | string | |
effortoptional | string | |
accountIdoptional | string | |
agentIdoptional | string | |
ruleIdoptional | string |
SendSecondOpinionBody
Fields
| Name | Type | Description |
|---|---|---|
noteoptional | string |
SetPatBody
Fields
| Name | Type | Description |
|---|---|---|
token | string |
SetQuickStartBody
Fields
| Name | Type | Description |
|---|---|---|
hidden | boolean |
SetRepoBranchBody
Fields
| Name | Type | Description |
|---|---|---|
branch | string |
SetRepoReadOnlyBody
Fields
| Name | Type | Description |
|---|---|---|
readOnly | boolean |
SetRunnerDirectBody
Fields
| Name | Type | Description |
|---|---|---|
url | string |
SetupFailureDetail
Fields
| Name | Type | Description |
|---|---|---|
stepoptional | string | |
repooptional | string | |
argsoptional | string[] | |
cwdoptional | string | |
codeoptional | integer | null | |
timedOutoptional | boolean | |
durationMsoptional | number | |
outputoptional | string | |
gitoptional | string | null | |
gitLfsoptional | string | |
pathoptional | string | |
homeoptional | string |
SetUpVaultBody
Fields
| Name | Type | Description |
|---|---|---|
runnerIdoptional | string |
SetWorkspaceLogoBody
object | object
Sheet
Fields
| Name | Type | Description |
|---|---|---|
id | string | null | |
name | string | |
docId | string | |
role | "owner" | "editor" | "viewer" | |
canManage | boolean | |
createdBy | object | null | |
kind | "tab" | "investigation" | "canvas" | |
investigation | SheetInvestigation |
SheetInvestigation
Fields
| Name | Type | Description |
|---|---|---|
question | string | |
chatId | string | null | |
state | "running" | "finished" | "failed" | |
finishedAt | string | null | |
error | string | null | |
blocksPosted | integer | null | |
docId | string | null | |
answer | string | null |
SheetList
Fields
| Name | Type | Description |
|---|---|---|
sheets | Sheet[] |
SignInBody
Fields
| Name | Type | Description |
|---|---|---|
email | string | |
password | string |
SignUpBody
Fields
| Name | Type | Description |
|---|---|---|
email | string | |
password | string | |
name | string |
SkipCriterionBody
Fields
| Name | Type | Description |
|---|---|---|
text | string | |
reasonoptional | string |
SnapshotLink
Fields
| Name | Type | Description |
|---|---|---|
url | string | null | |
lastSyncedAt | string | null |
StartAgentLoginBody
Fields
| Name | Type | Description |
|---|---|---|
runnerIdoptional | string | |
workspaceIdoptional | string |
StartContainerBody
Fields
| Name | Type | Description |
|---|---|---|
provideroptional | "claude" | "codex" | "cursor" | "grok" | "fake" | |
modeloptional | string | |
effortoptional | string | |
accountIdoptional | string | |
agentIdoptional | string | |
ruleIdoptional | string | |
focusoptional | "open-criteria" |
StartRemoteRunBody
Fields
| Name | Type | Description |
|---|---|---|
commandoptional | string | |
probeoptional | boolean | |
runnerIdoptional | string | |
timeoutMinutesoptional | integer |
StartStepsBody
Fields
| Name | Type | Description |
|---|---|---|
messageId | string | |
stepsoptional | object[] |
StartStepsResult
Fields
| Name | Type | Description |
|---|---|---|
steps | ChatStepRun[] |
StartThreadBody
Fields
| Name | Type | Description |
|---|---|---|
containeroptional | string | |
anchor | object | object | object | |
bodyoptional | string | |
attachmentsoptional | CommentAttachment[] |
StatAsked
Fields
| Name | Type | Description |
|---|---|---|
card | InsightCard | |
chatId | string | |
blockId | string |
StatList
Fields
| Name | Type | Description |
|---|---|---|
stats | InsightCard[] |
StatRefresh
60 | 1440 | null
StatusComponent
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
pageId | string | |
name | string | |
description | string | null | |
position | integer | |
flowIds | string[] | |
cronIds | string[] | |
state | ComponentState | |
createdAt | string |
StatusPage
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
slug | string | |
title | string | |
description | string | null | |
published | boolean | |
subscriptionsEnabled | boolean | |
autoIncidentMode | AutoIncidentMode | |
publicUrl | string | |
components | StatusComponent[] | |
subscribers | integer | |
openIncidents | integer | |
createdAt | string | |
updatedAt | string |
StatusPageList
Fields
| Name | Type | Description |
|---|---|---|
pages | StatusPage[] |
StatusSubscribeBody
Fields
| Name | Type | Description |
|---|---|---|
email | string |
StatusSubscriber
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
email | string | |
confirmed | boolean | |
confirmedAt | string | null | |
createdAt | string |
StatusSubscriberList
Fields
| Name | Type | Description |
|---|---|---|
subscribers | StatusSubscriber[] |
StatusSubscriptionAnswer
Fields
| Name | Type | Description |
|---|---|---|
ok | true | |
page | object | |
message | string |
StatusSummary
Fields
| Name | Type | Description |
|---|---|---|
page | object | |
status | ComponentState | |
description | string | |
updatedAt | string | |
components | object[] | |
activeIncidents | object[] | |
nextMaintenance | object | null |
StepResult
Fields
| Name | Type | Description |
|---|---|---|
index | integer | |
stepId | string | null | |
name | string | null | |
method | string | |
url | string | |
status | StepStatus | |
statusCode | integer | null | |
responseTimeMs | integer | null | |
responseBody | string | null | |
responseHeaders | object | null | |
responseContentType | string | null | |
assertionResults | AssertionResult[] | |
logOutput | string[] | |
error | string | null | |
attemptsoptional | integer | |
skipReasonoptional | "condition" | "previous_failure" | null | |
isCleanupoptional | boolean | |
failureSourceoptional | "target" | "runner" | null |
StepStatus
"passed" | "failed" | "timeout" | "error" | "skipped"
StorageBucket
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
scope | "instance" | "org" | |
name | string | |
provider | "r2" | "s3" | "gcs" | "s3c" | |
isDefault | boolean | |
acceptsNew | boolean | |
source | "env" | "legacy" | "added" | |
endpoint | string | null | |
region | string | null | |
bucket | string | null | |
accessKeyId | string | null | |
hasSecret | boolean | |
workspaces | integer | null |
StorageTestResult
Fields
| Name | Type | Description |
|---|---|---|
ok | boolean | |
step | string | null | |
detail | string | null |
SttStatus
Fields
| Name | Type | Description |
|---|---|---|
available | boolean | |
source | "account" | "org" | null |
SubmitFeedbackBody
Fields
| Name | Type | Description |
|---|---|---|
kindoptional | FeedbackKind | |
titleoptional | string | |
bodyoptional | string | |
nameoptional | string | |
emailoptional | string | |
pageoptional | string |
SubmitRunnerPromotionBody
Fields
| Name | Type | Description |
|---|---|---|
tieroptional | "standard" | "pro" | |
hostingoptional | RunnerPromotionHosting | |
releaseDomainsoptional | string[] | |
noteoptional | string | null |
SubProjects
Fields
| Name | Type | Description |
|---|---|---|
containers | Container[] |
SyncBackResult
Fields
| Name | Type | Description |
|---|---|---|
copied | integer | |
merged | integer | |
conflicts | FileConflict[] |
TakeBackFeedbackBody
Fields
| Name | Type | Description |
|---|---|---|
token | string |
Terminal
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
container | string | null | |
title | string | |
agentoptional | object |
TestBaseline
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
repo | string | |
branch | string | |
sha | string | |
status | "running" | "ready" | "failed" | |
failures | TestFailure[] | |
perCommand | TestCommandResult[] | |
error | string | null | |
startedAt | string | |
finishedAt | string | null | |
stale | boolean |
TestBaselineView
Fields
| Name | Type | Description |
|---|---|---|
baseline | TestBaseline | |
configured | boolean | |
progress | TestRun[] |
TestCommand
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
run | string | |
format | TestFormat | |
timeoutMinoptional | integer |
TestCommandResult
Fields
| Name | Type | Description |
|---|---|---|
name | string | |
exit | integer | null | |
ok | boolean | |
count | integer | |
oomKilled | boolean | |
why | string | null |
TestConfig
Fields
| Name | Type | Description |
|---|---|---|
setupoptional | string | null | |
commands | TestCommand[] | |
repo | string | |
updatedAt | string |
TestConfigBody
Fields
| Name | Type | Description |
|---|---|---|
setupoptional | string | null | |
commands | TestCommand[] |
TestFailure
Fields
| Name | Type | Description |
|---|---|---|
kind | "test" | "type" | |
file | string | |
name | string | |
commandoptional | string |
TestFormat
"bun-test" | "playwright" | "tsc" | "junit"
TestRun
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
command | string | |
label | string | |
repo | string | null | |
diroptional | string | |
origin | "agent" | "compare" | "baseline" | "base" | |
processId | string | null | |
turnIdoptional | string | |
chatIdoptional | string | |
source | "output" | "file" | "activity" | |
tool | "playwright" | "bun-test" | "vitest" | "jest" | "pytest" | "go-test" | "cypress" | "tap" | null | |
unit | "tests" | "files" | "packages" | |
passed | integer | |
failed | integer | |
skipped | integer | |
total | integer | null | |
totalKind | "exact" | "estimate" | null | |
current | string | null | |
failures | TestRunFailure[] | |
lastLine | string | null | |
startedAt | string | |
lastReportAt | string | null | |
state | TestRunState | |
endedAt | string | null | |
exitCode | integer | null | |
causeoptional | string | null | |
baseoptional | TestRunBase |
TestRunBase
Fields
| Name | Type | Description |
|---|---|---|
branch | string | |
sha | string | |
state | "checking" | "checked" | "no_result" | |
alsoOnBase | TestRunFailure[] | |
new | TestRunFailure[] | |
why | string | null | |
checkedAt | string |
TestRunFailure
Fields
| Name | Type | Description |
|---|---|---|
file | string | |
name | string |
TestRunState
"running" | "passed" | "failed" | "stopped" | "timed_out" | "oom" | "killed"
TestStepBody
Fields
| Name | Type | Description |
|---|---|---|
step | FlowStep | |
withPreviousoptional | boolean | |
indexoptional | integer | |
environmentIdoptional | string | null |
TotpCodeBody
Fields
| Name | Type | Description |
|---|---|---|
code | string |
TotpSetup
Fields
| Name | Type | Description |
|---|---|---|
secret | string | |
otpauthUrl | string |
TranscribeBody
Fields
| Name | Type | Description |
|---|---|---|
audio | string | |
mimeTypeoptional | string | |
orgoptional | string |
Transcription
Fields
| Name | Type | Description |
|---|---|---|
text | string |
TransferBody
Fields
| Name | Type | Description |
|---|---|---|
from | object | |
to | object | |
diroptional | string | |
moveoptional | boolean |
TransferResult
Fields
| Name | Type | Description |
|---|---|---|
path | string | |
files | integer | |
mergedoptional | integer | |
conflictsoptional | FileConflict[] |
TurnOnMonitorsBody
Fields
| Name | Type | Description |
|---|---|---|
sheetIdoptional | string | null | |
idsoptional | string[] |
TurnOnMonitorsResult
Fields
| Name | Type | Description |
|---|---|---|
turnedOn | MonitorOutput[] | |
waiting | MonitorOutput[] |
TwoFactorChallenge
Fields
| Name | Type | Description |
|---|---|---|
twoFactor | object |
TwoFactorEmailSendBody
Fields
| Name | Type | Description |
|---|---|---|
challengeId | string |
TwoFactorPreferredBody
Fields
| Name | Type | Description |
|---|---|---|
method | "totp" | "passkey" | "email" |
TwoFactorVerifyBody
Fields
| Name | Type | Description |
|---|---|---|
challengeId | string | |
code | string |
UnarchiveBody
Fields
| Name | Type | Description |
|---|---|---|
runnerIdoptional | string |
UpdateAttachmentBody
Fields
| Name | Type | Description |
|---|---|---|
keptAsoptional | AttachmentKeptAs | |
pinnedRefoptional | string | null |
UpdateContainerBody
Fields
| Name | Type | Description |
|---|---|---|
titleoptional | string | |
limitsoptional | ContainerLimits | |
verificationDepthoptional | "quick" | "standard" | "thorough" | null | |
parentIdoptional | string | null |
UpdateCrewRuleBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
instructionsoptional | string | null | |
agentIdsoptional | string[] | |
modeoptional | "in_order" | "agent_picks" | |
isDefaultoptional | boolean |
UpdateCrewSettingsBody
Fields
| Name | Type | Description |
|---|---|---|
crewNoOneLeftoptional | "ask" | "wait" | |
agentsMayMessageoptional | boolean | |
askBeforeAgentDocEditsoptional | boolean | |
agentTurnLimitoptional | integer | |
delegateMaxChildrenoptional | integer | |
delegateMaxDepthoptional | integer | |
askBeforeoptional | GoalAlwaysAsk[] | |
reviewerAgentIdoptional | string | null |
UpdateEmailPreferencesBody
Fields
| Name | Type | Description |
|---|---|---|
securityoptional | boolean | |
commentsoptional | boolean | |
agent_inputoptional | boolean | |
agent_resultoptional | boolean | |
conflictsoptional | boolean | |
monitorsoptional | boolean |
UpdateFollowUpBody
Fields
| Name | Type | Description |
|---|---|---|
autoRebase | boolean |
UpdateGoalBody
Fields
| Name | Type | Description |
|---|---|---|
titleoptional | string | |
autonomyoptional | "ask" | "autopilot" | |
alwaysAskoptional | GoalAlwaysAsk[] | |
reviewCapoptional | integer | |
concurrencyoptional | integer | |
contextoptional | GoalContextItem[] | |
boardDocOnoptional | boolean | |
reposoptional | object[] |
UpdateMemberBody
Fields
| Name | Type | Description |
|---|---|---|
role | "owner" | "admin" | "member" | "viewer" |
UpdateOrgBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
slugoptional | string | |
retentionDaysoptional | 0 | 3 | 7 | 14 | 30 | 90 | 365 | |
defaultAgentoptional | string | null | |
defaultModeloptional | string | null | |
defaultEffortoptional | string | null | |
allowedEmailDomainsoptional | string[] | |
agentFeedbackoptional | boolean | |
publicReadableNamesoptional | boolean | |
allowPublicDocLinksoptional | boolean |
UpdateOrgStorageBody
Fields
| Name | Type | Description |
|---|---|---|
kind | "managed" | "r2" | "s3" | "gcs" | |
endpointoptional | string | |
regionoptional | string | |
bucketoptional | string | |
accessKeyIdoptional | string | |
secretAccessKeyoptional | string | |
sealedSecretAccessKeyoptional | SealedSecret |
UpdatePersonalRunnerBody
Fields
| Name | Type | Description |
|---|---|---|
othersCanEditoptional | boolean | |
agentConcurrencyoptional | integer | null | |
loadoptional | RunnerLoadPatch | |
acceptsRemoteRunsoptional | boolean |
UpdatePreferencesBody
Fields
| Name | Type | Description |
|---|---|---|
layoutoptional | object | |
filesoptional | object | |
canvasoptional | object | |
contextoptional | object | |
pinsoptional | object | |
recentoptional | RecentItem[] | |
previewsoptional | object |
UpdateProfileBody
Fields
| Name | Type | Description |
|---|---|---|
name | string |
UpdateRunnerBody
Fields
| Name | Type | Description |
|---|---|---|
agentConcurrencyoptional | integer | null | |
loadoptional | RunnerLoadPatch | |
acceptsRemoteRunsoptional | boolean |
UpdateRunnerNowBody
Fields
| Name | Type | Description |
|---|---|---|
forceoptional | boolean | |
whenIdleoptional | boolean |
UpdateSheetBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
positionoptional | integer |
UpdateStorageBucketBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
isDefaultoptional | boolean | |
acceptsNewoptional | boolean | |
accessKeyIdoptional | string | |
secretAccessKeyoptional | string | |
sealedSecretAccessKeyoptional | SealedSecret |
UpdateWorkspaceAgentBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
modeloptional | string | null | |
effortoptional | string | null | |
instructionsoptional | string | null | |
enabledoptional | boolean |
UpdateWorkspaceBody
Fields
| Name | Type | Description |
|---|---|---|
nameoptional | string | |
runnerIdoptional | string | |
orgAccessoptional | "edit" | "view" | "none" | |
defaultAgentoptional | string | null | |
defaultModeloptional | string | null | |
defaultEffortoptional | string | null | |
useGpuoptional | boolean | |
useDockeroptional | boolean | |
useKvmoptional | boolean | |
deleteWorktreesWhenDoneoptional | boolean | |
closedProjectRetentionDaysoptional | ClosedProjectRetentionDays | |
autoApproveSpecoptional | boolean | |
autoPushoptional | boolean | |
autoOpenProptional | boolean | |
prProjectContextoptional | boolean | |
autoResumeoptional | boolean | |
verificationDepthoptional | VerificationDepth | |
mergeQueueWaitForChecksoptional | boolean | |
limitsoptional | WorkspaceLimits | |
historyRemoteoptional | string | null |
UploadResult
Fields
| Name | Type | Description |
|---|---|---|
path | string | |
size | number |
UploadTicket
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
mode | "bucket" | "relay" | |
url | string | |
path | string |
User
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
email | string | |
name | string | |
emailVerified | boolean | |
isAdmin | boolean | |
pendingApproval | boolean | |
onboarded | boolean | |
twoFactor | object | |
createdAt | string |
UserResponse
Fields
| Name | Type | Description |
|---|---|---|
user | User |
VaultCandidate
Fields
| Name | Type | Description |
|---|---|---|
runnerId | string | |
name | string | |
scope | "official" | "org" | "personal" | |
online | boolean | |
hostname | string | null | |
fingerprint | string | null |
VaultHolder
Fields
| Name | Type | Description |
|---|---|---|
runnerId | string | |
name | string | |
scope | "official" | "org" | "personal" | |
online | boolean | |
ready | boolean | |
loaded | boolean | |
error | string | null | |
fingerprint | string | null | |
approvedBy | string | null | |
createdAt | string |
VaultKey
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
publicKey | string | |
fingerprint | string | |
createdAt | string |
VerificationDepth
"quick" | "standard" | "thorough"
VerifyBody
Fields
| Name | Type | Description |
|---|---|---|
code | string |
Workspace
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
orgId | string | |
slug | string | |
name | string | |
status | "provisioning" | "ready" | "error" | "archived" | |
error | string | null | |
runner | WorkspaceRunner | |
role | "owner" | "editor" | "viewer" | |
orgAccess | "edit" | "view" | "none" | |
defaultAgent | string | null | |
defaultModel | string | null | |
defaultEffort | string | null | |
useGpu | boolean | |
useDocker | boolean | |
useKvm | boolean | |
deleteWorktreesWhenDone | boolean | |
closedProjectRetentionDays | ClosedProjectRetentionDays | |
autoApproveSpec | boolean | |
autoPush | boolean | |
autoOpenPr | boolean | |
prProjectContext | boolean | |
autoResume | boolean | |
verificationDepth | VerificationDepth | |
mergeQueueWaitForChecks | boolean | |
limits | WorkspaceLimits | |
historyRemote | string | null | |
logo | string | null | |
logoSource | "github" | "upload" | "file" | null | |
logoRef | string | null | |
blockCount | integer | |
repoCount | integer | |
containerCount | integer | |
agentWorking | boolean | |
head | string | null | |
lastSyncedAt | string | null | |
storageConnected | boolean | |
quickStart | QuickStart | |
archivedAt | string | null | |
updatedAt | string | |
createdAt | string |
WorkspaceAgent
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
workspaceId | string | |
provider | "claude" | "codex" | "cursor" | "grok" | "fake" | |
name | string | |
model | string | null | |
effort | string | null | |
instructions | string | null | |
enabled | boolean | |
position | integer |
WorkspaceAgentList
Fields
| Name | Type | Description |
|---|---|---|
agents | WorkspaceAgent[] |
WorkspaceApps
Fields
| Name | Type | Description |
|---|---|---|
apps | ResolvedApp[] | |
hidden | object[] | |
runsOn | HostingRunnerChoice & object | null | |
blocked | string | null | |
previews | ProjectPreview[] |
WorkspaceAppsDomain
Fields
| Name | Type | Description |
|---|---|---|
domain | string | |
runnerId | string | |
runnerName | string | |
reach | "direct" | "tunnel" | |
proxiedBy | string | null |
WorkspaceAppsRunning
Fields
| Name | Type | Description |
|---|---|---|
running | integer |
WorkspaceAppsSettings
Fields
| Name | Type | Description |
|---|---|---|
runnerId | string | null | |
runners | HostingRunnerChoice[] | |
hostedOn | object | null | |
domain | string | null | |
domains | WorkspaceAppsDomain[] | |
previewVisibility | AppVisibility |
WorkspaceLimits
Fields
| Name | Type | Description |
|---|---|---|
cpus | number | null | |
memoryMb | integer | null | |
checkMemoryMboptional | integer | null | |
shmMboptional | integer | null |
WorkspaceRepo
Fields
| Name | Type | Description |
|---|---|---|
repo | Repo | |
status | "cloning" | "ready" | "error" | |
state | "cloning" | "fetching" | "ready" | "error" | "offline" | |
error | string | null | |
progressoptional | object | null | |
errorAt | string | null | |
checkedAt | string | null | |
head | string | null | |
branch | string | |
readOnly | boolean |
WorkspaceRunner
Fields
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | |
kind | "official" | "official-pro" | "org" | "personal" | |
online | boolean | |
load | "normal" | "high" | "critical" | null | |
lastSeenAt | string | null | |
gpu | boolean | |
sandboxedDocker | boolean | |
kvm | boolean | |
personal | object | null |
WorkspaceStorage
Fields
| Name | Type | Description |
|---|---|---|
bucket | StorageBucket & object | null | |
migration | object | null | |
choices | StorageBucket[] |
WorkspaceUsage
Fields
| Name | Type | Description |
|---|---|---|
supported | boolean | |
measuredAt | string | |
boxes | object[] | |
gpu | object[] | |
disk | object | |
limits | WorkspaceLimits |
WorkspaceVault
Fields
| Name | Type | Description |
|---|---|---|
orgId | string | |
vault | VaultKey |
WriteFileBody
Fields
| Name | Type | Description |
|---|---|---|
content | string | |
baseoptional | string |
WriteFileResult
Fields
| Name | Type | Description |
|---|---|---|
ok | true | |
merged | boolean | |
conflict | FileConflict |