@archastro/sdk
    Preparing search index...

    Interface AgentCreateResponse

    The response returned by POST /api/v1/agents. Contains all agent fields plus an optional installed_configs array when a template_bundle was supplied in the request.

    interface AgentCreateResponse {
        acl?: Acl;
        app?: string;
        created_at?: string;
        default_model?: string;
        email?: string;
        id: string;
        identity?: string;
        installed_configs?: InstalledConfigEntry[];
        lookup_key?: string;
        metadata?: Record<string, unknown>;
        name?: string;
        org?: string;
        originator?: string;
        phone_number?: string;
        sandbox?: string;
        team?: string;
        updated_at?: string;
        user?: string;
    }
    Index

    Properties

    acl? app? created_at? default_model? email? id identity? installed_configs? lookup_key? metadata? name? org? originator? phone_number? sandbox? team? updated_at? user?

    Properties

    acl?: Acl

    Access control list governing who can interact with this agent. Contains a grants array where each entry specifies principal_type, principal, and actions. null when no ACL restrictions are applied.

    app?: string

    ID of the app this agent belongs to (dap_...).

    created_at?: string

    When the agent was created (ISO 8601).

    default_model?: string

    Default AI model the agent uses when no model is specified at runtime, e.g. "claude-3-5-sonnet-20241022". null if not configured.

    email?: string

    Email address assigned to this agent for inbound email handling. null if not configured.

    id: string

    Agent ID (agi_...).

    identity?: string

    System prompt or persona description that shapes the agent's behavior. null if not set.

    installed_configs?: InstalledConfigEntry[]

    List of config records created as part of this request's template_bundle install. One entry per persisted config, sorted by key. Omitted entirely when the request did not include a template_bundle.

    lookup_key?: string

    Unique, stable identifier for the agent within its app. null if not set.

    metadata?: Record<string, unknown>

    Arbitrary key-value metadata attached to the agent. null if none was provided.

    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 for agents outside an org.

    originator?: string

    Free-form label identifying the source or author of the agent, e.g. a username or service name. null if not set.

    phone_number?: string

    Phone number assigned to this agent for inbound SMS or voice handling. null if not configured.

    sandbox?: string

    ID of the sandbox environment this agent is scoped to (sbx_...). null for agents not scoped to a sandbox.

    team?: string

    ID of the team that owns this agent (tea_...). null if owned by a user rather than a team.

    updated_at?: string

    When the agent record was last modified (ISO 8601).

    user?: string

    ID of the user that owns this agent (usr_...). null if owned by a team.

    Settings

    Member Visibility

    On This Page

    Properties