User guideAI Engineering Platform
Back to siteSite

Developer reference · v1.0.0

API reference

Automate projects, tasks, runs, approvals and reporting. Every endpoint below is generated from the OpenAPI contract shipped with the platform.

Authentication

All endpoints except /auth/* and /healthz require a bearer token. Obtain one with the login endpoint, then send it in the Authorization header.

TOKEN=$(curl -s -X POST http://localhost:18080/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@company.com","password":"..."}' | jq -r .access_token)

curl -H "Authorization: Bearer $TOKEN" \
  http://localhost:18080/api/v1/orgs/$ORG/projects
SchemeTypeDescription
bearerAuthhttpSend Authorization: Bearer <access token>.

Servers: /api/v1

Every path except /auth/* and /healthz is organization-scoped. Access tokens are short-lived; refresh tokens rotate.

Base URL: http://localhost:18080/api/v1 locally, or your deployment URL plus /api/v1.

Conventions: cursor pagination with limit/cursor; Idempotency-Key on mutations; errors returned as {"error":{"code","message","request_id"}}; 429 includes Retry-After. See API basics.

Operations

auth

16 operations
POST/auth/loginlogin

Request body (required): application/json object

POST/auth/refreshrefresh

Request body (required): application/json object

StatusDescriptionSchema
200New tokensTokenPair
401
GET/auth/megetMe
StatusDescriptionSchema
200ProfileMe
401
POST/auth/registerregister
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json RegisterInput

StatusDescriptionSchema
201Account created; verification email sentobject
202Email already exists (not disclosed; the owner has been emailed)Problem
POST/auth/verify-emailverifyEmail

Request body (required): application/json object

StatusDescriptionSchema
200Verifiedobject
410
POST/auth/logout-alllogoutAll
StatusDescriptionSchema
204All sessions revoked
401Missing or invalid access token

Security: bearerAuth

POST/auth/logoutlogout
StatusDescriptionSchema
204Session revoked; cookies cleared (web)
POST/auth/password/reset-requestrequestPasswordReset

Request body (required): application/json object

StatusDescriptionSchema
202Always 202 (regardless of whether the account exists)Problem
429
POST/auth/password/resetresetPassword

Request body (required): application/json object

StatusDescriptionSchema
200Password changed; all sessions revokedobject
GET/auth/invites/{token}previewInvite
ParameterInRequiredSchemaDescription
tokenpathyesstring
StatusDescriptionSchema
200InviteInvitePreview
404
POST/auth/invites/{token}/acceptacceptInvite
ParameterInRequiredSchemaDescription
tokenpathyesstring

Request body (required): application/json object

StatusDescriptionSchema
200Joined; tokens issuedTokenPair
409
GET/auth/sessionslistSessions
StatusDescriptionSchema
200Active sessionsobject
DELETE/auth/sessions/{session}revokeSession
ParameterInRequiredSchemaDescription
sessionpathyesuuid
StatusDescriptionSchema
204Revokovana
POST/auth/switch-orgswitchOrg

Request body (required): application/json object

StatusDescriptionSchema
200New access token for another active orgTokenPair
403
GET/auth/oidc/{provider}/startoidcStart
ParameterInRequiredSchemaDescription
providerpathyesobject
redirect_uriquerynostring
StatusDescriptionSchema
302Redirect to the provider (state + PKCE)
GET/auth/oidc/{provider}/callbackoidcCallback
ParameterInRequiredSchemaDescription
providerpathyesobject
codequeryyesstring
statequeryyesstring
StatusDescriptionSchema
302Redirect to the app; sets the aip_rt and aip_csrf cookies

orgs

18 operations
GET/orgslistOrgs
StatusDescriptionSchema
200The user's organizationsobject
POST/orgscreateOrg
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
201CreatedOrg
409
GET/orgs/{org}getOrg
StatusDescriptionSchema
200DetailsOrg
404
PATCH/orgs/{org}updateOrg

Request body (required): application/json object

StatusDescriptionSchema
200UpdatedOrg
DELETE/orgs/{org}deleteOrg

Request body (required): application/json object

StatusDescriptionSchema
204Deleted
GET/orgs/{org}/memberslistMembers
StatusDescriptionSchema
200Membersobject
POST/orgs/{org}/membersinviteMember
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
201Invite sentMember
409
GET/orgs/{org}/providerslistProviders

Never returns secrets; only has_key.

StatusDescriptionSchema
200Providersobject
POST/orgs/{org}/providerscreateProvider
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
201CreatedProvider
GET/orgs/{org}/notificationslistNotifications
ParameterInRequiredSchemaDescription
unreadquerynoboolean
noobject
StatusDescriptionSchema
200Notificationsobject
POST/orgs/{org}/notifications/readmarkNotificationsRead

Request body (required): application/json object

StatusDescriptionSchema
204Marked as read"
GET/orgs/{org}/model-priceslistModelPrices
StatusDescriptionSchema
200Model prices (USD per 1K tokens)object
PUT/orgs/{org}/model-pricesupsertModelPrice

Request body (required): application/json object

StatusDescriptionSchema
200Saved
400
POST/orgs/{org}/providers/{provider}/rotaterotateProviderKey

Request body (required): application/json object

StatusDescriptionSchema
200Key replaced (old ciphertext is overwritten)Provider
400
PATCH/orgs/{org}/providers/{provider}setProviderEnabled

Request body (required): application/json object

StatusDescriptionSchema
200UpdatedProvider
DELETE/orgs/{org}/providers/{provider}deleteProvider
StatusDescriptionSchema
204Deleted with its key
404
PATCH/orgs/{org}/members/{user}updateMemberRole

Request body (required): application/json object

StatusDescriptionSchema
204Role changed
400
DELETE/orgs/{org}/members/{user}removeMember
StatusDescriptionSchema
204Member removed
400

assistant

5 operations
GET/orgs/{org}/assistant/conversations

The user's recent assistant conversations

ParameterInRequiredSchemaDescription
orgpathyesuuid
StatusDescriptionSchema
200The conversations, newest firstobject
401Not signed inProblem

Security: bearerAuth

DELETE/orgs/{org}/assistant/conversations

Delete all of the user's conversations

ParameterInRequiredSchemaDescription
orgpathyesuuid
StatusDescriptionSchema
204Deleted
401Not signed inProblem

Security: bearerAuth

GET/orgs/{org}/assistant/conversations/{conversation}

One conversation's messages

ParameterInRequiredSchemaDescription
orgpathyesuuid
conversationpathyesuuid
StatusDescriptionSchema
200The messages in orderobject
401Not signed inProblem

Security: bearerAuth

DELETE/orgs/{org}/assistant/conversations/{conversation}

Delete one conversation (the owner only)

ParameterInRequiredSchemaDescription
orgpathyesuuid
conversationpathyesuuid
StatusDescriptionSchema
204Deleted
401Not signed inProblem

Security: bearerAuth

POST/orgs/{org}/assistant/messages

Ask the assistant (JSON or SSE)

Answers one message with the tool loop over the platform. Writes (create a task, retry, cancel) are proposed as a preview and run only when confirm is true. Accept text/event-stream to receive the answer as the text/pending and done events.

ParameterInRequiredSchemaDescription
orgpathyesuuid

Request body (required): application/json AssistantMessageInput

StatusDescriptionSchema
200The answer (JSON) or the same fields as SSE events.AssistantMessageOutput
400The prompt is empty or a validation errorProblem
401Not signed inProblem

Security: bearerAuth

projects

31 operations
GET/orgs/{org}/projectslistProjects
ParameterInRequiredSchemaDescription
noobject
noobject
statusquerynostring
StatusDescriptionSchema
200Listobject
POST/orgs/{org}/projectscreateProject
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json ProjectInput

StatusDescriptionSchema
201CreatedProject
400
GET/orgs/{org}/projects/{project}getProject
StatusDescriptionSchema
200DetailsProject
404
DELETE/orgs/{org}/projects/{project}archiveProject
StatusDescriptionSchema
204Arhiviran
PUT/orgs/{org}/projects/{project}/test-commandsetProjectTestCommand

Stores the project test command. An empty string means the project uses the global AIP_TEST_COMMAND.

Request body (required): application/json object

StatusDescriptionSchema
200The updated projectProject
400
404
GET/orgs/{org}/projects/{project}/reposlistRepos
StatusDescriptionSchema
200Repositoriesobject
POST/orgs/{org}/projects/{project}/reposconnectRepo
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
201ConnectedRepo
409
GET/orgs/{org}/projects/{project}/repos/{repo}/credentialgetRepoCredential

Reports whether the repository has its own git credential. The token itself is never returned.

StatusDescriptionSchema
200Credential statusRepoCredential
404
PUT/orgs/{org}/projects/{project}/repos/{repo}/credentialsetRepoCredential

Stores an encrypted per-repository token (owner/admin only). Resolution order is: repository credential, GitHub App installation token, global provider token.

Request body (required): application/json object

StatusDescriptionSchema
200StoredRepoCredential
400
403
404
DELETE/orgs/{org}/projects/{project}/repos/{repo}/credentialdeleteRepoCredential

Removes the repository credential and falls back to the GitHub App or global token.

StatusDescriptionSchema
204Removed
403
404
GET/orgs/{org}/repos/{repo}/pull-requestslistPullRequests
StatusDescriptionSchema
200Pull requestsobject
GET/orgs/{org}/pull-requests/{pr}getPullRequest
StatusDescriptionSchema
200Details sa checks, fajlovima i review nalazimaPullRequestDetail
404
GET/orgs/{org}/projects/{project}/testslistTestResults
ParameterInRequiredSchemaDescription
noobject
noobject
runquerynouuid
StatusDescriptionSchema
200Test resultsobject
GET/orgs/{org}/design-systemslistDesignSystems
StatusDescriptionSchema
200Listobject
POST/orgs/{org}/design-systemscreateDesignSystem
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
201CreatedDesignSystem
POST/orgs/{org}/design-systems/{ds}/versionspublishDesignSystemVersion
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
201Published (immutable)DesignSystemVersion
409
POST/orgs/{org}/pull-requests/{pr}/mergemergePullRequest

Human action. Requires green required checks and an approved review.

ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
200Merge performed; the task moves to donePullRequest
409
403
POST/orgs/{org}/pull-requests/{pr}/findings/{finding}/waivewaiveFinding
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
200Waived (audit record)object
403
POST/orgs/{org}/blueprints/{blueprint}/versionscreateBlueprintVersion

Clone a blueprint into the next draft version.

Request body: application/json object

StatusDescriptionSchema
201New draft versionBlueprint
400
GET/orgs/{org}/projects/{project}/pull-requestslistProjectPullRequests
StatusDescriptionSchema
200Pull/merge requests opened for the projectobject
GET/orgs/{org}/reposlistOrgRepos
StatusDescriptionSchema
200Connected repositories across the workspaceobject
GET/orgs/{org}/projects/{project}/componentslistProjectComponents
StatusDescriptionSchema
200Allowed components for the projectobject
PUT/orgs/{org}/projects/{project}/componentssetProjectComponents

Request body (required): application/json object

StatusDescriptionSchema
200Allowlist replacedobject
400
GET/orgs/{org}/projects/{project}/standardsgetProjectStandard
StatusDescriptionSchema
200The assigned design standard (or null)object
PUT/orgs/{org}/projects/{project}/standardssetProjectStandard

Request body (required): application/json object

StatusDescriptionSchema
200Updated projectProject
400
PUT/orgs/{org}/projects/{project}/required-checksupdateProjectRequiredChecks

Checks that must pass before a pull request can be merged.

Request body (required): application/json object

StatusDescriptionSchema
200Updated projectProject
400
GET/orgs/{org}/design-standardslistDesignStandards
StatusDescriptionSchema
200Design standards with their versionsobject
POST/orgs/{org}/design-standardscreateDesignStandard

Request body (required): application/json object

StatusDescriptionSchema
201Created draft versionDesignStandard
400
GET/orgs/{org}/design-standards/{standard}getDesignStandard
StatusDescriptionSchema
200One versionDesignStandard
404
POST/orgs/{org}/design-standards/{standard}/versionscreateDesignStandardVersion

Request body: application/json object

StatusDescriptionSchema
201Next draft versionDesignStandard
POST/orgs/{org}/design-standards/{standard}/publishpublishDesignStandard
StatusDescriptionSchema
200Published versionDesignStandard

tasks

7 operations
GET/orgs/{org}/projects/{project}/taskslistTasks
ParameterInRequiredSchemaDescription
noobject
noobject
statusquerynoTaskStatus
assigneequerynouuid
sortquerynostring
StatusDescriptionSchema
200Listobject
POST/orgs/{org}/projects/{project}/taskscreateTask
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json TaskInput

StatusDescriptionSchema
201CreatedTask
400
GET/orgs/{org}/projects/{project}/tasks/{task}getTask
StatusDescriptionSchema
200DetailsTask
404
PATCH/orgs/{org}/projects/{project}/tasks/{task}updateTask

Request body (required): application/json TaskInput

StatusDescriptionSchema
200UpdatedTask
POST/orgs/{org}/projects/{project}/tasks/{task}/transitionstransitionTask
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
200New statusTask
409
GET/orgs/{org}/projects/{project}/tasks/{task}/commentslistComments
StatusDescriptionSchema
200Listobject
POST/orgs/{org}/projects/{project}/tasks/{task}/commentscreateComment
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
201CreatedComment

runs

13 operations
POST/orgs/{org}/tasks/{task}/runsstartRun
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json RunInput

StatusDescriptionSchema
202AcceptedRun
409
429
GET/orgs/{org}/runslistRuns
ParameterInRequiredSchemaDescription
noobject
noobject
statusquerynoRunStatus
agent_typequerynoAgentType
StatusDescriptionSchema
200Listobject
GET/orgs/{org}/runs/{run}getRun
StatusDescriptionSchema
200DetailsRunDetail
404
POST/orgs/{org}/runs/{run}/cancelcancelRun
ParameterInRequiredSchemaDescription
noobject
StatusDescriptionSchema
202Cancellation requestedRun
409
POST/orgs/{org}/runs/{run}/retryretryRun

Starts a new development run with the failed run's approved plan. No planning run and no new plan approval are needed; the task returns to in_progress and the new run is queued.

ParameterInRequiredSchemaDescription
noobject
StatusDescriptionSchema
202A new development run was queued with the same planRun
400
404
409
POST/orgs/{org}/runs/{run}/fix-reviewfixReviewRun

Starts a development run that fixes the blocker findings of a finished review on the existing pull request: the same approved plan and branch; the review re-runs after the fix.

ParameterInRequiredSchemaDescription
noobject
StatusDescriptionSchema
202A fix development run was queuedRun
400
404
409
POST/orgs/{org}/pull-requests/{pr}/checks/{check}/fixfixFailedCheck

Starts a development run that fixes a failed CI check on the existing pull request: the same approved plan and branch, with the check log in the prompt.

ParameterInRequiredSchemaDescription
noobject
StatusDescriptionSchema
202A fix development run was queuedRun
400
404
409
GET/orgs/{org}/runs/{run}/eventsstreamRunEvents

Server-Sent Events. First a backfill from run_events (from Last-Event-ID), then live. Event catalog: docs/api/events.md.

ParameterInRequiredSchemaDescription
Last-Event-IDheadernointeger
StatusDescriptionSchema
200Streamstring
404
GET/orgs/{org}/runs/{run}/diffgetRunDiff
StatusDescriptionSchema
200Unified diffstring
404
GET/orgs/{org}/projects/{project}/tasks/{task}/runslistTaskRuns
StatusDescriptionSchema
200Runs of the task, newest firstobject
POST/orgs/{org}/projects/{project}/tasks/{task}/runsstartTaskRun
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
202AcceptedRun
409
GET/orgs/{org}/runs/{run}/usagegetRunUsage
StatusDescriptionSchema
200Token usage and cost of one runobject
GET/orgs/{org}/runs/{run}/artifactslistRunArtifacts
StatusDescriptionSchema
200Artifacts stored in the object storeobject

approvals

2 operations
GET/orgs/{org}/approvalslistApprovals
ParameterInRequiredSchemaDescription
noobject
noobject
statusquerynoApprovalStatus
StatusDescriptionSchema
200Listobject
POST/orgs/{org}/approvals/{approval}/decisiondecideApproval
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
200Decision recordedApproval
403
409

design

9 operations
GET/orgs/{org}/componentslistComponentEntries
StatusDescriptionSchema
200Component registryobject
POST/orgs/{org}/componentscreateComponentEntry

Request body (required): application/json ComponentEntryInput

StatusDescriptionSchema
201Created
PUT/orgs/{org}/components/{component}updateComponentEntry

Request body (required): application/json ComponentEntryInput

StatusDescriptionSchema
200Updated
DELETE/orgs/{org}/components/{component}deleteComponentEntry
StatusDescriptionSchema
204Deleted
GET/orgs/{org}/design-tokenslistDesignTokens
StatusDescriptionSchema
200Org design tokensobject
POST/orgs/{org}/design-tokenscreateDesignToken

Request body (required): application/json DesignTokenInput

StatusDescriptionSchema
201CreatedDesignToken
PUT/orgs/{org}/design-tokens/{token}updateDesignToken

Request body (required): application/json DesignTokenInput

StatusDescriptionSchema
200Updated
DELETE/orgs/{org}/design-tokens/{token}deleteDesignToken
StatusDescriptionSchema
204Deleted
POST/orgs/{org}/design/seedseedDesignRegistry

Inserts the built-in baseline when the registry is empty.

StatusDescriptionSchema
200Created countsobject

analytics

5 operations
GET/orgs/{org}/searchsearch
ParameterInRequiredSchemaDescription
qqueryyesstring
noobject
StatusDescriptionSchema
200Rezultati po tipuobject
GET/orgs/{org}/activitylistActivity
ParameterInRequiredSchemaDescription
noobject
noobject
StatusDescriptionSchema
200Activity feedobject
GET/orgs/{org}/analytics/summarygetAnalyticsSummary
ParameterInRequiredSchemaDescription
fromquerynodate
toquerynodate
projectquerynouuid
StatusDescriptionSchema
200KPI sa sourceAnalyticsSummary
GET/orgs/{org}/usagegetUsage
ParameterInRequiredSchemaDescription
fromquerynodate
toquerynodate
group_byquerynostring
StatusDescriptionSchema
200UsageUsageReport
GET/orgs/{org}/metricsgetMetrics
ParameterInRequiredSchemaDescription
daysquerynointeger
StatusDescriptionSchema
200Delivery metricsMetricsSummary

environments

6 operations
GET/orgs/{org}/deployments/{deployment}/logsgetDeploymentLogs
StatusDescriptionSchema
200NDJSON linijestring
404
GET/orgs/{org}/projects/{project}/environmentslistEnvironments
StatusDescriptionSchema
200Listobject
POST/orgs/{org}/projects/{project}/environmentscreateEnvironment

Request body (required): application/json object

StatusDescriptionSchema
201CreatedoEnvironment
GET/orgs/{org}/environments/{environment}/deploymentslistDeployments
StatusDescriptionSchema
200Deployments of the environment, newest firstobject
POST/orgs/{org}/environments/{environment}/deploymentscreateDeployment
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
202Deploy acceptedDeployment
POST/orgs/{org}/deployments/{deployment}/approveapproveDeployment

Four-eyes gate for prod; the approver must differ from the requester.

StatusDescriptionSchema
200Approved and deployedDeployment
409

blueprints

4 operations
GET/orgs/{org}/blueprintslistBlueprints
StatusDescriptionSchema
200Listobject
POST/orgs/{org}/blueprintscreateBlueprint
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
201CreatedBlueprint
POST/orgs/{org}/blueprints/{blueprint}/publishpublishBlueprint
StatusDescriptionSchema
200Published (immutable from now on)Blueprint
409
POST/orgs/{org}/blueprints/{blueprint}/instantiateinstantiateBlueprint
StatusDescriptionSchema
201Project created from the blueprint (plus its starter tasks)object
409

rules

7 operations
GET/orgs/{org}/ruleslistRules
ParameterInRequiredSchemaDescription
projectquerynouuid
StatusDescriptionSchema
200List (sa aktivnom verzijom)object
POST/orgs/{org}/rulescreateRule

Request body (required): application/json object

StatusDescriptionSchema
201Rule created with draft version 1Rule
400
GET/orgs/{org}/rules/{rule}/versionslistRuleVersions
StatusDescriptionSchema
200Versions, newest firstobject
POST/orgs/{org}/rules/{rule}/versionssaveRuleDraft

Request body (required): application/json object

StatusDescriptionSchema
201New draft version
POST/orgs/{org}/rules/{rule}/versions/{version}/publishpublishRuleVersion

Requests publication; a second admin must approve it (four eyes).

StatusDescriptionSchema
202Publish request createdobject
409
GET/orgs/{org}/rules/approvalslistRulePublishApprovals
StatusDescriptionSchema
200Pending rule publicationsobject
POST/orgs/{org}/rules/approvals/{approval}/decidedecideRulePublishApproval

Request body (required): application/json object

StatusDescriptionSchema
200Decided (and published when approved)
400

audit

1 operations
GET/orgs/{org}/auditlistAudit
ParameterInRequiredSchemaDescription
noobject
noobject
actionquerynostring
actorquerynouuid
StatusDescriptionSchema
200Audit zapisiobject

meta

3 operations
GET/healthzhealthz
StatusDescriptionSchema
200Process is aliveobject
GET/readyzreadyz
StatusDescriptionSchema
200Ready to serve trafficobject
503Dependency unavailable
GET/versionversion
StatusDescriptionSchema
200Build informationobject

invites

4 operations
GET/orgs/{org}/inviteslistInvites
StatusDescriptionSchema
200Invitesobject
POST/orgs/{org}/invitescreateInvite
ParameterInRequiredSchemaDescription
noobject

Request body (required): application/json object

StatusDescriptionSchema
201Invite created; the token is returned onceobject
400
POST/orgs/{org}/invites/acceptacceptOrgInvite

Request body (required): application/json object

StatusDescriptionSchema
200Membership createdobject
400
409
POST/invites/acceptregisterAndAcceptInvite

Accepts an invite for a user without an existing account: creates the user, adds the membership and returns a session.

Request body (required): application/json object

StatusDescriptionSchema
201Account created and signed inTokenPair
400
409

webhooks

2 operations
POST/webhooks/github/{repo}githubWebhook

Verified with X-Hub-Signature-256 using the repo secret.

Request body (required): application/json object

StatusDescriptionSchema
202Accepted
401
POST/webhooks/gitlab/{repo}gitlabWebhook

Verified with X-Gitlab-Token using the repo secret.

Request body (required): application/json object

StatusDescriptionSchema
202Accepted
401

git

2 operations
GET/orgs/{org}/pull-requests/{pr}/checkslistPullRequestChecks
StatusDescriptionSchema
200CI checks recorded for the pull requestobject
GET/orgs/{org}/runs/{run}/checkslistRunChecks
StatusDescriptionSchema
200CI checks recorded for the runobject

Schemas

64 definitions
Problem7 fields
FieldTypeDescription
type *uri
title *string
status *integer
detailstring
instancestring
code *string
fieldsarray<object>
TokenPair3 fields
FieldTypeDescription
access_token *string
refresh_token *string
expires_in *integerseconds
Me2 fields
FieldTypeDescription
userUser
orgsarray<object>
User4 fields
FieldTypeDescription
iduuid
emailemail
namestring
avatar_url['string', 'null']
OrgRole0 fields

No object properties.

Org5 fields
FieldTypeDescription
iduuid
slugstring
namestring
max_concurrent_runsinteger
created_atdate-time
ProjectInput4 fields
FieldTypeDescription
name *string
descriptionstring
blueprint_id['string', 'null']
tech_stackarray<string>
Project0 fields

No object properties.

TaskStatus0 fields

No object properties.

TaskPriority0 fields

No object properties.

AssistantConversation3 fields
FieldTypeDescription
iduuid
titlestring
updated_atdate-time
AssistantMessage5 fields
FieldTypeDescription
iduuid
rolestring
contentstring
tool_namestring
created_atdate-time
AssistantMessageInput5 fields
FieldTypeDescription
conversation_iduuid
prompt *string
confirmboolean
contextstringThe user's current UI (the route and the open drawer).
imagesarray<string>The attached images as data URLs (the model reads them).
AssistantMessageOutput3 fields
FieldTypeDescription
conversation_iduuid
textstring
pending_toolstring
AcceptanceCriterion3 fields
FieldTypeDescription
given *string
when *string
then *string
TaskInput11 fields
FieldTypeDescription
title *string
descriptionstring
acceptancearray<AcceptanceCriterion>
priorityTaskPriority
tagsarray<string>
assignee_id['string', 'null']
depends_onarray<string>
filesarray<string>
out_of_scopearray<string>
test_planarray<string>
rollbackarray<string>
Task0 fields

No object properties.

AgentType0 fields

No object properties.

RunStatus0 fields

No object properties.

PhaseName0 fields

No object properties.

Phase5 fields
FieldTypeDescription
phasePhaseName
statestring
attemptinteger
started_at['string', 'null']
ended_at['string', 'null']
Budget4 fields
FieldTypeDescription
tokens_ininteger
tokens_outinteger
cost_microsinteger
wall_clock_sinteger
RunInput4 fields
FieldTypeDescription
agent_type *AgentType
model *string
dry_runboolean
budgetBudget
Run13 fields
FieldTypeDescription
iduuid
statusRunStatus
agent_typeAgentType
modelstring
task_id['string', 'null']
project_iduuid
current_phasePhaseName
spentobject
budgetBudget
failure_code['string', 'null']
started_at['string', 'null']
finished_at['string', 'null']
created_atdate-time
RunDetail0 fields

No object properties.

DiffSummary4 fields
FieldTypeDescription
filesinteger
additionsinteger
deletionsinteger
artifact_urluri
ApprovalStatus0 fields

No object properties.

Approval8 fields
FieldTypeDescription
iduuid
run_id['string', 'null']
typestring
statusApprovalStatus
requested_atdate-time
decided_at['string', 'null']
decided_by['string', 'null']
reason['string', 'null']
Blueprint4 fields
FieldTypeDescription
iduuid
namestring
latest_version['string', 'null']
published_at['string', 'null']
Rule5 fields
FieldTypeDescription
iduuid
levelstring
namestring
active_version['integer', 'null']
updated_at['string', 'null']
Environment3 fields
FieldTypeDescription
iduuid
namestring
url['string', 'null']
Deployment5 fields
FieldTypeDescription
iduuid
environment_iduuid
release_refstring
statusstring
created_atdate-time
Kpi4 fields
FieldTypeDescription
keystring
valuenumber
unit['string', 'null']
sourcestring
AnalyticsSummary4 fields
FieldTypeDescription
fromdate
todate
kpisarray<Kpi>
seriesarray<object>
UsageReport4 fields
FieldTypeDescription
total_cost_microsinteger
total_tokens_ininteger
total_tokens_outinteger
groupsarray<object>
AuditEntry7 fields
FieldTypeDescription
idinteger
actionstring
actor_id['string', 'null']
actor_kindstring
targetstring
metadataobject
created_atdate-time
Member5 fields
FieldTypeDescription
user_iduuid
emailemail
namestring
roleOrgRole
last_active_at['string', 'null']
Provider8 fields
FieldTypeDescription
iduuid
namestring
base_urluri
enabledboolean
modelstring
kindstring
key_hintstringlast characters of the stored key, never the key
has_keybooleantrue if a secret is set (never returned)
Repo6 fields
FieldTypeDescription
iduuid
providerstring
full_namestring
default_branchstring
open_prsinteger
last_sync_at['string', 'null']
RepoCredential3 fields
FieldTypeDescription
configuredboolean
hintstringLast four characters of the token; never the token itself.
updated_at['string', 'null']
Check3 fields
FieldTypeDescription
namestring
statestring
meta['string', 'null']
PullRequest9 fields
FieldTypeDescription
iduuid
numberinteger
titlestring
urluri
headstring
basestring
statestring
checks_summaryobject
updated_atdate-time
PullRequestDetail0 fields

No object properties.

TestSummary9 fields
FieldTypeDescription
iduuid
suitestring
totalinteger
passedinteger
failedinteger
skippedinteger
coverage_pct['number', 'null']
commit_sha['string', 'null']
created_atdate-time
DesignSystem3 fields
FieldTypeDescription
iduuid
namestring
latest_version['string', 'null']
DesignSystemVersion5 fields
FieldTypeDescription
iduuid
design_system_iduuid
versionstring
published_at['string', 'null']
sha256string
Component12 fields
FieldTypeDescription
iduuid
namestring
slugstring
categorystring
latest_version['string', 'null']
status['string', 'null']
frameworkstring
packagestring
import_pathstring
versionstring
docsstring
examplestring
ComponentVersion6 fields
FieldTypeDescription
iduuid
versionstring
statusstring
propsarray<object>
a11y_notes['string', 'null']
ai_notes['string', 'null']
Comment5 fields
FieldTypeDescription
iduuid
task_iduuid
author_id['string', 'null']
bodystring
created_atdate-time
Notification7 fields
FieldTypeDescription
iduuid
kindstring
titlestring
bodystring
target['string', 'null']
read_at['string', 'null']
created_atdate-time
SearchResult5 fields
FieldTypeDescription
typeobject
idstring
titlestring
subtitle['string', 'null']
urlstring
ActivityItem5 fields
FieldTypeDescription
idinteger
actionstring
actor['string', 'null']
targetstring
created_atdate-time
RegisterInput4 fields
FieldTypeDescription
email *email
password *string
name *string
org_namestring
InvitePreview4 fields
FieldTypeDescription
org_namestring
emailemail
roleOrgRole
expires_atdate-time
Session7 fields
FieldTypeDescription
iduuid
platformstring
ip['string', 'null']
user_agent['string', 'null']
last_used_at['string', 'null']
created_atdate-time
currentboolean
Invite5 fields
FieldTypeDescription
id *uuid
email *email
role *string
expires_at *date-time
accepted_at['string', 'null']
MetricsSummary8 fields
FieldTypeDescription
days *integer
runs_by_status *object
succeeded_runs *integer
lead_time_minutes *Metric
approval_minutes *Metric
runs_per_task *Metric
merged_pull_requests *integer
cost_usd *Metric
Metric3 fields
FieldTypeDescription
value *number
unit *string
source *string
DesignToken4 fields
FieldTypeDescription
iduuid
namestring
valuestring
categorystring
DesignTokenInput3 fields
FieldTypeDescription
name *string
value *string
categorystring
ComponentEntry5 fields
FieldTypeDescription
iduuid
namestring
purposestring
rulesstring
statusstring
ComponentEntryInput4 fields
FieldTypeDescription
name *string
purposestring
rulesstring
statusstring
CheckResult5 fields
FieldTypeDescription
namestring
statusstring
outputstring
duration_msinteger
commit_shastring
DesignStandard8 fields
FieldTypeDescription
iduuid
namestring
versioninteger
statusstring
specobject
sha256string
published_at['string', 'null']
created_atdate-time