# Conversational API

**Conversational API Documentation**

A Conversational API lets you build chatbots that manage dialogue, and generate responses. It provides the tools to create interactive experiences, handle user intents, extract information, and integrate with other services. Think of it as the engine that powers your chatbot's ability to engage in meaningful conversations. It helps build engaging chatbots for customer service, e-commerce, entertainment, education, and personal assistance.

## Base URL <a href="#base-url" id="base-url"></a>

The base URL for the Conversational Details API is:

```
https://santechapi.vercel.app
```

## Authentication

```
headers : {
"token" : {YOUR API KEY}
}
```

**Endpoint:** `/conversational/{:q}`

### Parameters:

* {q}: Random input text from the user

*HTTP Method:  `Get`*

**Example request:**

```
GET /conversational/Hello
```

*The user can have a conversation with the AI*&#x20;

**Example Response:**

**`200`**

```
"Hi, my friend! Do you want me to tell you a joke?"
```

### Error Handling

In case of an error, the API will respond with an appropriate HTTP status code and an error message in the response body.

**Error Response:**

**`402`**

```
{
message: "param required for Conversational conversation."
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://santech.gitbook.io/docs/conversational-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.