Skip to content
Nexa Platform Docs

Create Task

POST
/api/v1/tasks
curl --request POST \
  --url https://example.com/api/v1/tasks \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "database": "example", "schema": "example", "warehouse": "example", "schedule": "example", "sql_statement": "example", "condition": "example", "allow_overlapping_execution": false, "after_tasks": [ "example" ], "comment": "example", "state": "STARTED", "task_timeout_minutes": 60, "suspend_task_after_num_failures": 10, "user_task_managed_initial_warehouse_size": "example" }'

Create a new task.

Args: request: Task creation parameters

Returns: TaskOperationResponse with operation result

Raises: HTTPException: If task creation fails

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
X-Environment-Id
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
TaskCreateRequest

Request model for creating a task.

object
name
required
Name

Task name

string
database
required
Database

Database name

string
schema
required
Schema

Schema name

string
warehouse
Any of:
string
schedule
Any of:
string
sql_statement
required
Sql Statement

SQL statement to execute

string
condition
Any of:
string
allow_overlapping_execution
Allow Overlapping Execution

Allow concurrent executions

boolean
after_tasks
After Tasks

List of predecessor task names (fully qualified or simple names)

Array<string>
comment
Any of:
string
state
TaskState

Initial task state

string
default: SUSPENDED
Allowed values: STARTED SUSPENDED
task_timeout_minutes
Task Timeout Minutes

Task execution timeout in minutes

integer
default: 60
suspend_task_after_num_failures
Suspend Task After Num Failures

Auto-suspend after N consecutive failures

integer
default: 10
user_task_managed_initial_warehouse_size
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
TaskOperationResponse

Response model for task operations.

object
task_name
required
Task Name

Task name

string
operation
required
Operation

Operation performed (create, start, suspend, execute, delete)

string
success
required
Success

Whether operation was successful

boolean
message
required
Message

Operation result message

string
new_state
Any of:
string
Examplegenerated
{
  "task_name": "example",
  "operation": "example",
  "success": true,
  "message": "example",
  "new_state": "example"
}

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
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}