Skip to main content
POST
/
threads
Create Thread
curl --request POST \
  --url https://api.b-bot.space/v2/threads \
  --header 'Content-Type: application/json' \
  --data '{
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "if_exists": "raise",
  "ttl": {
    "strategy": "delete",
    "ttl": 123
  },
  "supersteps": [
    {
      "updates": [
        {
          "values": [
            {}
          ],
          "command": {
            "update": {},
            "resume": {},
            "goto": {
              "node": "<string>",
              "input": {}
            }
          },
          "as_node": "<string>"
        }
      ]
    }
  ]
}'
{
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "config": {},
  "status": "idle",
  "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
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
object

The time-to-live for the thread.

supersteps
object[]

Response

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
object
required

The thread metadata.

status
enum<string>
required

The status of the thread.

Available options:
idle,
busy,
interrupted,
error
config
object

The thread config.

values
object

The current state of the thread.

interrupts
object

The current interrupts of the thread.

I