@archastro/sdk
    Preparing search index...

    Interface Agent

    An AI agent that can be configured with tools, routines, and skills, and invoked to handle conversations or tasks.

    interface Agent {
        acl?: Acl;
        app?: string;
        created_at?: string;
        default_model?: string;
        email?: string;
        id: string;
        identity?: string;
        last_applied_template_config?: string;
        lookup_key?: string;
        metadata?: Record<string, unknown>;
        name?: string;
        org?: string;
        org_name?: string;
        originator?: string;
        phone_number?: string;
        sandbox?: string;
        source_solution?: AgentSourceSolution;
        team?: string;
        template_upgrade_available?: boolean;
        updated_at?: string;
        user?: string;
    }
    Index

    Properties

    acl? app? created_at? default_model? email? id identity? last_applied_template_config? lookup_key? metadata? name? org? org_name? originator? phone_number? sandbox? source_solution? team? template_upgrade_available? updated_at? user?

    Properties

    acl?: Acl

    Access control list for the agent. Contains a grants array where each entry specifies principal_type, principal, and actions. null when no ACL restrictions are applied and the agent is accessible to all members of its scope.

    app?: string

    ID of the application that owns this agent (dap_...).

    created_at?: string

    When the agent was created (ISO 8601).

    default_model?: string

    Default LLM model identifier used by this agent when no model is specified at runtime (e.g. "claude-3-7-sonnet-latest").

    email?: string

    Email address provisioned for this agent. null if email delivery is not configured.

    id: string

    Agent ID (agi_...).

    identity?: string

    System-level identity prompt that shapes the agent's persona and behavior.

    last_applied_template_config?: string

    ID of the AgentTemplate config (cfg_...) this agent was last provisioned or updated from. null for manually created agents.

    lookup_key?: string

    Stable, user-defined identifier for this agent within the application. Unique per app.

    metadata?: Record<string, unknown>

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

    name?: string

    Human-readable display name for the agent. null if not set.

    org?: string

    ID of the organization this agent belongs to (org_...). null if the agent is not org-scoped.

    org_name?: string

    Display name of the organization this agent belongs to. null when the agent is not org-scoped or when the org association was not preloaded.

    originator?: string

    Free-form label identifying the source or author that created this agent (e.g. a username or pipeline name).

    phone_number?: string

    Phone number provisioned for this agent. null if SMS is not configured.

    sandbox?: string

    ID of the sandbox environment this agent is scoped to (dsb_...). null in production deployments.

    source_solution?: AgentSourceSolution

    Source Solution and AgentTemplate summary for agents provisioned from a Solution. Includes upgrade_available, latest_version, and latest_solution so you can render an upgrade badge without a separate dry-run call. null for hand-built agents and agents whose tracked template or parent Solution has been deleted. Populated only on single-agent GET responses, never on list endpoints.

    team?: string

    ID of the team that owns this agent (tem_...). null if the agent is not team-scoped.

    template_upgrade_available?: boolean

    True when the agent's last-applied template version is behind the current version of its AgentTemplate config — i.e. reapplying the template (a per-agent upgrade) would bring it newer Solution content. Self-clears once the agent is reapplied. Computed only on list endpoints; null on single-agent GET.

    updated_at?: string

    When the agent was last modified (ISO 8601).

    user?: string

    ID of the user that owns this agent (usr_...). null if the agent is not user-scoped.

    Settings

    Member Visibility

    On This Page

    Properties