Create a chat session

The app.neoagent.co API provides the functionality to create a new chat session by sending a POST request to the /chat/Chatbot/GetSession endpoint.

Endpoint

Request URL: https://app.neoagent.co/chat/Chatbot/GetSession
Method: POST

Required Headers

The API request must include the following headers:

• Authorization: <Your-Secret-Key> - string, required - The secret key for authenticating the API request
• Content-Type: application/json - string, required - The content type of the request payload (must be application/json)

Request Body

The request body must contain the following parameters:

{
// string, required - Unique identifier (ID) of the chatbot
"serialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
}

Parameters

• serialNumber - string, required - Unique identifier (ID) of the chatbot

Request Examples

JavaScript (Fetch API)

const res = await fetch('https://app.neoagent.co/chat/Chatbot/GetSession', {
  method: 'POST',
  headers: {
  "Authorization": "<Your-Secret-Key>",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "serialNumber": "3254a9d0424c4806b9ea3d0763ccfxxx"
})
});

const data = await res.json();
console.log(data);

Python (Requests)

import requests
import json

url = 'https://app.neoagent.co/chat/Chatbot/GetSession'
headers = {
    "Authorization": "<Your-Secret-Key>",
    "Content-Type": "application/json"
}
data = {
  "serialNumber": "3254a9d0424c4806b9ea3d0763ccfxxx"
}

response = requests.post(url, headers=headers, json=data)
data = response.json()
print(data)

cURL

curl 'https://app.neoagent.co/chat/Chatbot/GetSession' \
  -X POST \
  -H 'Authorization: <Your-Secret-Key>' \
  -H 'Content-Type: application/json' \
  -d '{"serialNumber":"3254a9d0424c4806b9ea3d0763ccfxxx"}'

HTTP Raw

POST /chat/Chatbot/GetSession HTTP/1.1
Host: app.neoagent.co
Authorization: <Your-Secret-Key>
Content-Type: application/json

{
  "serialNumber": "3254a9d0424c4806b9ea3d0763ccfxxx"
}

Response

The API response will be a JSON object with the following structure:

{
  "Data": {
    "SessionID": 123456
  },
  // string - API version
  "Version": "1.0.0",
  // boolean - Operation success status
  "Success": true,
  // integer - HTTP status code
  "Code": 200,
  // string - Error message if any
  "Message": ""
}

Error Handling

If the request fails, you should:

1. Check the HTTP status code for network-level errors
2. Examine the Code and Message fields in the response for business-level errors
3. The Message field will contain detailed information about the error