32951
apps/docs/openapi/builder.json
Normal file
32951
apps/docs/openapi/builder.json
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "Builder",
|
||||
"sidebar_position": 2
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,33 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Authentication
|
||||
|
||||
Every API resources are protected, and therefore require that you authenticate using an API token.
|
||||
|
||||
## Generate a token
|
||||
|
||||
1. Navigate to your typebot dashboard (https://app.typebot.io/typebots)
|
||||
2. Click on Settings & Members > My account
|
||||
3. Under the "API tokens" section, click on "Create"
|
||||
4. Give it a name, then click on "Create token"
|
||||
5. Copy your token.
|
||||
|
||||
<img
|
||||
src="/img/api/authentication/generateToken.png"
|
||||
width="900"
|
||||
alt="Generate token"
|
||||
/>
|
||||
|
||||
## Use your token
|
||||
|
||||
You can authenticate by adding an `Authorization` header to all your HTTP calls. The Authorization header is formatted as such: `Authorization: Bearer <token>` (replace `<token>` with your token previously generated).
|
||||
|
||||
Example:
|
||||
|
||||
```sh
|
||||
curl -L -X GET 'https://app.typebot.io/api/typebots/:typebotId/results' \
|
||||
-H 'Accept: application/json' \
|
||||
-H 'Authorization: Bearer myAwesomeToken'
|
||||
```
|
||||
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"label": "Chat (Beta)"
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,38 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
slug: /
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
||||
Typebot currently offers 2 APIs: **Builder** and **Chat**
|
||||
|
||||
## Builder
|
||||
|
||||
The Builder API is about what you can edit on https://app.typebot.io (i.e. create typebots, insert blocks etc, get results...). It is currently under active development and new endpoints will be added incrementally.
|
||||
|
||||
## Chat
|
||||
|
||||
:::caution
|
||||
You should not use it in production. This API is experimental at the moment and will be changed without notice.
|
||||
:::
|
||||
|
||||
The Chat API allows you to execute (chat) with a typebot.
|
||||
|
||||
### How to find my `typebotId`
|
||||
|
||||
If you'd like to execute the typebot in preview mode, you will need to provide the ID of the building typebot available in the editor URL:
|
||||
|
||||
<img
|
||||
src="/img/api/typebotId.png"
|
||||
width="900"
|
||||
alt="Get typebot ID"
|
||||
/>
|
||||
|
||||
For published typebot execution, you need to provide the public typebot ID available here:
|
||||
|
||||
<img
|
||||
src="/img/api/publicId.png"
|
||||
width="900"
|
||||
alt="Get typebot ID"
|
||||
/>
|
||||
11486
apps/docs/openapi/viewer.json
Normal file
11486
apps/docs/openapi/viewer.json
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user