API reference

Connects the model account.

Types: ConnectModelAccountRequest → returns ModelAccountDto

Used by Onboarding, Model accounts

Deletes the vendor trigger.

Types: VendorTriggerIdRequest → returns OkResponse

Used by Triggers

Disconnects the model account.

Types: ModelAccountIdRequest → returns OkResponse

Used by Model accounts

Fires the vendor trigger.

Types: FireVendorTriggerRequest → returns ConnectorRunDto

Gets plan usage.

Types: GetPlanUsageRequest → returns PlanUsageDto

Used by Runners, Triggers

Gets subscription access.

Types: EmptyRequest → returns SubscriptionAccessDto

Used by Connections

Lists connector runs.

Types: ListConnectorRunsRequest → returns PageResponse<ConnectorRunDto>

Used by Triggers

Lists model accounts.

Types: EmptyRequest → returns ListModelAccountsResponse

Used by Onboarding, Model accounts

Lists vendor triggers.

Types: EmptyRequest → returns ListResponse<VendorTriggerDto>

Used by Triggers

Saves the vendor trigger.

Types: SaveVendorTriggerRequest → returns VendorTriggerDto

Used by Triggers

Starts the model account connect.

Types: StartModelAccountConnectRequest → returns StartModelAccountConnectResponse

Used by Model accounts

Tests the model account.

Types: ModelAccountIdRequest → returns ModelAccountDto

Used by Model accounts

Updates the model account.

Types: UpdateModelAccountRequest → returns ModelAccountDto

Used by Model accounts

Updates model account settings.

Types: UpdateModelAccountSettingsRequest → returns ModelAccountSettingsDto

Used by Model accounts

Updates subscription access.

Types: UpdateSubscriptionAccessRequest → returns SubscriptionAccessDto

Used by Connections

Cancels the delegate.

Types: DelegateIdRequest → returns DelegateDto

Gets the delegate.

Types: DelegateIdRequest → returns DelegateDetailDto

Gets the delegate log.

Types: GetDelegateLogRequest → returns DelegateLogPageDto

Used by Work item

Gets delegate settings.

Types: EmptyRequest → returns DelegateSettingsDto

Gets host login settings.

Types: EmptyRequest → returns HostLoginSettingsDto

Used by Runners

Lists work item delegates.

Types: ListWorkItemDelegatesRequest → returns WorkItemDelegatesDto

Used by Workers, Usage & spend

Updates delegate settings.

Types: UpdateDelegateSettingsRequest → returns DelegateSettingsDto

Used by Workers, Brain & Models

Updates host login settings.

Types: UpdateHostLoginSettingsRequest → returns HostLoginSettingsDto

Used by Runners

Asks hosted Jev for one move in an arena game. Public, with a per-address limit and a daily call budget.

Types: ArenaDecideRequest → returns ArenaDecideResult

Whether live play is on, the models, the limits and the calls this visitor has left today. Never calls Jev.

Types: Record<string, never> → returns ArenaLiveStatus

Asks Ava as the signed-in person; her turn runs now, in the request.

Types: import('./assistant.js').AskAssistantRequest → returns import('./assistant.js').AskAssistantResult

Confirms or cancels a change Ava proposed: the person decides its approval, then the change runs as them.

Types: import('./assistant.js').DecideAssistantActionRequest → returns import('./assistant.js').DecideAssistantActionResult

Gets the assistant conversation.

Types: import('./assistant.js').GetAssistantConversationRequest → returns import('./assistant.js').AssistantConversationDto

Compares atlas scans.

Types: { id: string; fromScanId: string; toScanId?: string } → returns { from: AtlasScanRef; to: AtlasScanRef; diff: AtlasProfileDiff }

Used by Work item, Repository Atlas

Gets the atlas repository.

