Initiate chat

This endpoint will initiate a chat with your copilot, it will the copilot name, metdata, and other info.

GET https://api.opencopilot.so/backend/chat/init

Try it

Example Request

curl --location 'https://api.opencopilot.so/backend/chat/init' \
  --header 'X-Bot-Token: BOT_TOKEN' \
  --header 'X-Session-Id: SESSION_ID' \

Response

{
    "type": "text",
    "response": [
        "text" "The copilot response!"
    ]
}

Body

X-Bot-Token · string

Your copilot uniuqe token, can be obtained from the dashboard or from get copilot endpoint

X-Session-Id · string

The session id, you can generate a new session id for each chat, or use the same session id for the same chat

Response

type · string

The copilot response type, currently it only support text

response · object

copilot information

Show properties

text · string

The copilot response, formatted in Markdown by default

Example Request

curl --location 'https://api.opencopilot.so/backend/chat/init' \
  --header 'X-Bot-Token: BOT_TOKEN' \
  --header 'X-Session-Id: SESSION_ID' \

Response

{
    "type": "text",
    "response": [
        "text" "The copilot response!"
    ]
}