1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. CreateAgentTaskRequest

CreateAgentTaskRequest

    Create a new task by sending the first event in the conversation.

    Properties

    • message AgentUserEventMessage optional
      The message content
    • content string required
      The exact natural language instruction from the user.
    • entity_diff AgentEntityDiff optional
      Entities to add or remove from the agent.
    • commands map[string]AgentSlashCommand optional
      Slash Commands the user selected when creating their message.
    • timestamp string required
      When the event occurred.
    • type string required
    • approvalMode enum optional
      Optional approval mode override for this task. If omitted, org default is used.
      Values: manual, auto, balanced
    • planMode boolean optional
      Whether to enable plan mode for this task.
    • permissionMode enum optional
      Controls the permission scope for the task. When omitted, defaults to ‘default’ (the agent uses the creating user’s full permissions).
      Values: default, read-only
    • toolExecutionMode enum optional
      Where tools should be executed. Defaults to ‘cloud’ if omitted.
      Values: cloud, cli
    • enabledIntegrations array[AgentTaskIntegrationRef] optional
      Optional list of integrations to enable for this task. Semantics: omitted/null → inherit all org-enabled integrations; empty list → explicit opt-out (no integration credentials for this task); populated list → whitelist of specific integrations by ID. Modeled as an object array rather than a bare string array so multi-instance support (instance_name, scope, etc.) can be added later without a wire break.
    • id string required
      The catalog integration ID (e.g. ‘honeycomb’, ‘datadog’).