@archastro/sdk
    Preparing search index...

    Interface Task

    A task representing a unit of work, optionally assignable to a user or agent.

    interface Task {
        agent?: string | null;
        aggregate_version?: number | null;
        blocked_by_count?: number;
        closed_at?: string | null;
        comments_count?: number;
        created_at?: string;
        created_by_actor?: Actor | null;
        created_by_agent?: string | null;
        created_by_user?: string | null;
        current_lease?: TaskSessionLeaseSummary | null;
        description?: string | null;
        due_date?: string | null;
        epic?: string | null;
        id: string;
        is_blocked?: boolean;
        links?: Record<string, unknown>;
        metadata?: Record<string, unknown>;
        name: string;
        org?: string | null;
        owner_actor?: Actor | null;
        owner_agent?: string | null;
        owner_user?: string | null;
        parent?: string | null;
        priority?: number;
        sandbox?: string | null;
        source_id?: string | null;
        source_scope?: string | null;
        source_type?: string | null;
        status: string;
        subtasks_count?: number;
        tags?: string[];
        team?: string | null;
        thread?: string | null;
        updated_at?: string;
        user?: string | null;
    }
    Index

    Properties

    agent? aggregate_version? blocked_by_count? closed_at? comments_count? created_at? created_by_actor? created_by_agent? created_by_user? current_lease? description? due_date? epic? id is_blocked? links? metadata? name org? owner_actor? owner_agent? owner_user? parent? priority? sandbox? source_id? source_scope? source_type? status subtasks_count? tags? team? thread? updated_at? user?

    Properties

    agent?: string | null

    ID of the agent that owns this task (agi_...). null if the task is scoped to a team or user.

    aggregate_version?: number | null

    Event-stream version for optimistic update fencing. Pass this value as expected_version on an update to reject concurrent writes.

    blocked_by_count?: number

    Number of tasks marked as blocking this task, whether or not they are done (see GET /tasks/{task}/blockers). Computed on list/show reads; create/update responses may lag one read behind.

    closed_at?: string | null

    When the task was marked as done or otherwise closed (ISO 8601). null if the task is still open.

    comments_count?: number

    Total number of comments posted on this task.

    created_at?: string

    When the task was created (ISO 8601).

    created_by_actor?: Actor | null

    Resolved creator details including id, name, alias, and profile_picture. null if no creator is set or the creator cannot be resolved (e.g. creating agent was deleted).

    created_by_agent?: string | null

    ID of the agent that created this task (agi_...). null if the task was created by a human user, or if the creating agent was later deleted.

    created_by_user?: string | null

    ID of the user who created this task (usr_...). null if the task was created by an agent, or if creator provenance was cleared after the creator was deleted.

    current_lease?: TaskSessionLeaseSummary | null

    Viewer-safe live coding-session lease summary. null when the task is unleased or the projected lease has expired. Fencing identifiers are never included.

    description?: string | null

    Long-form description or notes for the task. null if no description has been provided.

    due_date?: string | null

    Date and time by which the task should be completed (ISO 8601). null if no due date is set.

    epic?: string | null

    Free-form grouping label. null when the task is not in an epic.

    id: string

    Task ID (tsk_...).

    is_blocked?: boolean

    true while at least one blocking task is not yet done. Informational only — a blocked task can still change status — and derived at read time, so the task un-blocks automatically when its last open blocker completes. Computed on list/show reads; create/update responses report false until the next read.

    links?: Record<string, unknown>

    Key-value map of named URLs or references associated with the task. Returns an empty object when no links have been set.

    metadata?: Record<string, unknown>

    Arbitrary key-value map of application-specific data stored alongside the task. Returns an empty object when no metadata has been set.

    name: string

    Human-readable title of the task.

    org?: string | null

    ID of the organization this task belongs to (org_...). null for tasks outside an org context.

    owner_actor?: Actor | null

    Resolved owner details including id, name, alias, and profile_picture. null if the task is unassigned or the owner cannot be resolved (e.g. assigned agent was deleted).

    owner_agent?: string | null

    ID of the agent assigned as owner (agi_...). null if the owner is a human user, the task is unassigned, or the assigned agent was deleted.

    owner_user?: string | null

    ID of the user assigned as owner (usr_...). null if the owner is an agent, the task is unassigned, or the assigned agent was deleted.

    parent?: string | null

    ID of the parent task when this task is a subtask (tsk_...). null for top-level tasks. Subtasks nest exactly one level.

    priority?: number

    Priority level of the task from 0 (highest) to 4 (lowest). Defaults to 2 (medium) when not explicitly set.

    sandbox?: string | null

    ID of the developer sandbox this task is scoped to (dsb_...). null for tasks outside a sandbox environment.

    source_id?: string | null

    Source object identity (for example ArchAstro/firstlanding). null when the task has no source.

    source_scope?: string | null

    Container of the work this task is about (for example github.com). null when the task has no source. Set together with source_type and source_id.

    source_type?: string | null

    Kind of source object (for example repository). null when the task has no source.

    status: string

    Current status of the task. One of "open", "in_progress", "in_review", or "done".

    subtasks_count?: number

    Number of subtasks under this task. Computed on list/show reads; create/update responses may report 0 until the next read. Always 0 for subtasks.

    tags?: string[]

    Labels for grouping and filtering, stored lowercase and de-duplicated. Empty array when untagged.

    team?: string | null

    ID of the team that owns this task (tem_...). null if the task is not scoped to a team.

    thread?: string | null

    ID of the thread this task is bound to (thr_...) — the conversation it was filed from, or the thread passed at creation. null for tasks not tied to a thread.

    updated_at?: string

    When the task was last modified (ISO 8601).

    user?: string | null

    ID of the user that owns this task (usr_...). null if the task is scoped to a team.

    Settings

    Member Visibility

    On This Page

    Properties