Skip to content
Nexa Platform Docs

Plan Automation

POST
/api/automations/{automation_alias}/plan
curl --request POST \
  --url https://example.com/api/automations/example/plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "agent_id": "example", "agent_alias": "example", "user_id": "example", "prompt": "example", "query": "example", "prompt_template": { "name": "example", "params": { "additionalProperty": "example" } }, "automation_name": "example", "description": "example", "schedule": { "type": "example", "cron_expression": "example", "timezone": "UTC" }, "document_template_name": "example", "document_template_version": 1, "template_id": "example", "response_schema": {}, "priority": 1, "automation_id": "example", "actions_config": {} }'

Create and validate an automation execution plan.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
automation_alias
required
Automation Alias
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
AutomationValidateRequest
object
agent_id
Any of:
string
agent_alias
required
Agent Alias
string
user_id
required
User Id
string
prompt
Any of:
string
query
Any of:
string
prompt_template
Any of:
PromptTemplateRef
object
name
required
Name
string
>= 1 characters
params
Params
object
key
additional properties
string
automation_name
required
Automation Name
string
description
Any of:
string
schedule
required
ScheduleConfig
object
type
required
Type

‘on_demand’ or ‘cron’

string
cron_expression
Any of:
string
timezone
Timezone
string
default: UTC
document_template_name
Any of:
string
document_template_version
Any of:
integer
>= 1
template_id
Any of:
string
response_schema
Any of:
object
key
additional properties
any
priority
Priority
integer
default: 1 >= 1 <= 5
automation_id
Any of:
string
actions_config
Any of:
object
key
additional properties
any

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
AutomationValidateResponse
object
success
required
Success
boolean
attempt_id
required
Attempt Id
string
automation_alias
Any of:
string
business_trigger
required
Business Trigger
boolean
status
required
Status
string
deployment_status
Any of:
string
deployment_status_reason
Any of:
string
plan
required
Plan
object
key
additional properties
any
schedule
required
Schedule
object
key
additional properties
any
api_response_time_seconds
required
Api Response Time Seconds
number
validation_warnings
Any of:
Array<string>
planner_type
Any of:
string
planner_model
Any of:
string
prompt_template_used
Any of:
string
bundle_validation
Any of:
object
key
additional properties
any
Examplegenerated
{
  "success": true,
  "attempt_id": "example",
  "automation_alias": "example",
  "business_trigger": true,
  "status": "example",
  "deployment_status": "example",
  "deployment_status_reason": "example",
  "plan": {},
  "schedule": {},
  "api_response_time_seconds": 1,
  "validation_warnings": [
    "example"
  ],
  "planner_type": "example",
  "planner_model": "example",
  "prompt_template_used": "example",
  "bundle_validation": {}
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}