Create a General Conversation

post

https://api.hyperleap.ai/conversations

Create a General Conversation, without targetting a Persona.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The request body

Create a new GenAi Conversation request.

systemMessage

string | null

The system message for this Conversation request.

aiSystem

string

required

length ≥ 1

The AI system that this Conversation request is for. Allows OpenAi, AzureOpenAi, AnthropicClaude, Cohere and GooglePalm.

model

string

required

length ≥ 1

The model that this Conversation request is for. E.g. gpt-3.5-turbo, claude-01, etc. This model must be available for the AI system specified.

configuration

object | null

The configuration to use for this Conversation request. (defaults to null). Required when you want to specify a configuration.

replacements

object | null

The replacements to use when there are variables in the system message.

metadata

object | null

Additional metadata for this conversation to be saved.

externalUserId

string | null

The ID representing an external user, to be associated with this Conversation request.

Headers

x-hl-api-key

string

required

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

500

Server Error

200Success

400Bad Request