logo
API docs by Redocly

CompanyDNA API Documentation (V1)

Documentation for CompanyDNA APIs

CompanyDNA Swagger-UI

Chat Operations

Start a chat session

Start a new chat session with the given parameters.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
companyModelId
integer

The ID of the company model.

appId
integer

The application ID.

prompt
string

The prompt for the chat session.

history
Array of strings

Chat history.

Responses

Request samples

Content type
application/json
{
  • "companyModelId": 123456789,
  • "appId": 123456789,
  • "prompt": "Can you help me with my request?",
  • "history": [
    ]
}

Response samples

Content type
application/json
{
  • "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:
ApiKeyAuth
Request Body schema: application/json
required
companyAvatarId
integer

The ID of the company avatar.

prompt
string

The prompt for the chat session.

history
Array of strings

Chat history.

Responses

Request samples

Content type
application/json
{
  • "companyAvatarId": 123456789,
  • "prompt": "What can this avatar do?",
  • "history": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "output of chat with avatar"
}

Start a general chat session

Start a general chat session with the given parameters.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
prompt
string

The prompt for the chat session.

history
Array of strings

Chat history.

Responses

Request samples

Content type
application/json
{
  • "prompt": "General chat session request",
  • "history": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "output of chat with general"
}

Company Data

Get company apps

Retrieve a list of apps associated with the company.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "apps": [
    ]
}

Get company avatars

Retrieve a list of avatars associated with the company.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "avatars": [
    ]
}

Get company models

Retrieve a list of models associated with the company.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "models": [
    ]
}

Get company chief availability

Retrieve the availability status of the company's chief executive.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "name": "CompanyDNA",
  • "is_chief_available": true
}

Test

Test the API

Test if the API is running and reachable.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Succeeded"
}