Skip to content

Commit

Permalink
📝 Add API deploy doc
Browse files Browse the repository at this point in the history
Closes #1454
  • Loading branch information
baptisteArno committed Jun 26, 2024
1 parent baa5f5f commit 14613b6
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
35 changes: 35 additions & 0 deletions apps/docs/deploy/api/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebarTitle: Overview
title: API
---

Your bot can also be executed with HTTP requests. This is useful if you want to integrate your bot with another service or if you want to use it in a different programming language.

## Test

1. All your requests need to be authenticated with an API token. [See instructions](/api-reference/authentication).
2. To start the chat, send a POST request to `https://typebot.io/api/v1/typebots/<typebot ID>/preview/startChat` The first response will contain a sessionId that you will need for subsequent requests.
3. To send replies, send POST requests to `https://typebot.io/api/v1/sessions/<session ID>/continueChat`
With the following JSON body:

```json
{
"message": "This is my reply"
}
```

Check out the [Start preview chat API reference](/api-reference/chat/start-preview-chat) for more information

## Live

1. To start the chat, send a POST request to `https://typebot.io/api/v1/typebots/<public ID>/startChat` The first response will contain a sessionId that you will need for subsequent requests.
2. To send replies, send POST requests to `https://typebot.io/api/v1/sessions/<session ID>/continueChat`
With the following JSON body:

```json
{
"message": "This is my reply"
}
```

Check out the [Start chat API reference](/api-reference/chat/start-chat) for more information
5 changes: 5 additions & 0 deletions apps/docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,11 @@
"deploy/whatsapp/overview",
"deploy/whatsapp/create-meta-app"
]
},
{
"group": "API",
"icon": "code-simple",
"pages": ["deploy/api/overview"]
}
]
},
Expand Down

0 comments on commit 14613b6

Please sign in to comment.