> ISPO SDK documentation. [HTML](https://ispo.ai/docs/interfaces/core.AgentRunsApi.html) · [Documentation index](https://ispo.ai/docs/llms.txt)

# Interface AgentRunsApi

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

Types: [cancelScheduled](#cancelscheduled-1), [AgentRunsCancelScheduledInput](core.AgentRunsCancelScheduledInput.md), [AgentScheduledRunResult](../types/core.AgentScheduledRunResult.md), [get](#get-1), [AgentRunsGetInput](core.AgentRunsGetInput.md), [AgentRunsGetResult](core.AgentRunsGetResult.md), [listScheduled](#listscheduled-1), [AgentScheduledRunsListResult](../types/core.AgentScheduledRunsListResult.md), [schedule](#schedule-1), [AgentRunsScheduleInput](core.AgentRunsScheduleInput.md)

##### Index

### <a id="methods"></a>Methods

[cancelScheduled](#cancelscheduled) [get](#get) [listScheduled](#listscheduled) [schedule](#schedule)

## <a id="methods-1"></a>Methods

### <a id="cancelscheduled"></a>cancelScheduled

*   <a id="cancelscheduled-1"></a>
    
    ```typescript
    cancelScheduled(
        input: AgentRunsCancelScheduledInput,
    ): Promise<AgentScheduledRunResult>
    ```
    
    Types: [AgentRunsCancelScheduledInput](core.AgentRunsCancelScheduledInput.md), [AgentScheduledRunResult](../types/core.AgentScheduledRunResult.md)
    
    Cancel a still-pending scheduled run (§27.5); a non-pending run resolves `{ ok: false, code: 'run-not-cancellable' }`.
    
    #### Parameters
    
    *   input: [AgentRunsCancelScheduledInput](core.AgentRunsCancelScheduledInput.md)
    
    #### Returns Promise<[AgentScheduledRunResult](../types/core.AgentScheduledRunResult.md)\>
    

### <a id="get"></a>get

*   <a id="get-1"></a>
    
    ```typescript
    get(input: AgentRunsGetInput): Promise<AgentRunsGetResult>
    ```
    
    Types: [AgentRunsGetInput](core.AgentRunsGetInput.md), [AgentRunsGetResult](core.AgentRunsGetResult.md)
    
    #### Parameters
    
    *   input: [AgentRunsGetInput](core.AgentRunsGetInput.md)
    
    #### Returns Promise<[AgentRunsGetResult](core.AgentRunsGetResult.md)\>
    

### <a id="listscheduled"></a>listScheduled

*   <a id="listscheduled-1"></a>
    
    ```typescript
    listScheduled(): Promise<AgentScheduledRunsListResult>
    ```
    
    Types: [AgentScheduledRunsListResult](../types/core.AgentScheduledRunsListResult.md)
    
    The calling project's recent scheduled runs (§27.5), id-free and newest-first.
    
    #### Returns Promise<[AgentScheduledRunsListResult](../types/core.AgentScheduledRunsListResult.md)\>
    

### <a id="schedule"></a>schedule

*   <a id="schedule-1"></a>
    
    ```typescript
    schedule(input: AgentRunsScheduleInput): Promise<AgentScheduledRunResult>
    ```
    
    Types: [AgentRunsScheduleInput](core.AgentRunsScheduleInput.md), [AgentScheduledRunResult](../types/core.AgentScheduledRunResult.md)
    
    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](core.AgentRunsScheduleInput.md)
    
    #### Returns Promise<[AgentScheduledRunResult](../types/core.AgentScheduledRunResult.md)\>