@archastro/sdk
    Preparing search index...

    Interface AgentSchedule

    A scheduled task created by an agent. Supports one-time and recurring (cron-based) execution patterns.

    interface AgentSchedule {
        agent?: string;
        app?: string;
        created_at?: string;
        cron_expression?: string;
        id: string;
        instructions?: string;
        last_run_at?: string;
        max_runs?: number;
        metadata?: Record<string, unknown>;
        next_run_at?: string;
        run_count?: number;
        schedule_type?: string;
        scheduled_at?: string;
        status?: string;
        thread?: string;
        timezone?: string;
        updated_at?: string;
    }
    Index

    Properties

    agent? app? created_at? cron_expression? id instructions? last_run_at? max_runs? metadata? next_run_at? run_count? schedule_type? scheduled_at? status? thread? timezone? updated_at?

    Properties

    agent?: string

    ID of the agent that owns this schedule (agi_...).

    app?: string

    ID of the application the schedule belongs to (dap_...).

    created_at?: string

    When the schedule was created (ISO 8601).

    cron_expression?: string

    Standard cron expression defining the recurrence pattern (e.g. "0 9 * * 1"). Present only when schedule_type is "recurring". null for one-time schedules.

    id: string

    Schedule ID (asc_...).

    instructions?: string

    The task description the agent will execute when this schedule fires.

    last_run_at?: string

    UTC datetime of the most recent successful execution. null if the schedule has never run.

    max_runs?: number

    Maximum number of times a recurring schedule may fire before automatically transitioning to "completed". null means no limit.

    metadata?: Record<string, unknown>

    Arbitrary key-value pairs attached to the schedule by the agent. Not interpreted by the platform.

    next_run_at?: string

    UTC datetime of the next planned execution. null if the schedule has completed, been cancelled, or has not yet been computed.

    run_count?: number

    Total number of times this schedule has fired.

    schedule_type?: string

    Determines how the schedule repeats. "once" fires a single time at scheduled_at then transitions to "completed". "recurring" fires on the cron_expression and reschedules automatically.

    scheduled_at?: string

    The exact UTC datetime at which a one-time schedule fires. Present only when schedule_type is "once". null for recurring schedules.

    status?: string

    Current lifecycle status of the schedule. One of "active" (will fire as planned), "paused" (temporarily suspended), "completed" (has run its last execution), "cancelled" (manually stopped), or "expired" (past its valid window).

    thread?: string

    Thread ID (thr_...) this schedule is bound to. When set, the scheduled task is delivered into the thread rather than creating a new session. null for session-based schedules.

    timezone?: string

    IANA timezone name used to interpret the cron expression or scheduled_at (e.g. "America/New_York"). Defaults to "Etc/UTC".

    updated_at?: string

    When the schedule was last modified (ISO 8601).

    Settings

    Member Visibility

    On This Page

    Properties