POST
/
conversations
Create a General Conversation
curl --request POST \
  --url https://api.hyperleapai.com/conversations \
  --header 'Content-Type: application/json' \
  --header 'x-hl-api-key: <api-key>' \
  --data '{
  "systemMessage": "<string>",
  "aiSystem": 0,
  "model": "<string>",
  "configuration": {},
  "replacements": {},
  "metadata": {},
  "externalUserId": "<string>",
  "dataspaceIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}'
{
  "conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "aiSystem": "<string>",
  "model": "<string>",
  "personaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "personaVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversationStatus": "<string>",
  "conversationName": "<string>",
  "chatMessages": [
    {
      "role": "<string>",
      "content": "<string>",
      "toolCallId": "<string>",
      "name": "<string>",
      "messageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "timestamp": "2023-11-07T05:31:56Z",
      "feedbacks": [
        {
          "feedbackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "score": 0,
          "comments": "<string>",
          "tags": [
            "<string>"
          ],
          "timestamp": "2023-11-07T05:31:56Z",
          "scoreConfidence": 0.5
        }
      ],
      "promptTokens": 123,
      "completionTokens": 123,
      "totalTokens": 123,
      "conversationRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "chatMessagesCount": 123,
  "chatStarted": true,
  "areChatMessagesInBlob": true,
  "chatMessagesBlobUri": "<string>",
  "configuration": {},
  "metadata": {},
  "externalUserId": "<string>",
  "isActive": true,
  "isDeleted": true,
  "promptTokens": 123,
  "completionTokens": 123,
  "totalTokens": 123
}

Authorizations

x-hl-api-key
string
header
required

API Key for authentication

Body

aiSystem
enum<integer>
required
Available options:
0,
1,
2,
3,
4,
5,
6
model
string
required
Minimum length: 1
systemMessage
string | null
configuration
object | null
replacements
object | null
metadata
object | null
externalUserId
string | null
dataspaceIds
string<uuid>[] | null

Response

OK

conversationId
string<uuid>
aiSystem
string | null
model
string | null
personaId
string<uuid> | null
personaVersionId
string<uuid> | null
conversationStatus
string | null
conversationName
string | null
chatMessages
object[] | null
chatMessagesCount
integer | null
chatStarted
boolean | null
areChatMessagesInBlob
boolean | null
chatMessagesBlobUri
string | null
configuration
object | null
metadata
object | null
externalUserId
string | null
isActive
boolean
isDeleted
boolean
promptTokens
integer | null
completionTokens
integer | null
totalTokens
integer | null