Task

Create a new task

Create a new task with the given parameters.

post/task/create

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/task/create
  • Auth: HTTP bearer

Request body

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

blueprintIdstring nullable

The ID of the blueprint

contactIdstring

The contact associated with the task

botIdstring

The bot associated with the task

schedulestring

The schedule of the task. Cron expressions and date-based schedules are evaluated in the provided timezone when set.

timezonestring nullable

An optional IANA timezone identifier used when evaluating the task schedule.

expiresAtnumber nullable

An optional epoch-millisecond timestamp after which the task is automatically deleted. Pass null or omit for no expiry.

sessionDurationnumber

The session duration of the Widget integration

maxIterationsnumber

The maximum number of iterations per task execution

maxTimenumber

The maximum time per task execution in milliseconds

maxCallsnumber nullable

The maximum number of tool calls across the whole task run (0 or null for unbounded)

Example request

{
  "timezone": "America/New_York"
}

Response

The task was created successfully

idstring required

The ID of the created task

Changes

No recorded changes to this operation across all 1 revision of this API.