Create Thread

Create a thread.

POST /threads

Try it

200

{
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "status": "idle",
  "config": {},
  "values": {},
  "interrupts": {}
}

Body

application/json

Payload for creating a thread.

thread_id · string<uuid>

The ID of the thread. If not provided, a random UUID will be generated.

metadata · Metadata · object

Metadata to add to thread.

if_exists · enum<string> · default: raise

How to handle duplicate creation. Must be either 'raise' (raise error if duplicate), or 'do_nothing' (return existing thread).

Available options: raise, do_nothing

ttl · TTL · object

The time-to-live for the thread.

Show child attributes

ttl. strategy · enum<string> · default: delete

The TTL strategy. 'delete' removes the entire thread.

Available options: delete

ttl. ttl · number

The time-to-live in minutes from now until thread should be swept.

supersteps · object[]

Show child attributes

supersteps. updates · object[] · required

Show child attributes

supersteps.updates. as_node · string · required

Update the state as if this node had just executed.

supersteps.updates. values · object

object[]

object

supersteps.updates. command · Command · object

The command associated with the update.

Show child attributes

supersteps.updates.command. update

An update to the state.

supersteps.updates.command. resume

A value to pass to an interrupted node.

supersteps.updates.command. goto

Name of the node(s) to navigate to next or node(s) to be executed with a provided input.

Show child attributes

supersteps.updates.command.goto. node · string · required

The node to send the message to.

supersteps.updates.command.goto. input · required

The message to send.

Response

200

application/json

Success

thread_id · string<uuid> · required

The ID of the thread.

created_at · string<date-time> · required

The time the thread was created.

updated_at · string<date-time> · required

The last time the thread was updated.

metadata · Metadata · object · required

The thread metadata.

status · enum<string> · required

The status of the thread.

Available options: idle, busy, interrupted, error

config · Config · object

The thread config.

values · Values · object

The current state of the thread.

interrupts · Interrupts · object

The current interrupts of the thread.