User guide / API reference
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
| Scheme | Type | Description |
|---|
bearerAuth | http | Send 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.
auth
16 operations
POST/auth/loginlogin
Request body (required): application/json object
POST/auth/refreshrefresh
Request body (required): application/json object
| Status | Description | Schema |
200 | New tokens | TokenPair |
401 | | |
GET/auth/megetMe
| Status | Description | Schema |
200 | Profile | Me |
401 | | |
POST/auth/registerregister
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json RegisterInput
| Status | Description | Schema |
201 | Account created; verification email sent | object |
202 | Email already exists (not disclosed; the owner has been emailed) | Problem |
POST/auth/verify-emailverifyEmail
Request body (required): application/json object
| Status | Description | Schema |
200 | Verified | object |
410 | | |
POST/auth/logout-alllogoutAll
| Status | Description | Schema |
204 | All sessions revoked | |
401 | Missing or invalid access token | |
Security: bearerAuth
POST/auth/logoutlogout
| Status | Description | Schema |
204 | Session revoked; cookies cleared (web) | |
POST/auth/password/reset-requestrequestPasswordReset
Request body (required): application/json object
| Status | Description | Schema |
202 | Always 202 (regardless of whether the account exists) | Problem |
429 | | |
POST/auth/password/resetresetPassword
Request body (required): application/json object
| Status | Description | Schema |
200 | Password changed; all sessions revoked | object |
GET/auth/invites/{token}previewInvite
| Parameter | In | Required | Schema | Description |
token | path | yes | string | |
POST/auth/invites/{token}/acceptacceptInvite
| Parameter | In | Required | Schema | Description |
token | path | yes | string | |
Request body (required): application/json object
| Status | Description | Schema |
200 | Joined; tokens issued | TokenPair |
409 | | |
GET/auth/sessionslistSessions
| Status | Description | Schema |
200 | Active sessions | object |
DELETE/auth/sessions/{session}revokeSession
| Parameter | In | Required | Schema | Description |
session | path | yes | uuid | |
| Status | Description | Schema |
204 | Revokovana | |
POST/auth/switch-orgswitchOrg
Request body (required): application/json object
| Status | Description | Schema |
200 | New access token for another active org | TokenPair |
403 | | |
GET/auth/oidc/{provider}/startoidcStart
| Parameter | In | Required | Schema | Description |
provider | path | yes | object | |
redirect_uri | query | no | string | |
| Status | Description | Schema |
302 | Redirect to the provider (state + PKCE) | |
GET/auth/oidc/{provider}/callbackoidcCallback
| Parameter | In | Required | Schema | Description |
provider | path | yes | object | |
code | query | yes | string | |
state | query | yes | string | |
| Status | Description | Schema |
302 | Redirect to the app; sets the aip_rt and aip_csrf cookies | |
orgs
18 operations
GET/orgslistOrgs
| Status | Description | Schema |
200 | The user's organizations | object |
POST/orgscreateOrg
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
| Status | Description | Schema |
201 | Created | Org |
409 | | |
GET/orgs/{org}getOrg
| Status | Description | Schema |
200 | Details | Org |
404 | | |
PATCH/orgs/{org}updateOrg
Request body (required): application/json object
| Status | Description | Schema |
200 | Updated | Org |
DELETE/orgs/{org}deleteOrg
Request body (required): application/json object
| Status | Description | Schema |
204 | Deleted | |
GET/orgs/{org}/memberslistMembers
| Status | Description | Schema |
200 | Members | object |
POST/orgs/{org}/membersinviteMember
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
| Status | Description | Schema |
201 | Invite sent | Member |
409 | | |
GET/orgs/{org}/providerslistProviders
Never returns secrets; only has_key.
| Status | Description | Schema |
200 | Providers | object |
POST/orgs/{org}/providerscreateProvider
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
| Status | Description | Schema |
201 | Created | Provider |
GET/orgs/{org}/notificationslistNotifications
| Parameter | In | Required | Schema | Description |
unread | query | no | boolean | |
| | no | object | |
| Status | Description | Schema |
200 | Notifications | object |
POST/orgs/{org}/notifications/readmarkNotificationsRead
Request body (required): application/json object
| Status | Description | Schema |
204 | Marked as read" | |
GET/orgs/{org}/model-priceslistModelPrices
| Status | Description | Schema |
200 | Model prices (USD per 1K tokens) | object |
PUT/orgs/{org}/model-pricesupsertModelPrice
Request body (required): application/json object
| Status | Description | Schema |
200 | Saved | |
400 | | |
POST/orgs/{org}/providers/{provider}/rotaterotateProviderKey
Request body (required): application/json object
| Status | Description | Schema |
200 | Key replaced (old ciphertext is overwritten) | Provider |
400 | | |
PATCH/orgs/{org}/providers/{provider}setProviderEnabled
Request body (required): application/json object
| Status | Description | Schema |
200 | Updated | Provider |
DELETE/orgs/{org}/providers/{provider}deleteProvider
| Status | Description | Schema |
204 | Deleted with its key | |
404 | | |
PATCH/orgs/{org}/members/{user}updateMemberRole
Request body (required): application/json object
| Status | Description | Schema |
204 | Role changed | |
400 | | |
DELETE/orgs/{org}/members/{user}removeMember
| Status | Description | Schema |
204 | Member removed | |
400 | | |
assistant
5 operations
GET/orgs/{org}/assistant/conversations
The user's recent assistant conversations
| Parameter | In | Required | Schema | Description |
org | path | yes | uuid | |
| Status | Description | Schema |
200 | The conversations, newest first | object |
401 | Not signed in | Problem |
Security: bearerAuth
DELETE/orgs/{org}/assistant/conversations
Delete all of the user's conversations
| Parameter | In | Required | Schema | Description |
org | path | yes | uuid | |
| Status | Description | Schema |
204 | Deleted | |
401 | Not signed in | Problem |
Security: bearerAuth
GET/orgs/{org}/assistant/conversations/{conversation}
One conversation's messages
| Parameter | In | Required | Schema | Description |
org | path | yes | uuid | |
conversation | path | yes | uuid | |
| Status | Description | Schema |
200 | The messages in order | object |
401 | Not signed in | Problem |
Security: bearerAuth
DELETE/orgs/{org}/assistant/conversations/{conversation}
Delete one conversation (the owner only)
| Parameter | In | Required | Schema | Description |
org | path | yes | uuid | |
conversation | path | yes | uuid | |
| Status | Description | Schema |
204 | Deleted | |
401 | Not signed in | Problem |
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.
| Parameter | In | Required | Schema | Description |
org | path | yes | uuid | |
Request body (required): application/json AssistantMessageInput
Security: bearerAuth
projects
31 operations
GET/orgs/{org}/projectslistProjects
| Parameter | In | Required | Schema | Description |
| | no | object | |
| | no | object | |
status | query | no | string | |
| Status | Description | Schema |
200 | List | object |
POST/orgs/{org}/projectscreateProject
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json ProjectInput
| Status | Description | Schema |
201 | Created | Project |
400 | | |
GET/orgs/{org}/projects/{project}getProject
| Status | Description | Schema |
200 | Details | Project |
404 | | |
DELETE/orgs/{org}/projects/{project}archiveProject
| Status | Description | Schema |
204 | Arhiviran | |
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
| Status | Description | Schema |
200 | The updated project | Project |
400 | | |
404 | | |
GET/orgs/{org}/projects/{project}/reposlistRepos
| Status | Description | Schema |
200 | Repositories | object |
POST/orgs/{org}/projects/{project}/reposconnectRepo
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
| Status | Description | Schema |
201 | Connected | Repo |
409 | | |
GET/orgs/{org}/projects/{project}/repos/{repo}/credentialgetRepoCredential
Reports whether the repository has its own git credential. The token itself is never returned.
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
DELETE/orgs/{org}/projects/{project}/repos/{repo}/credentialdeleteRepoCredential
Removes the repository credential and falls back to the GitHub App or global token.
| Status | Description | Schema |
204 | Removed | |
403 | | |
404 | | |
GET/orgs/{org}/repos/{repo}/pull-requestslistPullRequests
| Status | Description | Schema |
200 | Pull requests | object |
GET/orgs/{org}/pull-requests/{pr}getPullRequest
| Status | Description | Schema |
200 | Details sa checks, fajlovima i review nalazima | PullRequestDetail |
404 | | |
GET/orgs/{org}/projects/{project}/testslistTestResults
| Parameter | In | Required | Schema | Description |
| | no | object | |
| | no | object | |
run | query | no | uuid | |
| Status | Description | Schema |
200 | Test results | object |
GET/orgs/{org}/design-systemslistDesignSystems
| Status | Description | Schema |
200 | List | object |
POST/orgs/{org}/design-systemscreateDesignSystem
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
POST/orgs/{org}/design-systems/{ds}/versionspublishDesignSystemVersion
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
POST/orgs/{org}/pull-requests/{pr}/mergemergePullRequest
Human action. Requires green required checks and an approved review.
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
| Status | Description | Schema |
200 | Merge performed; the task moves to done | PullRequest |
409 | | |
403 | | |
POST/orgs/{org}/pull-requests/{pr}/findings/{finding}/waivewaiveFinding
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
| Status | Description | Schema |
200 | Waived (audit record) | object |
403 | | |
POST/orgs/{org}/blueprints/{blueprint}/versionscreateBlueprintVersion
Clone a blueprint into the next draft version.
Request body: application/json object
| Status | Description | Schema |
201 | New draft version | Blueprint |
400 | | |
GET/orgs/{org}/projects/{project}/pull-requestslistProjectPullRequests
| Status | Description | Schema |
200 | Pull/merge requests opened for the project | object |
GET/orgs/{org}/reposlistOrgRepos
| Status | Description | Schema |
200 | Connected repositories across the workspace | object |
GET/orgs/{org}/projects/{project}/componentslistProjectComponents
| Status | Description | Schema |
200 | Allowed components for the project | object |
PUT/orgs/{org}/projects/{project}/componentssetProjectComponents
Request body (required): application/json object
| Status | Description | Schema |
200 | Allowlist replaced | object |
400 | | |
GET/orgs/{org}/projects/{project}/standardsgetProjectStandard
| Status | Description | Schema |
200 | The assigned design standard (or null) | object |
PUT/orgs/{org}/projects/{project}/standardssetProjectStandard
Request body (required): application/json object
| Status | Description | Schema |
200 | Updated project | Project |
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
| Status | Description | Schema |
200 | Updated project | Project |
400 | | |
GET/orgs/{org}/design-standardslistDesignStandards
| Status | Description | Schema |
200 | Design standards with their versions | object |
POST/orgs/{org}/design-standardscreateDesignStandard
Request body (required): application/json object
GET/orgs/{org}/design-standards/{standard}getDesignStandard
POST/orgs/{org}/design-standards/{standard}/versionscreateDesignStandardVersion
Request body: application/json object
POST/orgs/{org}/design-standards/{standard}/publishpublishDesignStandard
tasks
7 operations
GET/orgs/{org}/projects/{project}/taskslistTasks
| Parameter | In | Required | Schema | Description |
| | no | object | |
| | no | object | |
status | query | no | TaskStatus | |
assignee | query | no | uuid | |
sort | query | no | string | |
| Status | Description | Schema |
200 | List | object |
POST/orgs/{org}/projects/{project}/taskscreateTask
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json TaskInput
| Status | Description | Schema |
201 | Created | Task |
400 | | |
GET/orgs/{org}/projects/{project}/tasks/{task}getTask
| Status | Description | Schema |
200 | Details | Task |
404 | | |
PATCH/orgs/{org}/projects/{project}/tasks/{task}updateTask
Request body (required): application/json TaskInput
| Status | Description | Schema |
200 | Updated | Task |
POST/orgs/{org}/projects/{project}/tasks/{task}/transitionstransitionTask
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
| Status | Description | Schema |
200 | New status | Task |
409 | | |
GET/orgs/{org}/projects/{project}/tasks/{task}/commentslistComments
| Status | Description | Schema |
200 | List | object |
POST/orgs/{org}/projects/{project}/tasks/{task}/commentscreateComment
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
| Status | Description | Schema |
201 | Created | Comment |
runs
13 operations
POST/orgs/{org}/tasks/{task}/runsstartRun
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json RunInput
| Status | Description | Schema |
202 | Accepted | Run |
409 | | |
429 | | |
GET/orgs/{org}/runslistRuns
| Parameter | In | Required | Schema | Description |
| | no | object | |
| | no | object | |
status | query | no | RunStatus | |
agent_type | query | no | AgentType | |
| Status | Description | Schema |
200 | List | object |
GET/orgs/{org}/runs/{run}getRun
| Status | Description | Schema |
200 | Details | RunDetail |
404 | | |
POST/orgs/{org}/runs/{run}/cancelcancelRun
| Parameter | In | Required | Schema | Description |
| | no | object | |
| Status | Description | Schema |
202 | Cancellation requested | Run |
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.
| Parameter | In | Required | Schema | Description |
| | no | object | |
| Status | Description | Schema |
202 | A new development run was queued with the same plan | Run |
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.
| Parameter | In | Required | Schema | Description |
| | no | object | |
| Status | Description | Schema |
202 | A fix development run was queued | Run |
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.
| Parameter | In | Required | Schema | Description |
| | no | object | |
| Status | Description | Schema |
202 | A fix development run was queued | Run |
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.
| Parameter | In | Required | Schema | Description |
Last-Event-ID | header | no | integer | |
| Status | Description | Schema |
200 | Stream | string |
404 | | |
GET/orgs/{org}/runs/{run}/diffgetRunDiff
| Status | Description | Schema |
200 | Unified diff | string |
404 | | |
GET/orgs/{org}/projects/{project}/tasks/{task}/runslistTaskRuns
| Status | Description | Schema |
200 | Runs of the task, newest first | object |
POST/orgs/{org}/projects/{project}/tasks/{task}/runsstartTaskRun
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
| Status | Description | Schema |
202 | Accepted | Run |
409 | | |
GET/orgs/{org}/runs/{run}/usagegetRunUsage
| Status | Description | Schema |
200 | Token usage and cost of one run | object |
GET/orgs/{org}/runs/{run}/artifactslistRunArtifacts
| Status | Description | Schema |
200 | Artifacts stored in the object store | object |
approvals
2 operations
GET/orgs/{org}/approvalslistApprovals
| Parameter | In | Required | Schema | Description |
| | no | object | |
| | no | object | |
status | query | no | ApprovalStatus | |
| Status | Description | Schema |
200 | List | object |
POST/orgs/{org}/approvals/{approval}/decisiondecideApproval
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
| Status | Description | Schema |
200 | Decision recorded | Approval |
403 | | |
409 | | |
design
9 operations
GET/orgs/{org}/componentslistComponentEntries
| Status | Description | Schema |
200 | Component registry | object |
POST/orgs/{org}/componentscreateComponentEntry
Request body (required): application/json ComponentEntryInput
| Status | Description | Schema |
201 | Created | |
PUT/orgs/{org}/components/{component}updateComponentEntry
Request body (required): application/json ComponentEntryInput
| Status | Description | Schema |
200 | Updated | |
DELETE/orgs/{org}/components/{component}deleteComponentEntry
| Status | Description | Schema |
204 | Deleted | |
GET/orgs/{org}/design-tokenslistDesignTokens
| Status | Description | Schema |
200 | Org design tokens | object |
POST/orgs/{org}/design-tokenscreateDesignToken
Request body (required): application/json DesignTokenInput
PUT/orgs/{org}/design-tokens/{token}updateDesignToken
Request body (required): application/json DesignTokenInput
| Status | Description | Schema |
200 | Updated | |
DELETE/orgs/{org}/design-tokens/{token}deleteDesignToken
| Status | Description | Schema |
204 | Deleted | |
POST/orgs/{org}/design/seedseedDesignRegistry
Inserts the built-in baseline when the registry is empty.
| Status | Description | Schema |
200 | Created counts | object |
analytics
5 operations
GET/orgs/{org}/searchsearch
| Parameter | In | Required | Schema | Description |
q | query | yes | string | |
| | no | object | |
| Status | Description | Schema |
200 | Rezultati po tipu | object |
GET/orgs/{org}/activitylistActivity
| Parameter | In | Required | Schema | Description |
| | no | object | |
| | no | object | |
| Status | Description | Schema |
200 | Activity feed | object |
GET/orgs/{org}/analytics/summarygetAnalyticsSummary
| Parameter | In | Required | Schema | Description |
from | query | no | date | |
to | query | no | date | |
project | query | no | uuid | |
GET/orgs/{org}/usagegetUsage
| Parameter | In | Required | Schema | Description |
from | query | no | date | |
to | query | no | date | |
group_by | query | no | string | |
GET/orgs/{org}/metricsgetMetrics
| Parameter | In | Required | Schema | Description |
days | query | no | integer | |
environments
6 operations
GET/orgs/{org}/deployments/{deployment}/logsgetDeploymentLogs
| Status | Description | Schema |
200 | NDJSON linije | string |
404 | | |
GET/orgs/{org}/projects/{project}/environmentslistEnvironments
| Status | Description | Schema |
200 | List | object |
POST/orgs/{org}/projects/{project}/environmentscreateEnvironment
Request body (required): application/json object
GET/orgs/{org}/environments/{environment}/deploymentslistDeployments
| Status | Description | Schema |
200 | Deployments of the environment, newest first | object |
POST/orgs/{org}/environments/{environment}/deploymentscreateDeployment
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
| Status | Description | Schema |
202 | Deploy accepted | Deployment |
POST/orgs/{org}/deployments/{deployment}/approveapproveDeployment
Four-eyes gate for prod; the approver must differ from the requester.
| Status | Description | Schema |
200 | Approved and deployed | Deployment |
409 | | |
blueprints
4 operations
GET/orgs/{org}/blueprintslistBlueprints
| Status | Description | Schema |
200 | List | object |
POST/orgs/{org}/blueprintscreateBlueprint
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
POST/orgs/{org}/blueprints/{blueprint}/publishpublishBlueprint
| Status | Description | Schema |
200 | Published (immutable from now on) | Blueprint |
409 | | |
POST/orgs/{org}/blueprints/{blueprint}/instantiateinstantiateBlueprint
| Status | Description | Schema |
201 | Project created from the blueprint (plus its starter tasks) | object |
409 | | |
rules
7 operations
GET/orgs/{org}/ruleslistRules
| Parameter | In | Required | Schema | Description |
project | query | no | uuid | |
| Status | Description | Schema |
200 | List (sa aktivnom verzijom) | object |
POST/orgs/{org}/rulescreateRule
Request body (required): application/json object
| Status | Description | Schema |
201 | Rule created with draft version 1 | Rule |
400 | | |
GET/orgs/{org}/rules/{rule}/versionslistRuleVersions
| Status | Description | Schema |
200 | Versions, newest first | object |
POST/orgs/{org}/rules/{rule}/versionssaveRuleDraft
Request body (required): application/json object
| Status | Description | Schema |
201 | New draft version | |
POST/orgs/{org}/rules/{rule}/versions/{version}/publishpublishRuleVersion
Requests publication; a second admin must approve it (four eyes).
| Status | Description | Schema |
202 | Publish request created | object |
409 | | |
GET/orgs/{org}/rules/approvalslistRulePublishApprovals
| Status | Description | Schema |
200 | Pending rule publications | object |
POST/orgs/{org}/rules/approvals/{approval}/decidedecideRulePublishApproval
Request body (required): application/json object
| Status | Description | Schema |
200 | Decided (and published when approved) | |
400 | | |
audit
1 operations
GET/orgs/{org}/auditlistAudit
| Parameter | In | Required | Schema | Description |
| | no | object | |
| | no | object | |
action | query | no | string | |
actor | query | no | uuid | |
| Status | Description | Schema |
200 | Audit zapisi | object |
invites
4 operations
GET/orgs/{org}/inviteslistInvites
| Status | Description | Schema |
200 | Invites | object |
POST/orgs/{org}/invitescreateInvite
| Parameter | In | Required | Schema | Description |
| | no | object | |
Request body (required): application/json object
| Status | Description | Schema |
201 | Invite created; the token is returned once | object |
400 | | |
POST/orgs/{org}/invites/acceptacceptOrgInvite
Request body (required): application/json object
| Status | Description | Schema |
200 | Membership created | object |
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
| Status | Description | Schema |
201 | Account created and signed in | TokenPair |
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
| Status | Description | Schema |
202 | Accepted | |
401 | | |
POST/webhooks/gitlab/{repo}gitlabWebhook
Verified with X-Gitlab-Token using the repo secret.
Request body (required): application/json object
| Status | Description | Schema |
202 | Accepted | |
401 | | |
git
2 operations
GET/orgs/{org}/pull-requests/{pr}/checkslistPullRequestChecks
| Status | Description | Schema |
200 | CI checks recorded for the pull request | object |
GET/orgs/{org}/runs/{run}/checkslistRunChecks
| Status | Description | Schema |
200 | CI checks recorded for the run | object |
Schemas
64 definitions
Problem7 fields
| Field | Type | Description |
|---|
type * | uri | |
title * | string | |
status * | integer | |
detail | string | |
instance | string | |
code * | string | |
fields | array<object> | |
TokenPair3 fields
| Field | Type | Description |
|---|
access_token * | string | |
refresh_token * | string | |
expires_in * | integer | seconds |
Me2 fields
| Field | Type | Description |
|---|
user | User | |
orgs | array<object> | |
User4 fields
| Field | Type | Description |
|---|
id | uuid | |
email | email | |
name | string | |
avatar_url | ['string', 'null'] | |
OrgRole0 fields
No object properties.
Org5 fields
| Field | Type | Description |
|---|
id | uuid | |
slug | string | |
name | string | |
max_concurrent_runs | integer | |
created_at | date-time | |
ProjectInput4 fields
| Field | Type | Description |
|---|
name * | string | |
description | string | |
blueprint_id | ['string', 'null'] | |
tech_stack | array<string> | |
Project0 fields
No object properties.
TaskStatus0 fields
No object properties.
TaskPriority0 fields
No object properties.
AssistantConversation3 fields
| Field | Type | Description |
|---|
id | uuid | |
title | string | |
updated_at | date-time | |
AssistantMessage5 fields
| Field | Type | Description |
|---|
id | uuid | |
role | string | |
content | string | |
tool_name | string | |
created_at | date-time | |
AssistantMessageInput5 fields
| Field | Type | Description |
|---|
conversation_id | uuid | |
prompt * | string | |
confirm | boolean | |
context | string | The user's current UI (the route and the open drawer). |
images | array<string> | The attached images as data URLs (the model reads them). |
AssistantMessageOutput3 fields
| Field | Type | Description |
|---|
conversation_id | uuid | |
text | string | |
pending_tool | string | |
AcceptanceCriterion3 fields
| Field | Type | Description |
|---|
given * | string | |
when * | string | |
then * | string | |
TaskInput11 fields
| Field | Type | Description |
|---|
title * | string | |
description | string | |
acceptance | array<AcceptanceCriterion> | |
priority | TaskPriority | |
tags | array<string> | |
assignee_id | ['string', 'null'] | |
depends_on | array<string> | |
files | array<string> | |
out_of_scope | array<string> | |
test_plan | array<string> | |
rollback | array<string> | |
Task0 fields
No object properties.
AgentType0 fields
No object properties.
RunStatus0 fields
No object properties.
PhaseName0 fields
No object properties.
Phase5 fields
| Field | Type | Description |
|---|
phase | PhaseName | |
state | string | |
attempt | integer | |
started_at | ['string', 'null'] | |
ended_at | ['string', 'null'] | |
Budget4 fields
| Field | Type | Description |
|---|
tokens_in | integer | |
tokens_out | integer | |
cost_micros | integer | |
wall_clock_s | integer | |
RunInput4 fields
| Field | Type | Description |
|---|
agent_type * | AgentType | |
model * | string | |
dry_run | boolean | |
budget | Budget | |
Run13 fields
| Field | Type | Description |
|---|
id | uuid | |
status | RunStatus | |
agent_type | AgentType | |
model | string | |
task_id | ['string', 'null'] | |
project_id | uuid | |
current_phase | PhaseName | |
spent | object | |
budget | Budget | |
failure_code | ['string', 'null'] | |
started_at | ['string', 'null'] | |
finished_at | ['string', 'null'] | |
created_at | date-time | |
RunDetail0 fields
No object properties.
DiffSummary4 fields
| Field | Type | Description |
|---|
files | integer | |
additions | integer | |
deletions | integer | |
artifact_url | uri | |
ApprovalStatus0 fields
No object properties.
Approval8 fields
| Field | Type | Description |
|---|
id | uuid | |
run_id | ['string', 'null'] | |
type | string | |
status | ApprovalStatus | |
requested_at | date-time | |
decided_at | ['string', 'null'] | |
decided_by | ['string', 'null'] | |
reason | ['string', 'null'] | |
Blueprint4 fields
| Field | Type | Description |
|---|
id | uuid | |
name | string | |
latest_version | ['string', 'null'] | |
published_at | ['string', 'null'] | |
Rule5 fields
| Field | Type | Description |
|---|
id | uuid | |
level | string | |
name | string | |
active_version | ['integer', 'null'] | |
updated_at | ['string', 'null'] | |
Environment3 fields
| Field | Type | Description |
|---|
id | uuid | |
name | string | |
url | ['string', 'null'] | |
Deployment5 fields
| Field | Type | Description |
|---|
id | uuid | |
environment_id | uuid | |
release_ref | string | |
status | string | |
created_at | date-time | |
Kpi4 fields
| Field | Type | Description |
|---|
key | string | |
value | number | |
unit | ['string', 'null'] | |
source | string | |
AnalyticsSummary4 fields
| Field | Type | Description |
|---|
from | date | |
to | date | |
kpis | array<Kpi> | |
series | array<object> | |
UsageReport4 fields
| Field | Type | Description |
|---|
total_cost_micros | integer | |
total_tokens_in | integer | |
total_tokens_out | integer | |
groups | array<object> | |
AuditEntry7 fields
| Field | Type | Description |
|---|
id | integer | |
action | string | |
actor_id | ['string', 'null'] | |
actor_kind | string | |
target | string | |
metadata | object | |
created_at | date-time | |
Member5 fields
| Field | Type | Description |
|---|
user_id | uuid | |
email | email | |
name | string | |
role | OrgRole | |
last_active_at | ['string', 'null'] | |
Provider8 fields
| Field | Type | Description |
|---|
id | uuid | |
name | string | |
base_url | uri | |
enabled | boolean | |
model | string | |
kind | string | |
key_hint | string | last characters of the stored key, never the key |
has_key | boolean | true if a secret is set (never returned) |
Repo6 fields
| Field | Type | Description |
|---|
id | uuid | |
provider | string | |
full_name | string | |
default_branch | string | |
open_prs | integer | |
last_sync_at | ['string', 'null'] | |
RepoCredential3 fields
| Field | Type | Description |
|---|
configured | boolean | |
hint | string | Last four characters of the token; never the token itself. |
updated_at | ['string', 'null'] | |
Check3 fields
| Field | Type | Description |
|---|
name | string | |
state | string | |
meta | ['string', 'null'] | |
PullRequest9 fields
| Field | Type | Description |
|---|
id | uuid | |
number | integer | |
title | string | |
url | uri | |
head | string | |
base | string | |
state | string | |
checks_summary | object | |
updated_at | date-time | |
PullRequestDetail0 fields
No object properties.
TestSummary9 fields
| Field | Type | Description |
|---|
id | uuid | |
suite | string | |
total | integer | |
passed | integer | |
failed | integer | |
skipped | integer | |
coverage_pct | ['number', 'null'] | |
commit_sha | ['string', 'null'] | |
created_at | date-time | |
DesignSystem3 fields
| Field | Type | Description |
|---|
id | uuid | |
name | string | |
latest_version | ['string', 'null'] | |
DesignSystemVersion5 fields
| Field | Type | Description |
|---|
id | uuid | |
design_system_id | uuid | |
version | string | |
published_at | ['string', 'null'] | |
sha256 | string | |
Component12 fields
| Field | Type | Description |
|---|
id | uuid | |
name | string | |
slug | string | |
category | string | |
latest_version | ['string', 'null'] | |
status | ['string', 'null'] | |
framework | string | |
package | string | |
import_path | string | |
version | string | |
docs | string | |
example | string | |
ComponentVersion6 fields
| Field | Type | Description |
|---|
id | uuid | |
version | string | |
status | string | |
props | array<object> | |
a11y_notes | ['string', 'null'] | |
ai_notes | ['string', 'null'] | |
Notification7 fields
| Field | Type | Description |
|---|
id | uuid | |
kind | string | |
title | string | |
body | string | |
target | ['string', 'null'] | |
read_at | ['string', 'null'] | |
created_at | date-time | |
SearchResult5 fields
| Field | Type | Description |
|---|
type | object | |
id | string | |
title | string | |
subtitle | ['string', 'null'] | |
url | string | |
ActivityItem5 fields
| Field | Type | Description |
|---|
id | integer | |
action | string | |
actor | ['string', 'null'] | |
target | string | |
created_at | date-time | |
RegisterInput4 fields
| Field | Type | Description |
|---|
email * | email | |
password * | string | |
name * | string | |
org_name | string | |
InvitePreview4 fields
| Field | Type | Description |
|---|
org_name | string | |
email | email | |
role | OrgRole | |
expires_at | date-time | |
Session7 fields
| Field | Type | Description |
|---|
id | uuid | |
platform | string | |
ip | ['string', 'null'] | |
user_agent | ['string', 'null'] | |
last_used_at | ['string', 'null'] | |
created_at | date-time | |
current | boolean | |
Invite5 fields
| Field | Type | Description |
|---|
id * | uuid | |
email * | email | |
role * | string | |
expires_at * | date-time | |
accepted_at | ['string', 'null'] | |
MetricsSummary8 fields
| Field | Type | Description |
|---|
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
| Field | Type | Description |
|---|
value * | number | |
unit * | string | |
source * | string | |
DesignToken4 fields
| Field | Type | Description |
|---|
id | uuid | |
name | string | |
value | string | |
category | string | |
DesignTokenInput3 fields
| Field | Type | Description |
|---|
name * | string | |
value * | string | |
category | string | |
ComponentEntry5 fields
| Field | Type | Description |
|---|
id | uuid | |
name | string | |
purpose | string | |
rules | string | |
status | string | |
ComponentEntryInput4 fields
| Field | Type | Description |
|---|
name * | string | |
purpose | string | |
rules | string | |
status | string | |
CheckResult5 fields
| Field | Type | Description |
|---|
name | string | |
status | string | |
output | string | |
duration_ms | integer | |
commit_sha | string | |
DesignStandard8 fields
| Field | Type | Description |
|---|
id | uuid | |
name | string | |
version | integer | |
status | string | |
spec | object | |
sha256 | string | |
published_at | ['string', 'null'] | |
created_at | date-time | |