WorkflowAgentWrite

  • analysis_prompt
    Type: string
    required

    The prompt that tells Resia how to read the run's outcome into the analysis result.

  • analysis_schema
    Type: ResiaJsonObject
    required

    A JSON Schema (draft 2020-12) the run's analysis result is shaped by. Use a JSON Schema object, not the legacy fields format.

    Properties: 1
  • calling_window_end_local_time
    Type: stringFormat: time
    required

    The latest local clock time a run may place a call, as HH:MM:SS. It must be after calling_window_start_local_time.

  • calling_window_start_local_time
    Type: stringFormat: time
    required

    The earliest local clock time a run may place a call, as HH:MM:SS. The window has no time zone of its own; each run's inputs carry the time zone the window is read in. The start must be before the end.

  • input_schema
    Type: ResiaJsonObject
    required

    A JSON Schema (draft 2020-12) the inputs of each run must satisfy. Use a JSON Schema object, not the legacy fields format.

    Properties: 1
  • instructions
    Type: string
    required

    The instructions for each run. Use $name or ${name} to refer to a top-level run input property. Declare every placeholder in input_schema.properties. Resia supplies validated run inputs to the agent as a separate JSON object. Resia does not replace the placeholder text. Nested property paths are not supported.

  • max_calls
    Type: integer
    min:  
    0
    required

    The most calls one run of this Workflow Agent may place. Zero means the run places no calls, and it then receives no calling ability at all. A run that reaches this limit is refused further calls.

  • max_spend_in_cents
    Type: integer
    min:  
    0
    required

    The most one run of this Workflow Agent may spend, in whole cents. A run that reaches this limit is refused further spend.

  • name
    Type: string
    min length:  
    1
    required

    The Workflow Agent's name. It must be unique within your organization.

  • description
    Type: string
    min length:  
    1
    max length:  
    280    nullable

    One line saying what this Workflow Agent is for. Optional; a name is the fallback.

  • max_messages
    Type: integer
    min:  
    0

    The most text messages one run of this Workflow Agent may send. Zero (the default) means the run sends none, and it then receives no messaging ability.

  • milestones
    Type: array of AgentMilestone 1…32nullable

    The stages a run of this Workflow Agent may report, each a name and a description. During a run the agent calls set_milestone with a name from this list to record the stage it reached; GET the run to read the current stage. Names must be unique. Null (the default) means the agent reports no milestone.

    Properties: 2
  • run_ended_webhook_url
    Type: string
    min length:  
    1    Format: urinullable

    HTTPS URL Resia POSTs a workflow_run.ended event to when a Workflow Run reaches succeeded, failed, or cancelled. The event contains the same WorkflowRunResponse that GET /v1/workflow-runs/{workflow_run_id} returns. Resia makes one immediate attempt when practical and retries a failed delivery on the call.ended schedule. Any 2xx response is success. The workflow_run_id stays unchanged across retries, so treat a repeated workflow_run_id as a duplicate. Treat the complete URL as a credential. Null clears the webhook and stops pending deliveries.

  • triggerable_call_agent_ids
    Type: array of string …64
    min length:  
    1
    max length:  
    512

    The Call Agents runs of this Workflow Agent may dial, each named by its identifier. Every identifier must name a Call Agent your organization owns and has not archived. An empty list (the default) means the workflow places no calls.