Start a chat session
Start a new chat session with the given parameters.
Authorizations:
Request Body schema: application/jsonrequired
| subscriptionId | integer The subscription ID of the company. |
| companyModelId | integer The ID of the company model. |
| companyId | integer The ID of the company. |
| appId | integer The application ID. |
| prompt | string The prompt for the chat session. |
| history | Array of strings Chat history. |
Responses
Request samples
- Payload
{- "subscriptionId": 123456789,
- "companyModelId": 123456789,
- "companyId": 123456789,
- "appId": 123456789,
- "prompt": "Can you help me with my request?",
- "history": [
- "Message 1",
- "Message 2"
]
}Response samples
- 200
{- "success": true,
- "message": "output of chat"
}Start a chat session with an avatar
Start a new chat session using an avatar with the given parameters.
Authorizations:
Request Body schema: application/jsonrequired
| subscriptionId | integer The subscription ID of the company. |
| companyModelId | integer The ID of the company model. |
| companyId | integer The ID of the company. |
| appId | integer The application ID. |
| prompt | string The prompt for the chat session. |
| history | Array of strings Chat history. |
Responses
Request samples
- Payload
{- "subscriptionId": 123456789,
- "companyModelId": 123456789,
- "companyId": 123456789,
- "appId": 123456789,
- "prompt": "What can this avatar do?",
- "history": [
- "Avatar history 1",
- "Avatar history 2"
]
}Response samples
- 200
{- "success": true,
- "message": "output of chat with avatar"
}Start a general chat session
Start a general chat session with the given parameters.
Authorizations:
Request Body schema: application/jsonrequired
| subscriptionId | integer The subscription ID of the company. |
| companyModelId | integer The ID of the company model. |
| companyId | integer The ID of the company. |
| appId | integer The application ID. |
| prompt | string The prompt for the chat session. |
| history | Array of strings Chat history. |
Responses
Request samples
- Payload
{- "subscriptionId": 123456789,
- "companyModelId": 123456789,
- "companyId": 123456789,
- "appId": 123456789,
- "prompt": "General chat session request",
- "history": [
- "General history 1",
- "General history 2"
]
}Response samples
- 200
{- "success": true,
- "message": "output of chat with general"
}Get company apps
Retrieve a list of apps associated with the company.
Authorizations:
Request Body schema: application/jsonrequired
| companyId | integer The ID of the company. |
Responses
Request samples
- Payload
{- "companyId": 123456789
}Response samples
- 200
{- "apps": [
- {
- "id": 123456789,
- "appId": 123456789,
- "companyId": 123456789,
- "app": {
- "name": "App"
}
}, - {
- "id": 123456789,
- "appId": 123456789,
- "companyId": 123456789,
- "app": {
- "name": "App"
}
}
]
}Get company avatars
Retrieve a list of avatars associated with the company.
Authorizations:
Request Body schema: application/jsonrequired
| companyId | integer The ID of the company. |
Responses
Request samples
- Payload
{- "companyId": 123456789
}Response samples
- 200
{- "avatars": [
- {
- "id": 123456789,
- "name": "Avatar One",
- "companyId": 123456789
}, - {
- "id": 123456789,
- "name": "Avatar Two",
- "companyId": 123456789
}
]
}Get company models
Retrieve a list of models associated with the company.
Authorizations:
Request Body schema: application/jsonrequired
| companyId | integer The ID of the company. |
Responses
Request samples
- Payload
{- "companyId": 123456789
}Response samples
- 200
{- "models": [
- {
- "id": 123456789,
- "companyId": 123456789,
- "model": {
- "id": 123456789,
- "name": "Model One"
}
}, - {
- "id": 123456789,
- "companyId": 123456789,
- "model": {
- "id": 123456789,
- "name": "Model Two"
}
}
]
}Test the API
Test if the API is running and reachable.
Authorizations:
Request Body schema: application/jsonrequired
| companyId | integer The ID of the company. |
Responses
Request samples
- Payload
{- "companyId": 123456789
}Response samples
- 200
{- "success": true,
- "message": "Succeeded"
}