Interface AgentRunsApi

interface AgentRunsApi {
    cancelScheduled(
        input: AgentRunsCancelScheduledInput,
    ): Promise<AgentScheduledRunResult>;
    get(input: AgentRunsGetInput): Promise<AgentRunsGetResult>;
    listScheduled(): Promise<AgentScheduledRunsListResult>;
    schedule(input: AgentRunsScheduleInput): Promise<AgentScheduledRunResult>;
}

Index

Methods

cancelScheduled get listScheduled schedule

Methods

cancelScheduled

cancelScheduled(
input: AgentRunsCancelScheduledInput,
): Promise<AgentScheduledRunResult>
Cancel a still-pending scheduled run (§27.5); a non-pending run resolves { ok: false, code: 'run-not-cancellable' }.
Parameters
- input: AgentRunsCancelScheduledInput
Returns Promise<AgentScheduledRunResult>

get

get(input: AgentRunsGetInput): Promise<AgentRunsGetResult>
Parameters
- input: AgentRunsGetInput
Returns Promise<AgentRunsGetResult>

listScheduled

listScheduled(): Promise<AgentScheduledRunsListResult>

The calling project's recent scheduled runs (§27.5), id-free and newest-first.

Returns Promise<AgentScheduledRunsListResult>

schedule

schedule(input: AgentRunsScheduleInput): Promise<AgentScheduledRunResult>
Queue a one-shot overnight run for later (§27.5). Same hosted-runs grant as get; the host attests the schedule-time grant proof, so you never supply it. Resolves an id-free typed union.
Parameters
- input: AgentRunsScheduleInput
Returns Promise<AgentScheduledRunResult>