Create a Persona Conversation

POSThttps://api.hyperleapai.com/conversations/persona

Start a Conversation with a Persona.

Authenticated with your API key in the x-hl-api-key request header.

Request body

application/json

personaIdstring · uuidrequired

personaVersionIdstring · uuidnullable

objectnullable

JsonNode

objectnullable

JsonNode

streamboolean

externalUserIdstringnullable

Responses

200OKapplication/json

conversationIdstring · uuid

aiSystemstringnullable

modelstringnullable

personaIdstring · uuidnullable

personaVersionIdstring · uuidnullable

conversationStatusstringnullable

conversationNamestringnullable

HyperleapChatMessageResponse[]nullable

rolestringnullable

contentstringnullable

toolCallIdstringnullable

namestringnullable

messageIdstring · uuid

timestampstring · date-time

RunFeedback[]nullable

promptTokensinteger · int32

completionTokensinteger · int32

totalTokensinteger · int32read-only

conversationRunIdstring · uuidread-only

chatMessagesCountinteger · int32nullable

chatStartedbooleannullable

areChatMessagesInBlobbooleannullable

chatMessagesBlobUristringnullable

objectnullable

[key]anynullable

objectnullable

JsonNode

externalUserIdstringnullable

isActiveboolean

isDeletedboolean

promptTokensinteger · int32nullable

completionTokensinteger · int32nullable

totalTokensinteger · int32nullable

Example payload

{
  "conversationId": "string",
  "aiSystem": "string",
  "model": "string",
  "personaId": "string",
  "personaVersionId": "string",
  "conversationStatus": "string",
  "conversationName": "string",
  "chatMessages": [
    {
      "role": "string",
      "content": "string",
      "toolCallId": "string",
      "name": "string",
      "messageId": "string",
      "timestamp": "string",
      "feedbacks": [
        {
          "comments": null,
          "tags": null,
          "scoreConfidence": null
        }
      ],
      "promptTokens": 0,
      "completionTokens": 0,
      "totalTokens": 0,
      "conversationRunId": "string"
    }
  ],
  "chatMessagesCount": 0,
  "chatStarted": true,
  "areChatMessagesInBlob": true,
  "chatMessagesBlobUri": "string",
  "configuration": {
    "key": "string"
  },
  "metadata": {
    "key": {
      "options": {
        "propertyNameCaseInsensitive": true
      }
    }
  },
  "externalUserId": "string",
  "isActive": true,
  "isDeleted": true,
  "promptTokens": 0,
  "completionTokens": 0,
  "totalTokens": 0
}

{
  "conversationId": "string",
  "aiSystem": "string",
  "model": "string",
  "personaId": "string",
  "personaVersionId": "string",
  "conversationStatus": "string",
  "conversationName": "string",
  "chatMessages": [
    {
      "role": "string",
      "content": "string",
      "toolCallId": "string",
      "name": "string",
      "messageId": "string",
      "timestamp": "string",
      "feedbacks": [
        {
          "comments": null,
          "tags": null,
          "scoreConfidence": null
        }
      ],
      "promptTokens": 0,
      "completionTokens": 0,
      "totalTokens": 0,
      "conversationRunId": "string"
    }
  ],
  "chatMessagesCount": 0,
  "chatStarted": true,
  "areChatMessagesInBlob": true,
  "chatMessagesBlobUri": "string",
  "configuration": {
    "key": "string"
  },
  "metadata": {
    "key": {
      "options": {
        "propertyNameCaseInsensitive": true
      }
    }
  },
  "externalUserId": "string",
  "isActive": true,
  "isDeleted": true,
  "promptTokens": 0,
  "completionTokens": 0,
  "totalTokens": 0
}

400Bad Requestapplication/json

Array of ModelError

Exception

MethodBase

messageanytruncated

dataanytruncated

innerExceptionanytruncated

helpLinkanytruncated

sourceanytruncated

hResultanytruncated