Types: { id: string; scanId?: string } → returns { repository: AtlasRepositorySummary; scan: AtlasScanRef; profile: AtlasProfile; history: AtlasScanRef[]; findingWork: …

Used by Work item, Repository Atlas

Gets the atlas work overlay.

Types: { workItemId: string } → returns AtlasWorkOverlay

Used by Work item, Repository Atlas

Lists atlas repositories.

Types: Record<string, never> → returns { items: AtlasRepositorySummary[]; settings: AtlasSettings }

Used by Work item, Repository Atlas

Checks the public health routes the latest profile names. Results are cached for a minute.

Types: { id: string } → returns { probes: AtlasProbe[]; targets: number }

Used by Work item, Repository Atlas

Removes the atlas repository.

Types: { id: string } → returns { removed: boolean }

Used by Work item, Repository Atlas

The local runner's upload, authenticated with its runner token rather than a session.

Submits atlas profiles.

Types: { profiles: AtlasProfile[] } → returns AtlasSubmitResult

Used by Work item, Repository Atlas

Admins turn the platform's own refresh (a scan of each checkout it prepares for work) on or off.

Types: { autoRefresh: boolean } → returns AtlasSettings

Used by Work item, Repository Atlas

One tap: adds a gallery automation with its default owner.

Types: { key: string; ownerWorkerId?: string } → returns AutomationDto

Used by Automations

Deletes the automation.

Types: { automationId: string } → returns { ok: true }

Used by Automations

Reads a sentence with the chat parser and stores a proposal to start; nothing runs yet.

Types: { text: string; ownerWorkerId?: string } → returns DescribeAutomationResult

Used by Automations

Gets the first plan.

Types: Record<string, never> → returns { plan: FirstPlanDto | null }

Lists automation gallery.

Types: Record<string, never> → returns { items: AutomationGalleryItemDto[]; events: AutomationEventOptionDto[]; unsupported: AutomationUnsupportedEventDto[] }

Used by Automations

Lists automations.

Types: Record<string, never> → returns ListAutomationsResult

Used by Automations

Sets the automation enabled.

Types: { automationId: string; enabled: boolean } → returns AutomationDto

Used by Automations

Starts the automation.

Types: { proposalId: string } → returns AutomationDto

Used by Automations

Benchmark explorer: runner identity.

Types: Record<string, never> → returns {runnerId:string;name:string;orgId:string}

Benchmark explorer: annotates the run.

Types: {id:string;classification:RunClass;reason:string|null;notes:string[]} → returns null

Used by Admin overview

Benchmark explorer: cancels the run.

Types: {id:string} → returns null

Used by Admin overview

Benchmark explorer: creates a case.

Types: CaseDraft → returns BenchmarkCase

Used by Admin overview

Benchmark explorer: gets the explorer.

Types: Record<string, never> → returns ExplorerData

Used by Admin overview

Benchmark explorer: imports evidence.

Types: EvidenceDataset → returns EvidenceImportResult

Used by Admin overview

Benchmark explorer: revokes the runner.

Types: {id:string} → returns null

Used by Admin overview

Benchmark explorer: runner claim.

Types: {runnerId:string} → returns RunnerAssignment|null

Benchmark explorer: runner complete.

Types: {runnerId:string;runId:string;leaseToken:string;receipt:RunRecord} → returns {ok:true}

Benchmark explorer: runner heartbeat.

Types: {runner:Omit<RunnerInfo,'lastSeenAt'|'online'>} → returns {ok:true}

Benchmark explorer: runner progress.

Types: {runnerId:string;runId:string;leaseToken:string;patch:Partial<Pick<RunRecord,'metrics'|'usage'|'events'|'effective'|'wa… → returns {cancelled:boolean}

Benchmark explorer: starts the campaign.

Types: CampaignRequest → returns CampaignResult

Used by Admin overview

Cancels the billing plan.

Types: { idempotencyKey: string } → returns { id: string }

Used by Billing settings

Changes the billing plan.

Types: { tier: BillingPaidTier; idempotencyKey: string } → returns { id: string }

Used by Billing settings

Creates a billing checkout.

Types: CreateBillingCheckoutRequest → returns BillingCheckoutResponse

Used by Billing settings

Creates a billing portal.

Types: Record<string, never> → returns BillingPortalResponse

Used by Billing settings

Gets billing overview.

Types: Record<string, never> → returns BillingOverviewDto

Used by Billing settings

Deletes the business record.

Types: { tableId: string; id: string; expectedVersion: number } → returns { deleted: boolean }

Used by Company data

Deletes the business table.

Types: { id: string; expectedRevision: number } → returns { deleted: boolean }

Used by Company data

Exports the business table.

Types: { tableId: string } → returns { table: BusinessTable; records: BusinessRecord[]; exportedAt: string }

Used by Company data

Lists business tables.

Types: Record<string, never> → returns { items: BusinessTable[] }

Used by Company data

Queries business records.

Types: { tableId: string; filters?: DataFilter[]; query?: string; limit?: number; offset?: number } → returns { items: BusinessRecord[]; total: number }

Used by Company data

Saves the business record.

Types: { tableId: string; id?: string; expectedVersion?: number; values: Record<string, DataValue>; source?: BusinessRecord['s… → returns BusinessRecord

Used by Company data

Saves the business table.

Types: { id?: string; expectedRevision?: number; name: string; description?: string; fields: DataField[] } → returns BusinessTable

Used by Company data

The campaign of a work item: its root goal, limits, delivery mode, hold and usage.

Types: CampaignRef → returns CampaignDto

What the campaign did: items by role, runs, pull requests merged and declined, lines changed, cost and follow-ups.

Types: CampaignRef → returns CampaignReportDto

Used by Command, Work item

Stop and wait: hold the item and everything under it. Schedules, timers and delegation start no held work.

Types: CampaignHoldRequest → returns CampaignDto

Used by Command, Work item

Lift a hold and wake the open items under it.

Types: CampaignRef → returns CampaignDto

Used by Command, Work item

Set the campaign limits (concurrency, total items, spend), delivery mode and pull request limits.

Types: CampaignSettingsRequest → returns CampaignDto

Used by Command, Work item

Send one instruction to every open item in the campaign, for example "keep going but open fewer pull requests".

Types: CampaignSteerRequest → returns CampaignSteerResult

Used by Command, Work item

Gets career application settings.

Types: Record<string, never> → returns CareerApplicationSettings

Submits a career application.

Types: CareerApplicationRequest → returns CareerApplicationReceipt

Asks about company data.

Types: { question: string; followUpOf?: string } → returns CompanyAnswerDto

Used by Company data

Confirms the company ontology.

Types: { types: { key: string; name?: string; description?: string; include: boolean }[] links: { key: string; label?: string;… → returns CompanyOntologyDto

Used by Company data

Connects the company data source.

Types: ConnectCompanyDataSourceRequest → returns ConnectCompanyDataSourceResult

Used by Company data

Deletes the company question.

Types: { id: string } → returns { deleted: boolean }

Used by Company data

Gets the company graph.

Types: { typeKeys?: string[]; limit?: number } → returns CompanyGraphDto

Used by Company data

Gets the company home.

Types: Record<string, never> → returns CompanyHomeDto

Used by Company data

Gets the company ontology.

Types: Record<string, never> → returns CompanyOntologyDto

Used by Company data

Gets the company record.

Types: { id: string; perGroup?: number } → returns CompanyRecordNeighbourhoodDto

Used by Company data

Ingests company records.

Types: { sourceId: string; records: Record<string, DataValue>[] } → returns { accepted: number; rejected: number }

Lists company data sources.

Types: Record<string, never> → returns { items: CompanyDataSourceDto[] }

Used by Company data

Lists company metrics.

Types: Record<string, never> → returns { items: CompanyMetricDefinitionDto[] }

Lists company objects.

Types: { typeKey: string; query?: string; limit?: number; offset?: number } → returns { items: CompanyObjectDto[]; total: number }

Used by Company data

Removes the company data source.

Types: { sourceId: string } → returns { removed: boolean }

Used by Company data

Saves the company question.

Types: { question: string } → returns CompanySavedQuestionDto

Used by Company data

Suggests a company ontology.

Types: { useModel?: boolean } → returns CompanyOntologyDto

Used by Company data

Syncs the company data source.

Types: { sourceId: string } → returns CompanyDataSourceDto

Used by Company data

Applies the company plan.

Types: import('./companyPlanner.js').ApplyCompanyPlanRequest → returns import('./companyPlanner.js').ApplyCompanyPlanResponse

Used by Company planner

Generates the company plan.

Types: import('./companyPlanner.js').GenerateCompanyPlanRequest → returns import('./companyPlanner.js').CompanyPlanDto

Used by Company planner

Gets the company planner.

Types: EmptyRequest → returns import('./companyPlanner.js').GetCompanyPlannerResponse

Used by Company planner

Starts the company pipeline.

Types: import('./companyPlanner.js').StartCompanyPipelineRequest → returns import('./companyPlanner.js').CompanyPipelineDto

Used by Company planner

Updates the company plan.

Types: import('./companyPlanner.js').UpdateCompanyPlanRequest → returns import('./companyPlanner.js').CompanyPlanDto

Used by Company planner

Adds a MCP server.

Types: AddMcpServerRequest → returns McpServerChangeDto

Used by Integrations

Cancels the connect.

Types: ConnectIdRequest → returns ConnectSessionDto

Completes the connect.

Types: CompleteConnectRequest → returns ConnectSessionDto

Used by Accept an invitation, Onboarding, Sign in, Sign up, Integrations

Connects the start.

Types: ConnectStartRequest → returns ConnectStartResponse

Used by Accept an invitation, Onboarding, Sign in, Sign up, Integrations

Gets the connect.

Types: ConnectIdRequest → returns ConnectSessionDto

Used by Accept an invitation, Onboarding, Sign in, Sign up, Integrations

Grants the MCP server.

Types: GrantMcpServerRequest → returns McpServerDto

Used by Integrations

Lists connect options.

Types: EmptyRequest → returns ListResponse<ConnectOptionDto>

Used by Integrations

Lists MCP servers.

Types: EmptyRequest → returns ListMcpServersResponse

Used by Integrations

Checks again the connection.

Types: RecheckConnectionRequest → returns ConnectionDto

Refreshes the MCP server.

Types: RefreshMcpServerRequest → returns McpServerChangeDto

Used by Integrations

Removes the MCP server.

Types: RemoveMcpServerRequest → returns OkResponse

Used by Integrations

Revokes the MCP server grant.

Types: RevokeMcpServerGrantRequest → returns McpServerDto

Used by Integrations

WhatsApp: configure.

Types: WhatsAppConfigureRequest → returns WhatsAppStatusDto

Used by Settings

WhatsApp: embedded signup.

Types: WhatsAppEmbeddedSignupRequest → returns WhatsAppStatusDto

Used by Onboarding, Settings

WhatsApp: retries setup.

Types: WhatsAppRetrySetupRequest → returns WhatsAppStatusDto

Used by Onboarding, Settings

WhatsApp: sends a test.

Types: WhatsAppSendTestRequest → returns WhatsAppSendTestResponse

Used by Settings

WhatsApp: status.

Types: EmptyRequest → returns WhatsAppStatusDto

Used by Onboarding, Settings

WhatsApp: uses the utility template.

Types: EmptyRequest → returns WhatsAppStatusDto

Used by Settings

Gets work item context.

Types: GetWorkItemContextRequest → returns WorkItemContextDto

Used by Work item

Archives the conversation thread.

Types: ArchiveConversationThreadRequest → returns ConversationThreadResponse

Used by CEO

Continues the conversation thread.

Types: ContinueConversationThreadRequest → returns ContinueConversationThreadResponse

Creates a conversation thread.

Types: CreateConversationThreadRequest → returns ConversationThreadResponse

Used by CEO

Gets the conversation.

Types: GetConversationRequest → returns GetConversationResponse

Used by Command, CEO, Board

Gets the conversation thread.

Types: GetConversationThreadRequest → returns GetConversationThreadResponse

Used by CEO

Lists conversation threads.

Types: ListConversationThreadsRequest → returns ListConversationThreadsResponse

Used by Command, CEO, Board

Lists conversations.

Types: ListConversationsRequest → returns ListConversationsResponse

Used by CEO

Renames the conversation thread.

Types: RenameConversationThreadRequest → returns ConversationThreadResponse

Used by CEO

Searches conversations.

Types: SearchConversationsRequest → returns SearchConversationsResponse

Used by CEO

Sends a conversation message.

Types: SendConversationMessageRequest → returns SendConversationMessageResponse

Used by Onboarding, Command, CEO, Board

Creates a delivery proof share.

Types: CreateDeliveryProofShareRequest → returns SharedOutputDto

Used by Command, Work item

Gets the delivery subject record.

Types: GetDeliverySubjectRecordRequest → returns DeliverySubjectRecordDto

Used by Work item, Decisions

Lists delivery proof share candidates.

Types: ListDeliveryProofShareCandidatesRequest → returns ListDeliveryProofShareCandidatesResponse

Used by Command, Work item

Lists delivery proofs.

Types: ListDeliveryProofsRequest → returns ListDeliveryProofsResponse

Used by Command, CEO, Work item

Lists delivery source receipts.

Types: ListDeliverySourceReceiptsRequest → returns ListDeliverySourceReceiptsResponse

Used by Work item, Decisions

Lists org delivery proofs.

Types: ListOrgDeliveryProofsRequest → returns ListOrgDeliveryProofsResponse

Used by Command

Signals, decisions, started, shipped, verified, commits to main and releases per UTC day, with lead time and time per stage.

Types: GetDeliveryMetricsRequest → returns DeliveryMetricsDto

Used by Delivery

The quality employee for each pipeline stage: its role, a pinned worker, the worker in charge now and the gate it owns.

Types: GetStageOwnersRequest → returns { owners: StageOwnerDto[] }

Used by Delivery

Changes the role or the pinned worker of one or more pipeline stages.

Types: UpdateStageOwnersRequest → returns { owners: StageOwnerDto[] }

Used by Delivery

Lists initiatives.

Types: ListInitiativesRequest → returns { items: InitiativeDto[] }

Used by Office

Office state.

Types: OfficeStateRequest → returns OfficeStateDto

Used by Office

Responds to the initiative.

Types: RespondInitiativeRequest → returns InitiativeDto

Used by Office

Sets the worker disposition.

Types: SetDispositionRequest → returns WorkerDisposition

Used by Office

Talks to the to worker.

Types: TalkToWorkerRequest → returns TalkToWorkerResult

Used by Office

Worker inner life.

Types: WorkerInnerLifeRequest → returns WorkerInnerLifeDto

Used by Office

Decides the employee trial.

Types: { workerId: string; decision: 'keep' | 'decline' } → returns EmployeeProgram

Used by Command, Workers

Gets the employee program.

Types: { workerId: string } → returns EmployeeProgram

Used by Command, Workers

Sets the employee initiative.

Types: { workerId: string; expectedRevision: number; initiative: EmployeeProgram['initiative'] } → returns EmployeeProgram

Used by Command, Workers

Starts the employee trial.

Types: { workerId: string } → returns EmployeeProgram

Used by Command, Workers

Creates enterprise service identity.

Types: ServiceIdentityCreateInput → returns ServiceIdentityToken

Used by Enterprise identity

Enterprise identity: SCIM.

Gets enterprise identity.

Types: Record<string, never> → returns EnterpriseIdentityView

Used by Enterprise identity

Revokes the enterprise SCIM.

Types: Record<string, never> → returns { ok: true }

Used by Enterprise identity

Revokes enterprise service identity.

Types: { identityId: string } → returns { ok: true }

Used by Enterprise identity

Rotates the enterprise SCIM token.

Types: { status?: EnterpriseScimStatus } → returns { scim: EnterpriseScimView; token: string }

Used by Enterprise identity

Saves enterprise domain policy.

Types: { id?: string; domain: string; status: EnterpriseDomainStatus; requireSso: boolean; connectionId: string | null } → returns EnterpriseDomainPolicyView

Used by Enterprise identity

Saves the enterprise identity connection.

Types: { id?: string kind: EnterpriseIdentityKind name: string issuer: string | null clientId: string | null entityId: string … → returns EnterpriseConnectionSummary

Used by Enterprise identity

Pick which employees stay active when the org is over its employee limit; the rest go on leave.

Types: { workerIds: string[] } → returns OrgPlanStatusDto

Used by Billing settings

Gets org plan status.

Types: Record<string, never> → returns OrgPlanStatusDto

Used by Billing settings

Lists employees on leave.

Types: Record<string, never> → returns { items: EmployeeOnLeaveDto[] }

Used by Billing settings

Lists plans.

Types: Record<string, never> → returns { items: PlanDefinitionDto[]; offers: PlanOfferDto[] }

Used by Billing settings

Requests an enterprise plan.

Types: { name: string; email: string; company: string; employees?: number; message?: string } → returns { received: boolean }

Used by Billing settings

Gets the escalation route.

Types: GetEscalationRouteRequest → returns GetEscalationRouteResponse

Used by Escalations

Retries the escalation delivery.

Types: RetryEscalationDeliveryRequest → returns GetEscalationRouteResponse

Used by Escalations

Deletes the my measured effort.

Types: EmptyRequest → returns EffortBaselinesResponse

Used by Usage & spend

Gets task metrics.

Types: GetTaskMetricsRequest → returns TaskMetricsResponse

Used by Workers, Usage & spend

Lists effort baselines.

Types: EmptyRequest → returns EffortBaselinesResponse

Used by Usage & spend

Records a my measured effort.

Types: RecordMyMeasuredEffortRequest → returns RecordMyMeasuredEffortResponse

Used by Usage & spend

Sets the effort baseline.

Types: SetEffortBaselineRequest → returns EffortBaselinesResponse

Used by Usage & spend

Gets the execution profile.

Types: { workerId?: string } → returns import('./execution.js').ExecutionProfileDto

Used by Workers, Brain & Models

Gets work item repository readiness.

Types: { workItemId: string } → returns import('./repositoryReadiness.js').WorkItemRepositoryReadinessResponse

Used by Command, Work item

Gets work launch readiness.

Types: { workerId?: string; templateId?: string } → returns import('./execution.js').WorkLaunchReadinessDto

Used by Onboarding, Command, Board, New work, Repository Atlas

Updates the org execution profile.

Types: { policy: import('./execution.js').ExecutionPolicyInput } → returns import('./execution.js').ExecutionProfileDto

Used by Workers, Brain & Models

The feedback you sent, newest first, with its status and the note from the platform team.

Types: EmptyRequest → returns import('./help.js').ListFeedbackResult

Used by Help

Sends feedback to the platform's developers: a feature request, bug, question, praise or other, with an optional screenshot and app version. At most 20 per person per hour.

Types: import('./help.js').SubmitFeedbackRequest → returns import('./help.js').FeedbackDto

Used by Help

Front desk: binds the number.

Types: { integrationId: string; workerId: string | null } → returns FrontDeskNumbersDto

Used by Settings

Front desk: checks groups.

Types: Record<string, never> → returns FrontDeskNumbersDto

Used by Settings

Front desk: connects the number.

Types: FrontDeskConnectNumberRequest → returns FrontDeskNumbersDto

Used by Settings

A second number through Meta's Embedded Signup popup: the same steps as the front desk's one click, bound to a worker.

Types: { workerId: string; code: string; phoneNumberId: string; wabaId: string } → returns FrontDeskNumbersDto

Used by Settings

Front desk: creates a group.

Types: { subject?: string } → returns FrontDeskNumbersDto

Used by Settings

Front desk: numbers.

Types: Record<string, never> → returns FrontDeskNumbersDto

Used by Settings

Front desk: syncs the profile.

Types: FrontDeskSyncProfileRequest → returns FrontDeskNumbersDto

Used by Settings

Front desk: team.

Types: Record<string, never> → returns TeamRosterDto

Used by Settings

Harness benchmarks: compares runs.

Types: HarnessBenchmarkCompareRunsRequest → returns HarnessBenchmarkComparison

Used by Benchmarks

Harness benchmarks: gets the case.

Types: HarnessBenchmarkGetCaseRequest → returns HarnessBenchmarkCase

Harness benchmarks: gets the run.

Types: HarnessBenchmarkGetRunRequest → returns HarnessBenchmarkRun

Harness benchmarks: lists cases.

Types: HarnessBenchmarkListCasesRequest → returns HarnessBenchmarkListCasesResponse

Used by Benchmarks

Harness benchmarks: lists runs.

Types: HarnessBenchmarkListRunsRequest → returns HarnessBenchmarkListRunsResponse

Used by Benchmarks

Harness benchmarks: records a run.

Types: HarnessBenchmarkRecordRunRequest → returns HarnessBenchmarkRun

Used by Benchmarks

Harness benchmarks: saves the case.

Types: HarnessBenchmarkSaveCaseRequest → returns HarnessBenchmarkCase

Used by Benchmarks

Harness benchmarks: starts the run.

Types: HarnessBenchmarkStartRunRequest → returns HarnessBenchmarkStartRunResponse

Used by Benchmarks

Turns off the subscription.

Types: SubscriptionIdRequest → returns SubscriptionDto

Used by Intake

Lists subscriptions.

Types: ListSubscriptionsRequest → returns ListResponse<SubscriptionDto>

Used by Intake

Lists work dependencies.

Types: ListWorkDependenciesRequest → returns ListResponse<WorkDependencyEdgeDto>

Used by Intake

The pattern, filter and action are checked by the collab module, which owns their grammar.

Types: SaveSubscriptionRequest → returns SubscriptionDto

Used by Intake

Every ticket that moved on one calendar day, with its steps, for the day replay. The time zone defaults to UTC.

Types: GetDayReplayRequest → returns DayReplayDto

Used by Day replay

One ticket's journey: every step, owner and handoff from the first signal to shipped. Give a workItemId or a signalId.

Types: GetWorkJourneyRequest → returns WorkJourneyDto

Used by Day replay

Exports the learned state.

Types: ExportLearnedStateRequest → returns LearnedStateBundle

Gets the area note.

Types: GetAreaNoteRequest → returns AreaNoteDto

Gets the source sync state.

Types: GetSourceSyncStateRequest → returns SourceSyncStateDto

Imports a learned state.

Types: ImportLearnedStateRequest → returns TransferReport

Lists area notes.

Types: ListAreaNotesRequest → returns ListAreaNotesResponse

Lists learned state imports.

Types: EmptyRequest → returns ListResponse<LearnedStateImportDto>

Lists source ties.

Types: ListSourceTiesRequest → returns ListSourceTiesResponse

Where one feature lives in the code: its routes, files, exported symbols, API handlers, tables, events and tests, from the build that runs now. Only for the platform's own team.

Types: GetFeatureCodeMapRequest → returns GetFeatureCodeMapResult

Used by Live docs

Lists MCP connections.

Types: EmptyRequest → returns ListResponse<McpConnectionDto>

Used by Connections

Revokes the MCP connection.

Types: RevokeMcpConnectionRequest → returns OkResponse

Used by Connections

The org's search synonyms: pairs learned from its own org-wide text or set by people, and the built-in pairs every org starts with.

Types: EmptyRequest → returns ListSearchSynonymsResult

Used by Documents

Adds a search synonym pair for the org, or turns one off (a learned or built-in one included). Recall and knowledge search expand the term to the alternative and back.

Types: SetSearchSynonymInput → returns SearchSynonymDto

Used by Documents

Diagnostic bundle.

Types: DiagnosticBundleRequest → returns DiagnosticBundleDto

Used by Observe, Board, Organization

What the platform keeps for the organization, and for how long.

Types: EmptyRequest → returns DataRetentionDto

Used by Settings

How many of each work item's warn and error lines the org keeps, and for how long.

Types: EmptyRequest → returns ItemLogSettingsDto

Gets run waste.

Types: GetRunWasteRequest → returns RunWasteDto

Shows delegation.

Types: ObserveDelegationRequest → returns ObserveDelegationDetailDto

Used by Observe

Shows delegations.

Types: ObserveDelegationsRequest → returns ObserveDelegationsDto

Used by Observe

Shows the entity.

Types: ObserveEntityRequest → returns ObserveEntityDto

Used by Command, Observe, Board, Organization

Shows the fleet.

Types: EmptyRequest → returns ObserveFleetDto

Used by Observe, Office

Shows the fleet flow.

Types: ObserveFleetFlowRequest → returns ObserveFleetFlowDto

Used by Observe, Office

Shows the flow.

Types: ObserveFlowRequest → returns ObserveFlowDto

Used by Command, Observe

Shows the front door latency.

Types: ObserveFrontDoorLatencyRequest → returns ObserveFrontDoorLatencyDto

Used by Observe

Shows questions.

Types: ObserveQuestionsRequest → returns ObserveQuestionsDto

Shows tools.

Types: ObserveToolsRequest → returns ObserveToolsDto

Used by Observe

Shows the why.

Types: ObserveWhyRequest → returns ObserveWhyDto

Used by Observe, Board, Organization

Shows the worker.

Types: ObserveWorkerRequest → returns ObserveWorkerDto

Used by Observe

Shows the worker agenda.

Types: ObserveWorkerAgendaRequest → returns ObserveWorkerAgendaDto

Used by Organization

Sets the org's own cap on the lines each work item keeps, or returns it to the platform's with null.

Types: UpdateItemLogSettingsRequest → returns ItemLogSettingsDto

Creates the first org and owner.

Types: BootstrapRequest → returns MeResponse

Sets up status.

Types: EmptyRequest → returns BootstrapStatusResponse

Used by First owner setup, Sign in, Sign up

Creates a API token.

Types: CreateApiTokenRequest → returns CreateApiTokenResponse

Used by API tokens

Creates an invite.

Types: CreateInviteRequest → returns CreateInviteResponse

Lists API tokens.

Types: EmptyRequest → returns ListApiTokensResponse

Used by API tokens

Lists members.

Types: EmptyRequest → returns ListMembersResponse

Used by Device sign-in, Onboarding, Command, CEO, Board, Specs, Automations, Intake, New work, Work item, Organization, Company planner, Workers, Resources, Oversight, Repository Atlas, Company data, Memory, Operating Model, Documents, Lessons, Examples & Procedures, Your persona, Integrations, Brain & Models, Model accounts, Decisions, Policies, Rules & Preferences, Usage & spend, Audit Log, Members, API tokens, Settings, Billing settings, Connections, Runners, Triggers

Signs in.

Types: LoginRequest → returns MeResponse

Signs out.

Types: EmptyRequest → returns OkResponse

Gets the signed-in person, their organizations and the session token for changes.

Types: EmptyRequest → returns MeResponse

Revokes the API token.

Types: RevokeApiTokenRequest → returns OkResponse

Used by API tokens

Revokes the invite.

Types: RevokeInviteRequest → returns OkResponse

Used by Members

Switches the org.

Types: SwitchOrgRequest → returns MeResponse

Updates the member role.

Types: UpdateMemberRoleRequest → returns MemberSummary

Used by Members

Gets the org chart.

Types: EmptyRequest → returns OrgChartDto

Used by Command, Observe, Board, Organization

Gets org config.

Types: GetOrgConfigRequest → returns OrgConfigView

Used by Onboarding, Command, Observe, Office, Board, Organization, Workers, Settings, Invite & earn

Lists org proposals.

Types: ListOrgProposalsRequest → returns ListResponse<OrgProposalDto>

Used by Command, Organization

Seeds the org template.

Types: EmptyRequest → returns SeedOrgTemplateResponse

Used by Command, Organization

Sets org config.

Types: SetOrgConfigRequest → returns OrgConfigView

Used by Onboarding, Command, Office, Organization, Workers, Settings, Invite & earn

Sets the worker manager.

Types: SetWorkerManagerRequest → returns OrgChartDto

Used by Command, Organization

Clears org config.

Types: UnsetOrgConfigRequest → returns OrgConfigView

Used by Command, Workers, Settings

Applies recommended setup.

Types: import('./orgSetup.js').ApplyRecommendedSetupRequest → returns import('./orgSetup.js').RecommendedSetupDto

Used by Onboarding

Connects chosen suggestions as runner repositories, as `agent-runner repo connect` would.

Types: import('./orgSetup.js').ConnectRepositorySuggestionsRequest → returns import('./orgSetup.js').ConnectRepositorySuggestionsResult

Used by Onboarding

Gets first task suggestions.

Types: EmptyRequest → returns import('./orgSetup.js').FirstTaskSuggestionsResult

Used by Onboarding

Gets recommended setup.

Types: EmptyRequest → returns import('./orgSetup.js').RecommendedSetupDto

Used by Onboarding

Saves nothing: the owner reviews the proposal and saves it with setOrgConfig.

Types: import('./orgSetup.js').ImportOrgWebsiteRequest → returns import('./orgSetup.js').WebsiteImportDto

Used by Onboarding

Lists org repositories.

Types: EmptyRequest → returns import('./orgSetup.js').ListOrgRepositoriesResult

Used by Onboarding

The person's own runners' checkouts that are not connected yet.

Types: EmptyRequest → returns import('./orgSetup.js').ListRepositorySuggestionsResult

Used by Onboarding

Runner: registers the repository.

Types: import('./orgSetup.js').RunnerRepositoryRegisterRequest → returns import('./orgSetup.js').RunnerRepositoryRegisterResult

Runner: reports repository candidates.

Types: import('./orgSetup.js').RunnerRepositoryCandidatesRequest → returns import('./orgSetup.js').RunnerRepositoryCandidatesResult

Decides the outreach message.

Types: { messageId: string; decision: 'approved' | 'denied'; comment?: string } → returns OutreachMessageDto

Used by Outreach

Deletes the outreach contact.

Types: { id: string } → returns { deleted: boolean }

Used by Outreach

Gets outreach settings.

Types: Record<string, never> → returns OutreachSettingsView

Used by Command, Outreach, Workers

Gets outreach stats.

Types: { days?: number } → returns OutreachStatsDto

Used by Outreach

Imports outreach contacts.

Types: ImportOutreachContactsRequest → returns ImportOutreachContactsResult

Used by Outreach

Lists outreach contacts.

Types: ListOutreachContactsRequest → returns ListOutreachContactsResult

Used by Outreach

Lists outreach messages.

Types: ListOutreachMessagesRequest → returns ListOutreachMessagesResult

Used by Outreach

Releases the outreach contact.

Types: { id: string } → returns OutreachContactDto

Used by Outreach

Saves the outreach contact.

Types: SaveOutreachContactRequest → returns OutreachContactDto

Used by Outreach

Saves outreach settings.

Types: SaveOutreachSettingsRequest → returns OutreachSettingsView

Used by Command, Outreach, Workers

Acknowledges the finding.

Types: FindingIdRequest → returns FindingDto

Used by Command, Oversight

Gets the finding.

Types: FindingIdRequest → returns FindingDto

Gets the team pause.

Types: import('./oversight.js').TeamPauseRequest → returns import('./oversight.js').TeamPauseDto

Used by Command, Workers

Lists findings.

Types: ListFindingsRequest → returns ListResponse<FindingDto>

Used by Command, Oversight

Oversight summary.

Types: EmptyRequest → returns OversightSummaryDto

Used by Command, Oversight

Pauses the team.

Types: import('./oversight.js').PauseTeamRequest → returns import('./oversight.js').PauseTeamResponse

Used by Command, Workers

Resolves the finding.

Types: ResolveFindingRequest → returns FindingDto

Used by Command, Oversight

Resumes the subtree.

Types: ResumeSubtreeRequest → returns { pause: SubtreePauseDto; workersResumed: number; itemsWoken: number }

Used by Command, Oversight

Resumes the team.

Types: import('./oversight.js').ResumeTeamRequest → returns import('./oversight.js').ResumeTeamResponse

Used by Command, Workers

Suppresses the finding.

Types: SuppressFindingRequest → returns FindingDto

Used by Command, Oversight

Adds a persona source.

Types: AddPersonaSourceRequest → returns PersonaSourceDto

Used by Your persona

Adds persona units.

Types: AddPersonaUnitsRequest → returns AddPersonaUnitsResponse

Used by Your persona

Connects the persona source.

Types: ConnectPersonaSourceRequest → returns PersonaSourceDto

Used by Your persona

Deletes persona.

Types: DeletePersonaRequest → returns OkResponse

Used by Your persona

Deletes the persona source.

Types: PersonaSourceIdRequest → returns OkResponse

Used by Your persona

Extracts persona.

Types: ExtractPersonaRequest → returns PersonaProfileDto

Used by Your persona

Gets persona.

Types: EmptyRequest → returns GetPersonaResponse

Used by Your persona

Gets the persona trait.

Types: PersonaTraitIdRequest → returns PersonaTraitDetailDto

Reviews the persona trait.

Types: ReviewPersonaTraitRequest → returns PersonaTraitDto

Used by Your persona

Updates the persona profile.

Types: UpdatePersonaProfileRequest → returns PersonaProfileDto

Used by Your persona

Updates the persona source.

Types: UpdatePersonaSourceRequest → returns PersonaSourceDto

Used by Your persona

Gets the pipeline profile.

Types: GetPipelineProfileRequest → returns GetPipelineProfileResponse

Updates the pipeline profile.

Types: UpdatePipelineProfileRequest → returns GetPipelineProfileResponse

Cancels the portable transfer.

Types: PortableTransferCancelRequest → returns PortableTransferManifestResult

Used by Settings

Commits the portable import.

Types: { transferId: string; rootHash: string } → returns PortableTransferCommitResult

Used by Settings

Deletes the portable archive.

Types: DeletePortableArchiveRequest → returns DeletePortableArchiveResult

Used by Settings

Deletes the portable stored file.

Types: { fileId: string } → returns DeletePortableStoredFileResult

Used by Settings

Exports the portable exit.

Types: ExportPortableExitRequest → returns PortableExitBundle

Used by Settings

Gets the portable archive.

Types: GetPortableArchiveRequest → returns PortableArchiveDetail

Used by Settings

Gets the portable forget impact.

Types: { memoryId: string } → returns { links: number; archives: number; storedFiles: number }

Used by Command, Memory

Gets the portable import review.

Types: { transferId: string } → returns PortableTransferReviewResult

Used by Settings

Gets the portable transfer.

Types: { transferId: string } → returns PortableTransferManifestResult

Used by Settings

Imports a portable exit.

Types: ImportPortableExitRequest → returns PortableExitImportReport

Used by Settings

Links portable copy to memory.

Types: { memoryId: string } & ({ targetKind: 'archive'; archiveId: string } | { targetKind: 'stored_file'; storedFileId: strin… → returns PortableMemoryLink

Used by Settings

Lists portable archives.

Types: ListPortableArchivesRequest → returns ListPortableArchivesResult

Used by Settings

Lists portable memory links.

Types: { after?: string; limit?: number } & ({ targetKind: 'archive'; archiveId: string } | { targetKind: 'stored_file'; store… → returns PortableMemoryLinkPage

Used by Settings

Lists portable stored files.

Types: { after?: string; limit?: number } → returns ListPortableStoredFilesResult

Used by Settings

Previews the portable exit.

Types: { bundle: PortableExitBundle } → returns PortableExitPreview

Used by Settings

Uploads a portable import chunk.

Types: PutPortableChunkRequest & { transferId: string } → returns PortableTransferManifestResult

Used by Settings

Reads the portable export chunk.

Types: { transferId: string; index: number } → returns PortableTransferChunk

Used by Settings

Reads the portable stored file part.

Types: { fileId: string; index: number } → returns ReadPortableStoredFilePartResult

Used by Settings

Reviews portable memory.

Types: ReviewPortableMemoryRequest → returns MemoryDto

Used by Command, Memory

Starts the portable export.

Types: PortableTransferExportRequest → returns PortableTransferManifestResult

Used by Settings

Starts the portable import.

Types: StartPortableImportRequest → returns PortableTransferManifestResult

Used by Settings

Unlinks the portable memory link.

Types: { linkId: string } → returns { linkId: string }

Used by Settings

Validates the portable import.

Types: { transferId: string } → returns PortableTransferReviewResult

Used by Settings

PR trials: cancel.

Types: { id: string } → returns { trial: PrTrialDto }

Used by PR trials

PR trials: delete.

Types: { id: string } → returns { deleted: true }

Used by PR trials

PR trials: export.

Types: { id: string } → returns { report: PrTrialDto; protocolVersion: string }

Used by PR trials

PR trials: get.

Types: { id: string } → returns { trial: PrTrialDto }

Used by PR trials

PR trials: list.

Types: Record<string, never> → returns { trials: PrTrialDto[] }

Used by PR trials

PR trials: prepare.

Types: PreparePrTrialRequest → returns { trial: PrTrialDto }

Used by PR trials

PR trials: readiness.

Types: Record<string, never> → returns PrTrialReadiness

Used by PR trials

PR trials: review.

Types: { id: string; verdict: PrTrialVerdict; rationale: string; humanMinutes: number } → returns { trial: PrTrialDto }

Used by PR trials

PR trials: start.

Types: StartPrTrialRequest → returns { trial: PrTrialDto }

Used by PR trials

Deletes the public view.

Types: PublicViewIdRequest → returns OkResponse

Lists public views.

Types: EmptyRequest → returns ListPublicViewsResponse

Used by Command, Settings

Previews the public view.

Types: PublicViewIdRequest → returns PublicViewPayload

Used by Command, Settings

Rotates the public view slug.

Types: PublicViewIdRequest → returns PublicViewDto

Used by Command, Settings

Saves the public view.

Types: SavePublicViewRequest → returns PublicViewDto

Used by Command, Settings

Decides the worker training change.

Types: DecideWorkerTrainingChangeRequest → returns WorkerTrainingPlanDto

Used by Command, Workers

Gets worker quality.

Types: GetWorkerQualityRequest → returns WorkerQualityDto

Used by Command, Workers

Lists worker training plans.

Types: ListWorkerTrainingPlansRequest → returns ListResponse<WorkerTrainingPlanDto>

Used by Command, Workers

Proposes a worker training plan.

Types: ProposeWorkerTrainingPlanRequest → returns WorkerTrainingPlanDto

Used by Command, Workers

A tracked invite link for a share, or one invite email through the platform mailer.

Types: { channel: ReferralChannel; email?: string; name?: string } → returns { invite: ReferralInviteDto; link: string }

Used by Invite & earn

The seven "Build your team" steps, read from what exists, and the reward for all seven.

Types: Record<string, never> → returns ActivationChecklistDto

Used by Command, Invite & earn

Public: the inviter's first name and org name for a referral code, and the offer.

Types: { code: string } → returns ReferralLandingDto

The signed-in person's referral code, link, invites, level and rewards.

Types: Record<string, never> → returns ReferralSummaryDto

Used by Invite & earn

Uses one earned Free Org: Standard free for 12 months on this org or on a new org of your own.

Types: { target: 'this_org' } | { target: 'new_org'; orgName: string } → returns { orgId: string; planId: PlanId; expiresAt: string }

Used by Invite & earn

Goes the live anyway.

Types: GoLiveAnywayRequest → returns WorkerReadinessDto

Used by Workers

Rehearses the worker.

Types: RehearseWorkerRequest → returns WorkerReadinessDto

Used by Workers

Deletes the resource setup task.

Types: DeleteResourceSetupTaskRequest → returns ResourceDetailDto

Used by Command, Resources

Gets the resource.

Types: ResourceIdRequest → returns ResourceDetailDto

Used by Command, Resources

Lists resources.

Types: ListResourcesRequest → returns ListResponse<ResourceDto>

Used by Command, Resources

Retires the resource.

Types: ResourceIdRequest → returns ResourceDto

Used by Command, Resources

Saves the resource setup task.

Types: SaveResourceSetupTaskRequest → returns ResourceDetailDto

Used by Command, Resources

Sets the resource owner.

Types: SetResourceOwnerRequest → returns ResourceDetailDto

Used by Command, Resources

Syncs resources.

Types: EmptyRequest → returns SyncResourcesResponse

Used by Command, Resources

Saves the resource.

Types: UpsertResourceRequest → returns ResourceDto

Used by Command, Resources

Gets review stats.

Types: { scope?: ReviewScope; scopeId?: string; reviewerWorkerId?: string; days?: number } → returns { since: string; participants: ReviewParticipantStatsDto[] }

Used by Command, Workers

Lists review notes.

Types: { workItemId?: string; threadId?: string; reviewerWorkerId?: string; includeSilent?: boolean; limit?: number } → returns { notes: ReviewNoteDto[] }

Used by Command, CEO, Work item

Lists review participants.

Types: { scope?: ReviewScope; scopeId?: string; reviewerWorkerId?: string } → returns { participants: ReviewParticipantDto[] }

Used by CEO

Removes the review participant.

Types: { id: string } → returns { removed: boolean }

Used by CEO

Resolves the review note.

Types: { noteId: string; verdicts: ReviewVerdictInput[] } → returns ReviewNoteDto

Used by Command, Work item

Saves the review participant.

Types: SaveReviewParticipantRequest → returns ReviewParticipantDto

Used by CEO

Adds a work item dependency.

Types: AddWorkItemDependencyRequest → returns WorkItemDependenciesResponse

Used by Intake

Adds a work item link.

Types: AddWorkItemLinkRequest → returns WorkItemLinkDto

Approves the example.

Types: ApproveExampleRequest → returns ApprovedExampleDto

Used by Examples & Procedures

Archives memory.

Types: MemoryIdRequest → returns OkResponse

Used by Command, Memory

Cancels the runner task.

Types: RunnerTaskIdRequest → returns RunnerTaskDto

Used by Runners

Compiles rails.

Types: CompileRailsRequest → returns CompileRailsResponse

Used by Rules & Preferences

Connects the fallback key.

Types: ConnectFallbackKeyRequest → returns ConnectFallbackKeyResponse

Used by Brain & Models

Correct decision.

Types: CorrectDecisionRequest → returns CorrectDecisionResponse

Creates a document.

Types: CreateDocumentRequest → returns CreateDocumentResponse

Used by Documents

Creates a document comment.

Types: CreateDocumentCommentRequest → returns CreateDocumentCommentResponse

Used by Work item, Documents

Creates an integration.

Types: CreateIntegrationRequest → returns IntegrationDto

Used by Integrations

Creates a local runner.

Types: CreateLocalRunnerRequest → returns CreateLocalRunnerResult

Used by Runners

Creates memory.

Types: CreateMemoryRequest → returns CreateMemoryResponse

Used by Command, Workers, Memory

Creates policy.

Types: CreatePolicyRequest → returns PolicyDto

Used by Policies

Creates a runner task.

Types: CreateRunnerTaskRequest → returns RunnerTaskDto

Used by Runners

Creates a source.

Types: CreateSourceRequest → returns KnowledgeSourceDto

Used by Documents

Creates a work item.

Types: CreateWorkItemRequest → returns WorkItemDetail

Used by Board, Repository Atlas

Creates a worker.

Types: CreateWorkerRequest → returns WorkerDetail

Used by Command, Workers

Decides the approval.

Types: DecideApprovalRequest → returns ApprovalDto

Used by Command, Approvals

Decides the level change.

Types: DecideLevelChangeRequest → returns LevelChangeDto

Used by Workers, Levels & Evaluations

Removes the document and its chunks from search; the audit log keeps the record of it and of the removal.

Types: DeleteDocumentRequest → returns OkResponse

Used by Work item, Documents

Deletes the document comment.

Types: DeleteDocumentCommentRequest → returns OkResponse

Used by Work item, Documents

Deletes the intake poll.

Types: IntakePollIdRequest → returns OkResponse

Used by Intake

Deletes the integration.

Types: IntegrationIdRequest → returns OkResponse

Used by Integrations

Deletes policy.

Types: PolicyIdRequest → returns OkResponse

Used by Policies

Deletes provider config.

Types: DeleteProviderConfigRequest → returns OkResponse

Used by Brain & Models

Deletes the rule.

Types: RuleIdRequest → returns OkResponse

Used by Rules & Preferences

Deletes the work schedule.

Types: WorkScheduleIdRequest → returns OkResponse

Used by Intake

Discovers memories.

Types: DiscoverMemoriesRequest → returns DiscoverMemoriesResponse

Used by Command, Memory, Settings

An admin's API token may pull the brake, so an alerting hook can; only a signed-in admin releases it.

Types: EngageKillSwitchRequest → returns EngageKillSwitchResponse

Used by Settings

Explains the action.

Types: ExplainActionRequest → returns ExplainActionResponse

Used by Command, Approvals, Escalations, Work item, Audit Log

Explains the decision.

Types: ExplainDecisionRequest → returns ExplainDecisionResponse

Used by Command, Approvals, Escalations, Work item, Audit Log

Exports rules.

Types: ExportRulesRequest → returns ExportRulesResponse

Used by Rules & Preferences

Forgets memory.

Types: MemoryIdRequest → returns OkResponse

Used by Command, Memory

Gets the brain chain.

Types: GetBrainChainRequest → returns BrainChainResponse

Used by Brain & Models

Gets the context manifest.

Types: GetContextManifestRequest → returns GetContextManifestResponse

Used by Command, Observe, Board, Approvals, Escalations, Work item, Organization

Gets the department.

Types: GetDepartmentRequest → returns GetDepartmentResponse

Used by Command, Observe, Board, Organization

Gets the document.

Types: GetDocumentRequest → returns DocumentDto

Used by Work item, Documents

Gets the document revision.

Types: GetDocumentRevisionRequest → returns DocumentRevisionDto

Used by Command, Work item, Documents

Gets the fast path.

Types: GetFastPathRequest → returns FastPathDto

Used by Decisions

Gets the kill switch.

Types: EmptyRequest → returns KillSwitchDto

Used by Command, Settings

Gets live spend.

Types: GetLiveSpendRequest → returns LiveSpendResponse

Used by Usage & spend

Gets local runner settings.

Types: EmptyRequest → returns LocalRunnerSettingsDto

Used by Device sign-in, Onboarding, Runners

Gets memory.

Types: GetMemoryRequest → returns MemoryDto

Used by Command, Memory, Settings

Gets org brain defaults.

Types: EmptyRequest → returns OrgBrainDefaultsResponse

Used by Workers, Brain & Models

Gets org routing.

Types: EmptyRequest → returns OrgRoutingResponse

Used by Brain & Models

Gets org settings.

Types: EmptyRequest → returns OrgSettingsDto

Used by Command, Usage & spend, Settings

Gets overview.

Types: EmptyRequest → returns OverviewResponse

Used by Command

Gets preferences.

Types: GetPreferencesRequest → returns PreferencesView

Used by Command, Work item, Rules & Preferences

Gets the procedure.

Types: ProcedureIdRequest → returns ProcedureDetailDto

Gets procedure settings.

Types: EmptyRequest → returns ProcedureSettingsDto

Used by Examples & Procedures

Gets the project folder.

Types: GetProjectFolderRequest → returns ProjectFolderView

Used by Command, Work item

Gets project folder settings.

Types: EmptyRequest → returns ProjectFolderSettingsResponse

Gets the role.

Types: GetRoleRequest → returns RoleDto

Gets the rulebook candidate.

Types: GetRulebookCandidateRequest → returns GetRulebookCandidateResponse

Used by Rules & Preferences

Gets the runner task.

Types: GetRunnerTaskRequest → returns RunnerTaskDetailDto

Used by PR trials, Runners

Gets spend savings.

Types: GetSpendSavingsRequest → returns SpendSavingsResponse

Used by Command, Usage & spend

Gets the spend summary.

Types: GetSpendSummaryRequest → returns SpendSummaryResponse

Used by Command, Observe, Board, Organization, Brain & Models, Usage & spend

Gets the step boundary.

Types: GetStepBoundaryRequest → returns StepBoundaryDto

Used by Decisions

Gets the thread.

Types: GetThreadRequest → returns GetThreadResponse

Used by Command, Inbox, Work item, Workers

Gets the webhook URL.

Types: IntegrationIdRequest → returns WebhookUrlResponse

Used by Integrations

Gets the work item.

Types: GetWorkItemRequest → returns GetWorkItemResponse

Used by Command, Observe, Board, Work item, Organization

Gets work item actions.

Types: GetWorkItemActionsRequest → returns ListResponse<ActionDto>

Used by Command, Observe, Board, Work item, Organization

Gets the work item fast path.

Types: GetWorkItemFastPathRequest → returns GetWorkItemFastPathResponse

Used by Command, Work item

Gets work item model calls.

Types: GetWorkItemModelCallsRequest → returns PageResponse<WorkItemModelCallDto>

Used by Command, Work item

Gets work item model replay.

Types: import('./modelReplay.js').GetWorkItemModelReplayRequest → returns import('./modelReplay.js').GetWorkItemModelReplayResponse

Used by Work item

Gets the work item replay retention.

Types: { workItemId: string } → returns import('./modelReplay.js').SetWorkItemReplayRetentionResponse

Used by Work item

Gets work item routing.

Types: GetWorkItemRoutingRequest → returns WorkItemRoutingDto

Used by Command, Work item

Gets work item trace.

Types: GetWorkItemTraceRequest → returns GetWorkItemTraceResponse

Used by Command, Observe, Board, Work item, Organization

Gets the work plan graph.

Types: GetWorkPlanGraphRequest → returns WorkPlanGraphDto

Gets the worker.

Types: GetWorkerRequest → returns GetWorkerResponse

Used by Command, Observe, Board, Organization, Workers

Gets the worker drill.

Types: GetWorkerDrillRequest → returns GetWorkerDrillResponse

Used by Command, Observe, Board, Organization

Gets worker insights.

Types: GetWorkerInsightsRequest → returns WorkerInsightsResponse

Used by Observe, Work item, Workers, Usage & spend

Gets worker metrics.

Types: GetWorkerMetricsRequest → returns WorkerMetricsSummary

Used by Command, Workers, Levels & Evaluations

Gets worker model policy.

Types: GetWorkerModelPolicyRequest → returns WorkerModelPolicyResponse

Used by Workers

Gets worker spec history.

Types: GetWorkerSpecHistoryRequest → returns ListResponse<WorkerSpecVersionDto>

Used by Command, Workers

Gives feedback.

Types: GiveFeedbackRequest → returns FeedbackDto

Used by Command, Work item

Grants the integration.

Types: GrantIntegrationRequest → returns IntegrationDto

Used by Integrations

Learns procedures.

Types: EmptyRequest → returns LearnProceduresResponse

Used by Examples & Procedures

Lists approvals.

Types: ListApprovalsRequest → returns ListResponse<ApprovalDto>

Used by Command, Approvals

Lists approved examples.

Types: ListApprovedExamplesRequest → returns ListResponse<ApprovedExampleDto>

Used by Examples & Procedures

Lists connectors.

Types: EmptyRequest → returns ListResponse<ConnectorDto>

Used by Command, Workers, Documents, Integrations, Policies

Lists decision purposes.

Types: ListDecisionPurposesRequest → returns ListDecisionPurposesResponse

Used by Decisions

Lists document comments.

Types: ListDocumentCommentsRequest → returns ListDocumentCommentsResponse

Used by Work item, Documents

Lists document revisions.

Types: ListDocumentRevisionsRequest → returns ListDocumentRevisionsResponse

Used by Work item, Documents

Lists documents.

Types: ListDocumentsRequest → returns PageResponse<DocumentSummaryDto>

Used by Documents

Lists escalations.

Types: ListEscalationsRequest → returns PageResponse<EscalationDto>

Used by Command, Escalations

Lists evaluations.

Types: ListEvaluationsRequest → returns ListResponse<EvaluationDto>

Used by Command, Workers, Levels & Evaluations

Lists events.

Types: ListEventsRequest → returns PageResponse<AuditEvent>

Used by Command, Approvals, Escalations, Work item, Audit Log

Lists facts.

Types: ListFactsRequest → returns ListResponse<FactDto>

Used by Operating Model

Lists intake polls.

Types: EmptyRequest → returns ListResponse<IntakePollDto>

Used by Intake

Lists integrations.

Types: EmptyRequest → returns ListResponse<IntegrationDto>

Used by Intake, Documents, Integrations

Lists lesson outputs.

Types: ListLessonOutputsRequest → returns ListResponse<LessonOutputDto>

Used by Lessons

Lists lessons.

Types: ListLessonsRequest → returns ListResponse<LessonDto>

Used by Command, Workers, Lessons

Lists level changes.

Types: ListLevelChangesRequest → returns ListResponse<LevelChangeDto>

Used by Command, Workers, Levels & Evaluations

Lists local runners.

Types: ListLocalRunnersRequest → returns LocalRunnerListDto

Used by Onboarding, Runners

Lists memories.

Types: ListMemoriesRequest → returns PageResponse<MemoryDto>

Used by Command, Workers, Memory

Lists memory insights.

Types: ListMemoryInsightsRequest → returns ListMemoryInsightsResponse

Used by Command, Memory

Lists model calls.

Types: ListModelCallsRequest → returns PageResponse<ModelCallDto>

Used by Brain & Models

Lists policies.

Types: ListPoliciesRequest → returns ListResponse<PolicyDto>

Used by Command, Approvals, Policies

Lists procedures.

Types: ListProceduresRequest → returns ListResponse<ProcedureDto>

Used by Examples & Procedures

Lists providers.

Types: EmptyRequest → returns ListProvidersResponse

Used by Workers, Brain & Models

Lists rails.

Types: ListRailsRequest → returns ListRailsResponse

Used by Rules & Preferences

Lists roles.

Types: EmptyRequest → returns ListResponse<RoleDto>

Used by Command, Delivery, Workers, Roles, Integrations, Policies

Lists rule checkers.

Types: EmptyRequest → returns ListResponse<RuleCheckerDto>

Lists rulebook.

Types: ListRulebookRequest → returns ListRulebookResponse

Used by Rules & Preferences

Lists rules.

Types: ListRulesRequest → returns ListResponse<RuleDto>

Used by Rules & Preferences

Lists runner tasks.

Types: ListRunnerTasksRequest → returns RunnerTaskListDto

Used by Runners

Lists sources.

Types: EmptyRequest → returns ListResponse<KnowledgeSourceDto>

Used by Documents

Lists threads.

Types: ListThreadsRequest → returns PageResponse<ThreadDto>

Used by Command, Inbox, Work item

Lists work item checks.

Types: ListWorkItemChecksRequest → returns ListWorkItemChecksResponse

Used by Work item

Lists work item decisions.

Types: ListWorkItemDecisionsRequest → returns ListWorkItemDecisionsResponse

Used by Command, Work item

Lists work item evidence.

Types: ListWorkItemEvidenceRequest → returns ListResponse<WorkEvidenceDto>

Used by Command, Work item

Lists work item links.

Types: ListWorkItemLinksRequest → returns ListResponse<WorkItemLinkDto>

Lists work items.

Types: ListWorkItemsRequest → returns PageResponse<WorkItemSummary>

Used by Command, Board, Specs, Intake, Work item, Workers, Levels & Evaluations

Lists work schedule receipts.

Types: WorkScheduleIdRequest → returns ListResponse<WorkScheduleReceiptDto>

Used by Intake

Lists work schedules.

Types: EmptyRequest → returns ListResponse<WorkScheduleDto>

Used by Intake

Lists worker activity.

Types: ListWorkerActivityRequest → returns PageResponse<AuditEvent>

Used by Command, Workers

Lists workers.

Types: ListWorkersRequest → returns ListResponse<WorkerSummary>

Used by Command, CEO, Observe, Office, Board, Delivery, Inbox, Work item, Organization, Workers, Roles, Levels & Evaluations, Members, API tokens, Settings, Billing settings

Pins the example.

Types: PinExampleRequest → returns ApprovedExampleDto

Used by Examples & Procedures

Posts the message.

Types: PostMessageRequest → returns MessageDto

Used by Command, Inbox, Work item, Workers

Posts the work item message.

Types: PostWorkItemMessageRequest → returns MessageDto

Used by Command, Inbox, Work item

Previews the rule.

Types: PreviewRuleRequest → returns PreviewRuleResponse

Used by Rules & Preferences

Previews the work schedule.

Types: PreviewWorkScheduleRequest → returns SchedulePreviewDto

Used by Intake

Previews worker configuration.

Types: CreateWorkerRequest → returns WorkerConfigurationPreviewDto

Used by Command, Workers