Agent

The agent_definition object

An AI agent available to the account.

The definition describes what the agent does, how its runs are triggered, the tools it can use, and whether it is currently enabled for the account.

idstring

Agent definition ID.

objectstringenumValues:agent_definition

Resource type identifier.

definition_typestringenumValues:systemcustom

Whether the agent is provided by Augno or created in this account.

system: provided by Augno; cannot be edited or deleted.
custom: created by a user in this account.

category_codestring

Category grouping for the agent (e.g. order_processing), used to organize agents in the UI.

trigger_typestringenumValues:scheduledmanualevent

How runs of this agent are initiated.

scheduled: runs on a cron schedule (see config.trigger_config.cron_schedule).
event: runs in response to platform events (see config.trigger_config.event_filters).
manual: runs only when explicitly invoked.
chat: runs in response to a chat message; the run is linked to a conversation and posts its reply back into it.

namestring

Human-readable name of the agent.

slugstring

URL-friendly identifier for the agent.

Unique within the account.

descriptionstringnullable

Description of what the agent does.

editabilitystringenumValues:editableread_only

Whether this agent definition can be edited.

Always read_only for system definitions.

statusstringenumValues:activeinactive

Whether this agent is enabled for the current account.

Activation is per-account: a system agent shared across accounts can be active for one account and inactive for another. An inactive agent cannot be triggered.

rolerolenullable

Role defining the permissions the agent operates with.

The agent acts as its own actor, and everything it does is authorized against this role — it can never reach data or actions the role does not grant. An agent with no role cannot execute: its runs fail immediately.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name of the role.

Unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The type gates behavior that individual permissions do not cover, and some actions are reserved for a single role type.

admin: full administrative access. Sensitive areas such as API keys, billing, and third-party integrations are restricted to admins no matter what permissions another role holds.
user: a custom role tailored to a specific need, with its permissions defined explicitly. Roles created through the API always have this type.
scanner: the role used by shop-floor scanning stations, assigned automatically when a scanning-station user is created.
sales_rep: a role for sales representatives. Order analytics are scoped to the rep's own orders.
agent: a role assigned to an automated agent rather than a person.

ownerownernullable

Provenance of this role.

System-owned roles are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned roles are custom to your account.

Always returned as null in this endpoint.

permissionsarray of stringnullable

Permissions granted by this role, in {permission}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

configagent_definition_confignullable

Agent-level configuration controlling LLM behavior and trigger settings.

objectstringenumValues:agent_definition_config

Resource type identifier.

system_promptstringnullable

Standing instructions that define the agent's role and how it should behave on every run.

tierstringnullableenumValues:frontierhighbalanced

Intelligence and cost tier for the agent's reasoning.

Selects how capable and expensive a model the agent uses without pinning a specific model; higher tiers reason better but cost more. Each tier resolves to an ordered chain of equivalent models, so a run automatically fails over to another provider's model if the preferred one is unavailable.

frontier: the most capable tier, for multi-step planning, ambiguous agent work, and hard coding or architecture tasks.
high: for normal planning, code edits, synthesis, and customer-facing reasoning.
balanced: for research, summarization, classification, structured extraction, and light tool use.
cheap: for simple transforms, validation, formatting, and routing.
legacy: older-generation models kept for compatibility and regression comparison; avoid unless you specifically need them.

Leaving the tier unset picks one from how the agent is triggered: chat and manual runs use high, while scheduled and event-driven runs use balanced so background work stays cheap.

temperaturenumbernullable

LLM sampling temperature between 0 and 1.

Lower values make the agent's output more repeatable and literal; higher values make it more varied.

trigger_configtrigger_confignullable

Trigger-specific configuration.

Shape depends on the agent's trigger_type.

Always returned as null in this endpoint.

endpoint_tool_slugsarray of string

API-endpoint tools the agent may discover and use, by slug (e.g. create_account_group).

These correspond to tools listed by the List Tools endpoint with category api_endpoint. A single entry * grants the entire endpoint-tool catalog.

endpoint_tool_reviewobject

Per-endpoint-tool human-review overrides, keyed by tool slug.

When an entry is true, the run pauses in awaiting_approval each time the agent calls that endpoint-tool until it is approved via the Continue Agent Run endpoint. Slugs absent from the map do not require review.

toolslistnullable

Tools attached to this agent.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of agent_definition_tool

Resources in this page.

idstring

Agent definition tool ID.

objectstringenumValues:agent_definition_tool