stackTraceanytruncated

errorMessageanytruncated

Example payload

[
  {
    "exception": {
      "targetSite": {
        "memberType": 1,
        "name": "string",
        "declaringType": {
          "name": null,
          "customAttributes": null,
          "namespace": null,
          "assemblyQualifiedName": null,
          "fullName": null
        }
      }
    }
  }
]

[
  {
    "exception": {
      "targetSite": {
        "memberType": 1,
        "name": "string",
        "declaringType": {
          "name": null,
          "customAttributes": null,
          "namespace": null,
          "assemblyQualifiedName": null,
          "fullName": null
        }
      }
    }
  }
]

500Internal Server Error

No response body.

curl -X POST "https://api.hyperleapai.com/conversations/persona" \
  -H "x-hl-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "personaId": "string",
  "personaVersionId": "string",
  "replacements": {
    "key": {
      "options": {
        "propertyNameCaseInsensitive": true
      }
    }
  },
  "metadata": {
    "key": {
      "options": {
        "propertyNameCaseInsensitive": true
      }
    }
  },
  "stream": true,
  "externalUserId": "string"
}'

curl -X POST "https://api.hyperleapai.com/conversations/persona" \
  -H "x-hl-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "personaId": "string",
  "personaVersionId": "string",
  "replacements": {
    "key": {
      "options": {
        "propertyNameCaseInsensitive": true
      }
    }
  },
  "metadata": {
    "key": {
      "options": {
        "propertyNameCaseInsensitive": true
      }
    }
  },
  "stream": true,
  "externalUserId": "string"
}'

Example response · 200

{
  "conversationId": "string",
  "aiSystem": "string",
  "model": "string",
  "personaId": "string",
  "personaVersionId": "string",
  "conversationStatus": "string",
  "conversationName": "string",
  "chatMessages": [
    {
      "role": "string",
      "content": "string",
      "toolCallId": "string",
      "name": "string",
      "messageId": "string",
      "timestamp": "string",
      "feedbacks": [
        {
          "comments": null,
          "tags": null,
          "scoreConfidence": null
        }
      ],
      "promptTokens": 0,
      "completionTokens": 0,
      "totalTokens": 0,
      "conversationRunId": "string"
    }
  ],
  "chatMessagesCount": 0,
  "chatStarted": true,
  "areChatMessagesInBlob": true,
  "chatMessagesBlobUri": "string",
  "configuration": {
    "key": "string"
  },
  "metadata": {
    "key": {
      "options": {
        "propertyNameCaseInsensitive": true
      }
    }
  },
  "externalUserId": "string",
  "isActive": true,
  "isDeleted": true,
  "promptTokens": 0,
  "completionTokens": 0,
  "totalTokens": 0
}

{
  "conversationId": "string",
  "aiSystem": "string",
  "model": "string",
  "personaId": "string",
  "personaVersionId": "string",
  "conversationStatus": "string",
  "conversationName": "string",
  "chatMessages": [
    {
      "role": "string",
      "content": "string",
      "toolCallId": "string",
      "name": "string",
      "messageId": "string",
      "timestamp": "string",
      "feedbacks": [
        {
          "comments": null,
          "tags": null,
          "scoreConfidence": null
        }
      ],
      "promptTokens": 0,
      "completionTokens": 0,
      "totalTokens": 0,
      "conversationRunId": "string"
    }
  ],
  "chatMessagesCount": 0,
  "chatStarted": true,
  "areChatMessagesInBlob": true,
  "chatMessagesBlobUri": "string",
  "configuration": {
    "key": "string"
  },
  "metadata": {
    "key": {
      "options": {
        "propertyNameCaseInsensitive": true
      }
    }
  },
  "externalUserId": "string",
  "isActive": true,
  "isDeleted": true,
  "promptTokens": 0,
  "completionTokens": 0,
  "totalTokens": 0
}

Request body

Responses

Explore Hyperleap AI