Start chat

curl --request POST \
  --url https://typebot.io/api/v1/typebots/{publicId}/startChat \
  --header 'Content-Type: application/json' \
  --data '
{
  "resultId": "<string>",
  "message": {
    "type": "<unknown>",
    "text": "<string>",
    "metadata": {
      "replyId": "<string>"
    },
    "attachedFileUrls": [
      "<string>"
    ]
  },
  "isStreamEnabled": false,
  "isOnlyRegistering": false,
  "prefilledVariables": {},
  "textBubbleContentFormat": "richText"
}
'

import requests

url = "https://typebot.io/api/v1/typebots/{publicId}/startChat"

payload = {
    "resultId": "<string>",
    "message": {
        "type": "<unknown>",
        "text": "<string>",
        "metadata": { "replyId": "<string>" },
        "attachedFileUrls": ["<string>"]
    },
    "isStreamEnabled": False,
    "isOnlyRegistering": False,
    "prefilledVariables": {},
    "textBubbleContentFormat": "richText"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    resultId: '<string>',
    message: {
      type: '<unknown>',
      text: '<string>',
      metadata: {replyId: '<string>'},
      attachedFileUrls: ['<string>']
    },
    isStreamEnabled: false,
    isOnlyRegistering: false,
    prefilledVariables: {},
    textBubbleContentFormat: 'richText'
  })
};

