SDK: kit

The kit area has 20 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

kitAttemptsRecord

Record a finished loop iteration and judge the task

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/kit/attempts

kitAttemptsRecord(args: { tenantId: string; projectId: string; body: AttemptReport }, options?: CallOptions): Promise<AttemptResult>

kitNext

The next task a run should take

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/kit/next

kitNext(args: { tenantId: string; projectId: string; query?: { executor?: string } }, options?: CallOptions): Promise<NextRunnable>

kitOverview

A project’s run overview

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/kit/overview

kitOverview(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<Record<string, unknown>>

kitPlanSync

Sync a plan into tasks

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/kit/plan/sync

kitPlanSync(args: { tenantId: string; projectId: string; body: PlanSyncRequest }, options?: CallOptions): Promise<PlanSyncResult>

kitPolicyGet

Read a project’s run policy

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/kit/policy

kitPolicyGet(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<RunPolicy>

kitPolicyPut

Set a project’s run policy (policy class)

• Request: PUT on /v1/tenants/{tenantId}/projects/{projectId}/kit/policy
• Needs an approval for agents: class policy_change

kitPolicyPut(args: { tenantId: string; projectId: string; body: RunPolicy }, options?: CallOptions): Promise<RunPolicy>

kitReport

The morning report for a window

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/kit/report

kitReport(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<Record<string, unknown>>

kitReportDeliver

Put the morning report for the last report time in the team inbox, once

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/kit/report/deliver

kitReportDeliver(args: { tenantId: string; projectId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

kitRunClaimNext

Claim the next runnable task under a run, in one step

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/kit/runs/{runId}/claim-next

kitRunClaimNext(args: { tenantId: string; projectId: string; runId: string; body: ClaimNextRequest }, options?: CallOptions): Promise<ClaimNextResult>

kitRunDecision

Record a decision in a run

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/kit/runs/{runId}/decisions

kitRunDecision(args: { tenantId: string; projectId: string; runId: string; body: RecordDecisionRequest }, options?: CallOptions): Promise<AgentDecision>

kitRunEnd

End a run

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/kit/runs/{runId}/end

kitRunEnd(args: { tenantId: string; projectId: string; runId: string; body: EndRunRequest }, options?: CallOptions): Promise<RunRecord>

kitRunGet

Read a run

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/kit/runs/{runId}

kitRunGet(args: { tenantId: string; projectId: string; runId: string }, options?: CallOptions): Promise<RunRecord>

kitRunPull

Open the pull request for a task the run claimed

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/kit/runs/{runId}/pull

kitRunPull(args: { tenantId: string; projectId: string; runId: string; body: RunPullRequest }, options?: CallOptions): Promise<RunPullResult>

kitRunsList

List runs

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/kit/runs

kitRunsList(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<Record<string, unknown>>

kitRunsStart

Start a run

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/kit/runs

kitRunsStart(args: { tenantId: string; projectId: string; body: StartRunRequest }, options?: CallOptions): Promise<RunRecord>

kitUsageEventsDelete

Delete the caller’s loop usage events in a project

• Request: DELETE on /v1/tenants/{tenantId}/projects/{projectId}/kit/usage-events

kitUsageEventsDelete(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<LoopUsageEventsDeleted>

kitUsageEventsList

The caller’s loop usage events in a project

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/kit/usage-events

kitUsageEventsList(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<LoopUsageEventList>

kitUsagePolicyGet

A project’s usage policy, the caller’s own caps, the cap that applies and each client’s eligibility

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/kit/usage-policy

kitUsagePolicyGet(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<UsagePolicyView>

kitUsagePolicyProjectPut

Set a project’s usage policy (policy class)

• Request: PUT on /v1/tenants/{tenantId}/projects/{projectId}/kit/usage-policy/project
• Needs an approval for agents: class policy_change

kitUsagePolicyProjectPut(args: { tenantId: string; projectId: string; body: UsagePolicy }, options?: CallOptions): Promise<Record<string, unknown>>

kitUsagePolicyUserPut

Set the caller’s own usage caps and whether usage events may be shared

• Request: PUT on /v1/tenants/{tenantId}/projects/{projectId}/kit/usage-policy/user

kitUsagePolicyUserPut(args: { tenantId: string; projectId: string; body: UserUsageSettings }, options?: CallOptions): Promise<Record<string, unknown>>