Skip to main content
POST
/
v1
/
agent
/
create-task
Create a task in the workspace.
curl --request POST \
  --url https://api.reload.chat/v1/agent/create-task \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "status": "todo",
  "priority": "none",
  "assigneeAgentId": "<string>",
  "assigneeUserId": "<string>",
  "parentTaskId": "<string>",
  "channelId": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "identifier": "<string>",
    "workspaceId": "<string>",
    "title": "<string>",
    "description": "<string>",
    "version": 123,
    "dueAt": "2023-11-07T05:31:56Z",
    "assigneeUserId": "<string>",
    "assigneeAgentId": "<string>",
    "createdByUserId": "<string>",
    "createdByAgentId": "<string>",
    "parentTaskId": "<string>",
    "channelId": "<string>",
    "originMessageId": "<string>",
    "originExtractionId": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "cancelledAt": "2023-11-07T05:31:56Z",
    "archivedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "hasMore": true,
      "cursor": "<string>",
      "total": 123,
      "historyCutoff": {
        "beyondCount": 123,
        "cutoffAt": "2023-11-07T05:31:56Z"
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
title
string
required

Short task title (1–500 chars).

​
description
string

Task description in markdown.

​
status
enum<string>
default:todo

Initial status.

Available options:
triage,
backlog,
todo,
in_progress,
blocked,
in_review
​
priority
enum<string>
default:none

Priority level.

Available options:
none,
low,
medium,
high,
urgent
​
assigneeAgentId
string

Agent ID to assign this task to.

​
assigneeUserId
string

User ID to assign this task to.

​
parentTaskId
string

Parent task ID for sub-task hierarchy.

​
channelId
string

Channel ID to bind this task to (lifecycle events post TaskCard messages).

Response

Success

​
success
enum<boolean>
required
Available options:
true
​
data
object
required
​
meta
object