fetch('https://typebot.io/api/v1/typebots/{publicId}/startChat', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://typebot.io/api/v1/typebots/{publicId}/startChat",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'resultId' => '<string>',
    'message' => [
        'type' => '<unknown>',
        'text' => '<string>',
        'metadata' => [
                'replyId' => '<string>'
        ],
        'attachedFileUrls' => [
                '<string>'
        ]
    ],
    'isStreamEnabled' => false,
    'isOnlyRegistering' => false,
    'prefilledVariables' => [
        
    ],
    'textBubbleContentFormat' => 'richText'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://typebot.io/api/v1/typebots/{publicId}/startChat"

	payload := strings.NewReader("{\n  \"resultId\": \"<string>\",\n  \"message\": {\n    \"type\": \"<unknown>\",\n    \"text\": \"<string>\",\n    \"metadata\": {\n      \"replyId\": \"<string>\"\n    },\n    \"attachedFileUrls\": [\n      \"<string>\"\n    ]\n  },\n  \"isStreamEnabled\": false,\n  \"isOnlyRegistering\": false,\n  \"prefilledVariables\": {},\n  \"textBubbleContentFormat\": \"richText\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://typebot.io/api/v1/typebots/{publicId}/startChat")
  .header("Content-Type", "application/json")
  .body("{\n  \"resultId\": \"<string>\",\n  \"message\": {\n    \"type\": \"<unknown>\",\n    \"text\": \"<string>\",\n    \"metadata\": {\n      \"replyId\": \"<string>\"\n    },\n    \"attachedFileUrls\": [\n      \"<string>\"\n    ]\n  },\n  \"isStreamEnabled\": false,\n  \"isOnlyRegistering\": false,\n  \"prefilledVariables\": {},\n  \"textBubbleContentFormat\": \"richText\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://typebot.io/api/v1/typebots/{publicId}/startChat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"resultId\": \"<string>\",\n  \"message\": {\n    \"type\": \"<unknown>\",\n    \"text\": \"<string>\",\n    \"metadata\": {\n      \"replyId\": \"<string>\"\n    },\n    \"attachedFileUrls\": [\n      \"<string>\"\n    ]\n  },\n  \"isStreamEnabled\": false,\n  \"isOnlyRegistering\": false,\n  \"prefilledVariables\": {},\n  \"textBubbleContentFormat\": \"richText\"\n}"

response = http.request(request)
puts response.read_body

{
  "sessionId": "<string>",
  "typebot": {
    "id": "<string>",
    "theme": {
      "general": {
        "font": "<string>",
        "background": {
          "content": "<string>"
        },
        "progressBar": {
          "isEnabled": true,
          "color": "<string>",
          "backgroundColor": "<string>",
          "thickness": 123
        }
      },
      "chat": {
        "container": {
          "maxWidth": "<string>",
          "maxHeight": "<string>",
          "backgroundColor": "<string>",
          "color": "<string>",
          "blur": 123,
          "opacity": 0.5,
          "border": {
            "thickness": 123,
            "color": "<string>",
            "customRoundeness": 123,
            "opacity": 0.5
          }
        },
        "hostAvatar": {
          "isEnabled": true,
          "url": "<string>"
        },
        "guestAvatar": {
          "isEnabled": true,
          "url": "<string>"
        },
        "hostBubbles": {
          "backgroundColor": "<string>",
          "color": "<string>",
          "blur": 123,
          "opacity": 0.5,
          "border": {
            "thickness": 123,
            "color": "<string>",
            "customRoundeness": 123,
            "opacity": 0.5
          }
        },
        "guestBubbles": {
          "backgroundColor": "<string>",
          "color": "<string>",
          "blur": 123,
          "opacity": 0.5,
          "border": {
            "thickness": 123,
            "color": "<string>",
            "customRoundeness": 123,
            "opacity": 0.5
          }
        },
        "buttons": {
          "backgroundColor": "<string>",
          "color": "<string>",
          "blur": 123,
          "opacity": 0.5,
          "border": {
            "thickness": 123,
            "color": "<string>",
            "customRoundeness": 123,
            "opacity": 0.5
          }
        },
        "inputs": {
          "backgroundColor": "<string>",
          "color": "<string>",
          "blur": 123,
          "opacity": 0.5,
          "border": {
            "thickness": 123,
            "color": "<string>",
            "customRoundeness": 123,
            "opacity": 0.5
          },
          "placeholderColor": "<string>"
        },
        "buttonsInput": {}
      },
      "customCss": "<string>"
    },
    "settings": {
      "general": {
        "isBrandingEnabled": true,
        "isTypingEmulationEnabled": true,
        "isInputPrefillEnabled": true,
        "isHideQueryParamsEnabled": true,
        "isNewResultOnRefreshEnabled": true,
        "rememberUser": {
          "isEnabled": true
        },
        "systemMessages": {
          "invalidMessage": "<string>",
          "botClosed": "<string>",
          "networkErrorTitle": "<string>",
          "networkErrorMessage": "<string>",
          "popupBlockedTitle": "<string>",
          "popupBlockedDescription": "<string>",
          "popupBlockedButtonLabel": "<string>",
          "fileUploadError": "<string>",
          "fileUploadSizeError": "<string>",
          "whatsAppPictureChoiceSelectLabel": "<string>"
        }
      },
      "typingEmulation": {
        "enabled": true,
        "speed": 123,
        "maxDelay": 123,
        "delayBetweenBubbles": 2.5,
        "isDisabledOnFirstMessage": true
      }
    },
    "publishedAt": "2023-11-07T05:31:56Z"
  },
  "messages": [
    {
      "id": "<string>",
      "type": "<unknown>",
      "content": {
        "type": "<unknown>",
        "richText": "<unknown>"
      }
    }
  ],
  "resultId": "<string>",
  "lastMessageNewFormat": "<string>",
  "input": {
    "id": "<string>",
    "type": "text input",
    "outgoingEdgeId": "<string>",
    "options": {
      "labels": {
        "placeholder": "<string>",
        "button": "<string>"
      },
      "variableId": "<string>",
      "isLong": true,
      "audioClip": {
        "isEnabled": true,
        "saveVariableId": "<string>"
      },
      "attachments": {
        "isEnabled": true,
        "saveVariableId": "<string>"
      }
    },
    "prefilledValue": "<string>",
    "runtimeOptions": {
      "paymentIntentSecret": "<string>",
      "amountLabel": "<string>",
      "publicKey": "<string>"
    }
  },
  "clientSideActions": [
    {
      "type": "<unknown>",
      "scriptToExecute": {
        "content": "<string>",
        "args": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ],
        "isUnsafe": true,
        "isCode": true
      },
      "lastBubbleBlockId": "<string>",
      "expectsDedicatedReply": true
    }
  ],
  "logs": [
    {
      "description": "<string>",
      "status": "<string>",
      "details": "<string>",
      "context": "<string>"
    }
  ],
  "dynamicTheme": {
    "hostAvatarUrl": "<string>",
    "guestAvatarUrl": "<string>",
    "backgroundUrl": "<string>"
  },
  "progress": 123
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Bad Request",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Unauthorized",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Forbidden",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Not Found",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Internal Server Error",
  "data": "<unknown>"
}

POST

typebots

{publicId}

startChat

Start chat

curl --request POST \
  --url https://typebot.io/api/v1/typebots/{publicId}/startChat \
  --header 'Content-Type: application/json' \
  --data '
{
  "resultId": "<string>",
  "message": {
    "type": "<unknown>",
    "text": "<string>",
    "metadata": {
      "replyId": "<string>"
    },
    "attachedFileUrls": [
      "<string>"
    ]
  },
  "isStreamEnabled": false,
  "isOnlyRegistering": false,
  "prefilledVariables": {},
  "textBubbleContentFormat": "richText"
}
'

import requests

url = "https://typebot.io/api/v1/typebots/{publicId}/startChat"

payload = {
    "resultId": "<string>",
    "message": {
        "type": "<unknown>",
        "text": "<string>",
        "metadata": { "replyId": "<string>" },
        "attachedFileUrls": ["<string>"]
    },
    "isStreamEnabled": False,
    "isOnlyRegistering": False,
    "prefilledVariables": {},
    "textBubbleContentFormat": "richText"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    resultId: '<string>',
    message: {
      type: '<unknown>',
      text: '<string>',
      metadata: {replyId: '<string>'},
      attachedFileUrls: ['<string>']
    },
    isStreamEnabled: false,
    isOnlyRegistering: false,
    prefilledVariables: {},
    textBubbleContentFormat: 'richText'
  })
};