Resource type identifier.

toolavailable_tool

Attached tool.

Always returned as null in this endpoint.

review_requirementstringenumValues:not_requiredrequired

Whether calls to this tool must be approved by a user before they execute.

When required, the run pauses in the awaiting_approval status each time the agent invokes this tool; approve or allow the tool via the Continue Agent Run endpoint to proceed. A tool whose mutating flag is true still pauses for approval even when this is not_required.

configobjectnullable

Instance-specific configuration for this tool.

Must conform to the tool's config_schema.

Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.

sort_orderinteger

Sort order within the agent.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Used by

agent_definition example

{
  "id": "agdf_ah7tkyfxk8jl",
  "object": "agent_definition",
  "definition_type": "system",
  "category_code": "order_processing",
  "trigger_type": "event",
  "name": "Email Order Agent",
  "slug": "email_order",
  "description": "Processes incoming emails and creates draft orders.",
  "editability": "read_only",
  "status": "inactive",
  "role": {
    "id": "rl_3xknmfqflhvb",
    "object": "role",
    "name": "Admin",
    "type": "admin",
    "owner": {
      "object": "owner",
      "type": "account",
      "account": {
        "id": "ac_ykxoradjoeb3",
        "object": "account",
        "name": "Acme Inc.",
        "default_billing_address": null,
        "default_shipping_address": null,
        "branding": null,
        "portal": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    },
    "permissions": [
      "customers:create",
      "customers:read",
      "customers:update",
      "customers:delete"
    ],
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "config": {
    "object": "agent_definition_config",
    "system_prompt": "You are an order processing agent. Parse incoming emails and create draft orders.",
    "tier": "high",
    "temperature": 0.2,
    "trigger_config": {
      "object": "trigger_config",
      "cron_schedule": null,
      "timezone": null,
      "event_filters": [
        "email.received"
      ]
    },
    "endpoint_tool_slugs": [
      "create_account_group"
    ],
    "endpoint_tool_review": {
      "create_account_group": true
    }
  },
  "tools": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "agdftl_iyc1asmsg1pu",
        "object": "agent_definition_tool",
        "tool": {
          "object": "available_tool",
          "slug": "read_doc",
          "category": "built_in",
          "name": "Lookup Customer",
          "description": "Look up a customer by their email address.",
          "config_schema": null,
          "required_permissions": [
            "customers:read"
          ],
          "required_role_type": null,
          "mutating": false
        },
        "review_requirement": "not_required",
        "config": {},
        "sort_order": 0
      }
    ]
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "agdf_ah7tkyfxk8jl",
  "object": "agent_definition",
  "definition_type": "system",
  "category_code": "order_processing",
  "trigger_type": "event",
  "name": "Email Order Agent",
  "slug": "email_order",
  "description": "Processes incoming emails and creates draft orders.",
  "editability": "read_only",
  "status": "inactive",
  "role": {
    "id": "rl_3xknmfqflhvb",
    "object": "role",
    "name": "Admin",
    "type": "admin",
    "owner": {
      "object": "owner",
      "type": "account",
      "account": {
        "id": "ac_ykxoradjoeb3",
        "object": "account",
        "name": "Acme Inc.",
        "default_billing_address": null,
        "default_shipping_address": null,
        "branding": null,
        "portal": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    },
    "permissions": [
      "customers:create",
      "customers:read",
      "customers:update",
      "customers:delete"
    ],
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "config": {
    "object": "agent_definition_config",
    "system_prompt": "You are an order processing agent. Parse incoming emails and create draft orders.",
    "tier": "high",
    "temperature": 0.2,
    "trigger_config": {
      "object": "trigger_config",
      "cron_schedule": null,
      "timezone": null,
      "event_filters": [
        "email.received"
      ]
    },
    "endpoint_tool_slugs": [
      "create_account_group"
    ],
    "endpoint_tool_review": {
      "create_account_group": true
    }
  },
  "tools": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "agdftl_iyc1asmsg1pu",
        "object": "agent_definition_tool",
        "tool": {
          "object": "available_tool",
          "slug": "read_doc",
          "category": "built_in",
          "name": "Lookup Customer",
          "description": "Look up a customer by their email address.",
          "config_schema": null,
          "required_permissions": [
            "customers:read"
          ],
          "required_role_type": null,
          "mutating": false
        },
        "review_requirement": "not_required",
        "config": {},
        "sort_order": 0
      }
    ]
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Agent

Attributes

Used by