Create task

Create a new task

POST
/tasks
AuthorizationBearer <token>

Bearer token authentication. Use your API key as the bearer token.

In: header

Task creation input

appId?string

AppID is the ID of the app associated with this task, if applicable.

description?string

Description provides additional details about the task.

endedAt?string

EndedAt specifies when the task execution completed.

executorId?string

ExecutorID specifies which executor should handle this task.

input?unknown

Input contains the input data for the task execution.

kindTaskKind

Kind specifies the type of task being created (e.g., CallAction, Flow, etc.).

output?unknown

Output contains the result data from task execution.

params?object

Params contains task-specific parameters as key-value pairs.

Empty Object

parentId?string

ParentID links this task to a parent task for hierarchical task structures.

startedAt?string

StartedAt specifies when the task execution began.

stateful?boolean

Stateful indicates whether this task requires persistent state management. If true, a state object will be created and linked to the task.

status?TaskStatus

Status sets the initial status of the task. Defaults to "created" if not specified.

targetId?string

TargetID identifies the target resource or action for this task.

title?string

Title is a human-readable title for the task.

Response Body

curl -X POST "https://eu1.api.bivariant.com/v1/tasks" \  -H "Content-Type: application/json" \  -d '{    "kind": "default"  }'
{
  "appId": "string",
  "authorId": "string",
  "children": [
    {
      "appId": "string",
      "authorId": "string",
      "children": [],
      "createdAt": "string",
      "description": "string",
      "endedAt": "string",
      "errors": [
        {
          "code": "string",
          "message": "string"
        }
      ],
      "executorId": "string",
      "id": "string",
      "input": null,
      "kind": "default",
      "organizationId": "string",
      "output": null,
      "params": {
        "property1": null,
        "property2": null
      },
      "parentId": "string",
      "startedAt": "string",
      "stateId": "string",
      "status": "created",
      "targetId": "string",
      "title": "string",
      "updatedAt": "string"
    }
  ],
  "createdAt": "string",
  "description": "string",
  "endedAt": "string",
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "executorId": "string",
  "id": "string",
  "input": null,
  "kind": "default",
  "organizationId": "string",
  "output": null,
  "params": {
    "property1": null,
    "property2": null
  },
  "parentId": "string",
  "startedAt": "string",
  "stateId": "string",
  "status": "created",
  "targetId": "string",
  "title": "string",
  "updatedAt": "string"
}
{
  "code": "string",
  "message": "string"
}
{
  "code": "string",
  "message": "string"
}
{
  "code": "string",
  "message": "string"
}