fetch('https://typebot.io/api/v1/typebots/{publicId}/startChat', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://typebot.io/api/v1/typebots/{publicId}/startChat",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'resultId' => '<string>',
    'message' => [
        'type' => '<unknown>',
        'text' => '<string>',
        'metadata' => [
                'replyId' => '<string>'
        ],
        'attachedFileUrls' => [
                '<string>'
        ]
    ],
    'isStreamEnabled' => false,
    'isOnlyRegistering' => false,
    'prefilledVariables' => [
        
    ],
    'textBubbleContentFormat' => 'richText'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://typebot.io/api/v1/typebots/{publicId}/startChat"

	payload := strings.NewReader("{\n  \"resultId\": \"<string>\",\n  \"message\": {\n    \"type\": \"<unknown>\",\n    \"text\": \"<string>\",\n    \"metadata\": {\n      \"replyId\": \"<string>\"\n    },\n    \"attachedFileUrls\": [\n      \"<string>\"\n    ]\n  },\n  \"isStreamEnabled\": false,\n  \"isOnlyRegistering\": false,\n  \"prefilledVariables\": {},\n  \"textBubbleContentFormat\": \"richText\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://typebot.io/api/v1/typebots/{publicId}/startChat")
  .header("Content-Type", "application/json")
  .body("{\n  \"resultId\": \"<string>\",\n  \"message\": {\n    \"type\": \"<unknown>\",\n    \"text\": \"<string>\",\n    \"metadata\": {\n      \"replyId\": \"<string>\"\n    },\n    \"attachedFileUrls\": [\n      \"<string>\"\n    ]\n  },\n  \"isStreamEnabled\": false,\n  \"isOnlyRegistering\": false,\n  \"prefilledVariables\": {},\n  \"textBubbleContentFormat\": \"richText\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://typebot.io/api/v1/typebots/{publicId}/startChat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"resultId\": \"<string>\",\n  \"message\": {\n    \"type\": \"<unknown>\",\n    \"text\": \"<string>\",\n    \"metadata\": {\n      \"replyId\": \"<string>\"\n    },\n    \"attachedFileUrls\": [\n      \"<string>\"\n    ]\n  },\n  \"isStreamEnabled\": false,\n  \"isOnlyRegistering\": false,\n  \"prefilledVariables\": {},\n  \"textBubbleContentFormat\": \"richText\"\n}"

response = http.request(request)
puts response.read_body

{
  "sessionId": "<string>",
  "typebot": {
    "id": "<string>",
    "theme": {
      "general": {
        "font": "<string>",
        "background": {
          "content": "<string>"
        },
        "progressBar": {
          "isEnabled": true,
          "color": "<string>",
          "backgroundColor": "<string>",
          "thickness": 123
        }
      },
      "chat": {
        "container": {
          "maxWidth": "<string>",
          "maxHeight": "<string>",
          "backgroundColor": "<string>",
          "color": "<string>",
          "blur": 123,
          "opacity": 0.5,
          "border": {
            "thickness": 123,
            "color": "<string>",
            "customRoundeness": 123,
            "opacity": 0.5
          }
        },
        "hostAvatar": {
          "isEnabled": true,
          "url": "<string>"
        },
        "guestAvatar": {
          "isEnabled": true,
          "url": "<string>"
        },
        "hostBubbles": {
          "backgroundColor": "<string>",
          "color": "<string>",
          "blur": 123,
          "opacity": 0.5,
          "border": {
            "thickness": 123,
            "color": "<string>",
            "customRoundeness": 123,
            "opacity": 0.5
          }
        },
        "guestBubbles": {
          "backgroundColor": "<string>",
          "color": "<string>",
          "blur": 123,
          "opacity": 0.5,
          "border": {
            "thickness": 123,
            "color": "<string>",
            "customRoundeness": 123,
            "opacity": 0.5
          }
        },
        "buttons": {
          "backgroundColor": "<string>",
          "color": "<string>",
          "blur": 123,
          "opacity": 0.5,
          "border": {
            "thickness": 123,
            "color": "<string>",
            "customRoundeness": 123,
            "opacity": 0.5
          }
        },
        "inputs": {
          "backgroundColor": "<string>",
          "color": "<string>",
          "blur": 123,
          "opacity": 0.5,
          "border": {
            "thickness": 123,
            "color": "<string>",
            "customRoundeness": 123,
            "opacity": 0.5
          },
          "placeholderColor": "<string>"
        },
        "buttonsInput": {}
      },
      "customCss": "<string>"
    },
    "settings": {
      "general": {
        "isBrandingEnabled": true,
        "isTypingEmulationEnabled": true,
        "isInputPrefillEnabled": true,
        "isHideQueryParamsEnabled": true,
        "isNewResultOnRefreshEnabled": true,
        "rememberUser": {
          "isEnabled": true
        },
        "systemMessages": {
          "invalidMessage": "<string>",
          "botClosed": "<string>",
          "networkErrorTitle": "<string>",
          "networkErrorMessage": "<string>",
          "popupBlockedTitle": "<string>",
          "popupBlockedDescription": "<string>",
          "popupBlockedButtonLabel": "<string>",
          "fileUploadError": "<string>",
          "fileUploadSizeError": "<string>",
          "whatsAppPictureChoiceSelectLabel": "<string>"
        }
      },
      "typingEmulation": {
        "enabled": true,
        "speed": 123,
        "maxDelay": 123,
        "delayBetweenBubbles": 2.5,
        "isDisabledOnFirstMessage": true
      }
    },
    "publishedAt": "2023-11-07T05:31:56Z"
  },
  "messages": [
    {
      "id": "<string>",
      "type": "<unknown>",
      "content": {
        "type": "<unknown>",
        "richText": "<unknown>"
      }
    }
  ],
  "resultId": "<string>",
  "lastMessageNewFormat": "<string>",
  "input": {
    "id": "<string>",
    "type": "text input",
    "outgoingEdgeId": "<string>",
    "options": {
      "labels": {
        "placeholder": "<string>",
        "button": "<string>"
      },
      "variableId": "<string>",
      "isLong": true,
      "audioClip": {
        "isEnabled": true,
        "saveVariableId": "<string>"
      },
      "attachments": {
        "isEnabled": true,
        "saveVariableId": "<string>"
      }
    },
    "prefilledValue": "<string>",
    "runtimeOptions": {
      "paymentIntentSecret": "<string>",
      "amountLabel": "<string>",
      "publicKey": "<string>"
    }
  },
  "clientSideActions": [
    {
      "type": "<unknown>",
      "scriptToExecute": {
        "content": "<string>",
        "args": [
          {
            "id": "<string>",
            "value": "<string>"
          }
        ],
        "isUnsafe": true,
        "isCode": true
      },
      "lastBubbleBlockId": "<string>",
      "expectsDedicatedReply": true
    }
  ],
  "logs": [
    {
      "description": "<string>",
      "status": "<string>",
      "details": "<string>",
      "context": "<string>"
    }
  ],
  "dynamicTheme": {
    "hostAvatarUrl": "<string>",
    "guestAvatarUrl": "<string>",
    "backgroundUrl": "<string>"
  },
  "progress": 123
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Bad Request",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Unauthorized",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Forbidden",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Not Found",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Internal Server Error",
  "data": "<unknown>"
}

Path Parameters

publicId

string

required

Where to find my bot's public ID?

Body

application/json

resultId

string

Provide it if you'd like to overwrite an existing result.

message

object

Only provide it if your flow starts with an input block and you'd like to directly provide an answer to it.

Option 1
Option 2
Option 3

Show child attributes

isStreamEnabled

boolean

default:false

If enabled, you will be required to stream OpenAI completions on a client and send the generated response back to the API.

isOnlyRegistering

boolean

default:false

If set to true, it will only register the session and not start the bot. This is used for 3rd party chat platforms as it can require a session to be registered before sending the first message.

prefilledVariables

object

More info about prefilled variables.

Show child attributes

textBubbleContentFormat

enum<string>

default:richText

Available options:

richText,

markdown

Response

sessionId

string

required

To save and use for /continueChat requests.

typebot

object

required

Show child attributes

messages

object[]

required

Show child attributes

resultId

string

lastMessageNewFormat

string

The sent message is validated and formatted on the backend. For example, if for a date input you replied something like tomorrow, the backend will convert it to a date string. This field returns the formatted message.

input

object

Show child attributes

clientSideActions

object[]

Actions to execute on the client side

Show child attributes

logs

object[]

Logs that were saved during the last execution

Show child attributes

dynamicTheme

object

If the typebot contains dynamic avatars, dynamicTheme returns the new avatar URLs whenever their variables are updated.

Show child attributes

progress

number

If progress bar is enabled, this field will return a number between 0 and 100 indicating the current progress based on the longest remaining path of the flow.

Get started

Chat

Typebot

Results

Analytics

Folder

Workspace

Billing

Start chat

Path Parameters

Body

Response