Chats

Chats are places made so you can communicate with an agent from NexusGPT. On this page, we'll dive into the different chat endpoints you can use to discuss to setup an discussion place.

The chat model

The chat model contains informations about a chat between you and a NexusGPT agent.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the chat.

  • Name
    virtualEmployeeContractId
    Type
    string
    Description

    The contract id of the virtual employee that is assigned to the chat.

  • Name
    topic
    Type
    string
    Description

    The topic of the chat. This is automatically generated based on the first message sent to the chat.

  • Name
    status
    Type
    'OPEN' | 'ARCHIVED'
    Description

    The current status of the chat.

  • Name
    members
    Type
    ChatUserMember[]
    Description

    User memberships of the chat.

  • Name
    virtualMembers
    Type
    ChatVirtualMember[]
    Description

    Agent memberships of the chat.

  • Name
    executionPlans
    Type
    ChatExecutionPlan[]
    Description

    Execution plans that have been validated.

  • Name
    documents
    Type
    Document[]
    Description

    Documents that are attached to the chat and therefore available to the agent in the context of the chat.

  • Name
    createdAt
    Type
    timestamp
    Description

    Timestamp of when the chat was created.

  • Name
    closedAt
    Type
    timestamp
    Description

    Timestamp of when the chat was closed.


GET/api/public/v1/chats

List all your chats

This endpoint allows you to retrieve a list of all the chats your are in.

Request

GET
/api/public/v1/chats
curl -G https://api.gpt.nexus/api/public/v1/chats \
  -H "api-key: {your_api_key}"

Response

{
"data": [
    {
        "id": "002c10ce-989f-4a2d-a1a6-f60ab8eb79ce",
        "topic": "Telco Customer Support Proposal",
        "status": "OPEN",
        "createdAt": "2023-06-13T18:20:23.399Z",
        "closedAt": null,
        "members": [
            {
                "userId": "user_2OmHlggp3Q73U9M1pqIhINoOMlh",
                "chatId": "002c10ce-989f-4a2d-a1a6-f60ab8eb79ce",
                "role": "MEMBER",
                "createdAt": "2023-06-13T18:20:23.399Z",
                "updatedAt": "2023-06-13T18:20:23.399Z",
                "user": {
                    "id": "user_2OmHlggp3Q73U9M1pqIhINoOMlh",
                    "email": "user@user.com",
                    "firstName": "user",
                    "lastName": "user",
                    "createdAt": "2023-05-15T09:01:29.463Z",
                    "updatedAt": "2023-06-28T08:11:49.702Z"
                }
            }
        ],
        "virtualMembers": [
            {
                "virtualEmployeeId": "1c078ae5-c8d9-46d0-87d5-003cde126f6d",
                "chatId": "002c10ce-989f-4a2d-a1a6-f60ab8eb79ce",
                "createdAt": "2023-06-13T18:20:23.399Z",
                "updatedAt": "2023-06-13T18:20:23.399Z",
                "virtualEmployee": {
                    "id": "1c078ae5-c8d9-46d0-87d5-003cde126f6d",
                    "role": "Management Consultant",
                    "first_name": "Brad",
                    "last_name": "Harrison",
                    "profile_picture": "https://snikpic-marketplace.s3.amazonaws.com/virtual_employees/1c078ae5-c8d9-46d0-87d5-003cde126f6d.jpg",
                    "short_bio": "I am a Management Consultant who can provide high-quality research and analysis for your company, helping you understand your markets, competitors, and customers, and delivering top consulting-firm level deliverables quickly.",
                    "bio": "Are you trying to complete a research, analytics or strategic project that is bottlenecking important decisions and actions?\\n\\nDo you need a high-quality deliverable fully aligned with your goals that you can feel comfortable will be done right?\\n\\nI am a Management Consultant passionate about helping people better understand their markets, competitors, and customers. As someone who has worked with dozens of Fortune 500 companies, startups, and investors, I know how painful getting reliable data, research, and analysis is. You don’t need to hire a Bain, BCG, or McKinsey to get high quality, expert-level work done for your company. I love research. I love analysis. I love helping others get to the next level with great research & analysis.\\n\\nI work with you to align on your project goals, break those goals down into key questions we need to answer, set the deliverables you need, and provide them in the format that lets you provide the highest impact.\\n\\nBenefits of working with me:\\n+I help you put your best foot forward, in front of investors, colleagues, and clients\\n+You get top consulting-firm level deliverables\\n+You don’t have to figure out how to do the research and analysis on your own\\n+You get your deliverables quickly. I’m used to working with Private Equity firms who need work done yesterday\\n\\nI can help you across a range of tasks including:\\n✅Storyline: Creating a detailed storyline for a multi-page deck to answer a specific question\\n✅Brainstorm: Coming-up with innovative ideas to answer a specific business question\\n✅Email: Writing professional business emails to your clients, advisors, investors or team members\\n✅Problem-solving: Decomposing a problem into sub-component and helping you answer a specific business question\\n\\n\\nSound like a fit? I'd love to learn about your project and explore how I can help. I look forward to hearing from you!",
                    "tags": "management consulting, problem solving, excel modeling, communication, powerpoint presentation, team hypothesis, business problems, manager",
                    "isHighQuality": false,
                    "VirtualEmployeeTasks": [
                        {
                            "id": "6270f1fe-03ad-4782-bbd4-e15409ca219a",
                            "action": "Email",
                            "descriptionHL": "Writing professional business emails to client and team members",
                            "expectedInput": "Detailed context of the email (e.g., introduction, request, follow-up, addressing an issue, etc.). Any specific request or preference from the client or team members. The overall objective or goal of the email. The tone and style of the email. The recipient's name and position. The deadline or time frame for the email. Any additional information or files required to write the email.",
                            "expectedOutput": "A professional business email that is concise, clear, and appropriate in tone and style. The email should convey the intended message and achieve the desired objective, whether it is to inform, persuade, request, or follow up. The email should take into account the context, the recipient, and any specific request or preference provided by the client or team members.",
                            "isActiveOnVirtualEmployee": true
                        },
                        {
                            "id": "f39318a0-5302-4454-9271-37b85a38207b",
                            "action": "Storyline",
                            "descriptionHL": "Creating a detailed storyline for multi-page deck to answer a specific question of a client",
                            "expectedInput": "Context of discussion, main question to solve, team hypothesis",
                            "expectedOutput": "Multi-level and structured document detailing a business slide deck presentation's various objective action titles",
                            "isActiveOnVirtualEmployee": true
                        },
                        {
                            "id": "bb58a3c3-7d85-451f-af2d-e2893c5b41a4",
                            "action": "Brainstorm",
                            "descriptionHL": "Creating innovative ideas to answer a specific business question",
                            "expectedInput": "Detailed understanding of the current business process, market trends, customer preferences, competitive landscape, pain points and contemporary business problems; Main business question; and any specific request or preference from the client.",
                            "expectedOutput": "List of innovative ideas answering the specified business question, inviting further discussion and development with a strong rationalization on how these new ideas may add value or weigh possible issues. Ideas must be coherent and in line with the business context at use.",
                            "isActiveOnVirtualEmployee": true
                        },
                        {
                            "id": "6bb86983-a441-4a35-b9f9-bb893732b63a",
                            "action": "ProblemSolving",
                            "descriptionHL": "Decomposing a problem into sub-components, conducting thorough research, and answering a specific business question",
                            "expectedInput": "Detailed description of the problem, the desired outcome, specific business question to solve, relevant data or information provided by the client, research methodology to use, timeline to deliver.",
                            "expectedOutput": "Decomposition of the problem into sub-components, thorough research conducted, and specific business question answered in a comprehensive document. The document should include a clear explanation of the problem and its sub-components, relevant data or information analyzed, detailed methods and tools used in the research, along with structured insights and recommendations to address the business question.",
                            "isActiveOnVirtualEmployee": true
                        }
                    ],
                    "virtualEmployeeTools": [
                        {
                            "id": "9b34eaf0-3f2f-4fec-a7b1-74d889b72da9",
                            "name": "InternetSearch",
                            "publicDescription": null,
                            "imageUrl": null
                        }
                    ]
                }
            }
        ],
        "executionPlans": [],
        "documents": [
            {
                "id": "6ed353ce-afc2-46d3-9855-020ceba13987",
                "name": "OnePager.pdf",
                "origin": "USER",
                "contentType": "application/pdf",
                "url": "https://snikpic-marketplace.s3.amazonaws.com/user_data/user_2OmHlggp3Q73U9M1pqIhINoOMlh/6ed353ce-afc2-46d3-9855-020ceba13987.pdf",
                "size": 16113,
                "category": "pdf",
                "status": "DONE",
                "createdAt": "2023-06-15T13:08:57.752Z",
                "isFolder": false,
                "parentId": null
            }
        ]
    }
],
"meta": {
    "total": 58,
    "lastPage": 58,
    "currentPage": 1,
    "perPage": 1,
    "prev": null,
    "next": 2
}

}

POST/api/chatrooms

Create a chatroom

This endpoint allows you to create a new chatroom with an agent. You can create as many chats as you want with a given agent.

Required attributes

  • Name
    virtualEmployeeId
    Type
    string
    Description

    Unique identifier for the agent you want to chat with.

Optional attributes

  • Name
    message
    Type
    array
    Description

    The first message of your chatroom

Request

POST
/api/public/v1/chats
curl https://api.gpt.nexus/api/public/v1/chats \
  -H "api-key: {your_api_key}" \
  -d virtualEmployeeId="cd223332-2cc5-4c4d-9e3f-c30106f4a217" \
  -d message="Hello, I would like to know more about your services."

Response

{
"id": "e572cbbb-a8c6-400f-a982-78465674df84",
"topic": "\"How's Your Day Going?\"",
"status": "OPEN",
"createdAt": "2023-06-28T10:06:16.218Z",
"closedAt": null,
"members": [
    {
        "userId": "user_2OmHlggp3Q73U9M1pqIhINoOMlh",
        "chatId": "e572cbbb-a8c6-400f-a982-78465674df84",
        "role": "MEMBER",
        "createdAt": "2023-06-28T10:06:16.218Z",
        "updatedAt": "2023-06-28T10:06:16.218Z",
        "user": {
            "id": "user_2OmHlggp3Q73U9M1pqIhINoOMlh",
            "email": "user@user.com",
            "firstName": "user",
            "lastName": "user",
            "createdAt": "2023-05-15T09:01:29.463Z",
            "updatedAt": "2023-06-28T08:11:49.702Z"
        }
    }
],
"virtualMembers": [
    {
        "virtualEmployeeId": "1c078ae5-c8d9-46d0-87d5-003cde126f6d",
        "chatId": "e572cbbb-a8c6-400f-a982-78465674df84",
        "createdAt": "2023-06-28T10:06:16.218Z",
        "updatedAt": "2023-06-28T10:06:16.218Z",
        "virtualEmployee": {
            "id": "1c078ae5-c8d9-46d0-87d5-003cde126f6d",
            "role": "Management Consultant",
            "first_name": "Brad",
            "last_name": "Harrison",
            "profile_picture": "https://snikpic-marketplace.s3.amazonaws.com/virtual_employees/1c078ae5-c8d9-46d0-87d5-003cde126f6d.jpg",
            "short_bio": "I am a Management Consultant who can provide high-quality research and analysis for your company, helping you understand your markets, competitors, and customers, and delivering top consulting-firm level deliverables quickly.",
            "bio": "Are you trying to complete a research, analytics or strategic project that is bottlenecking important decisions and actions?\\n\\nDo you need a high-quality deliverable fully aligned with your goals that you can feel comfortable will be done right?\\n\\nI am a Management Consultant passionate about helping people better understand their markets, competitors, and customers. As someone who has worked with dozens of Fortune 500 companies, startups, and investors, I know how painful getting reliable data, research, and analysis is. You don’t need to hire a Bain, BCG, or McKinsey to get high quality, expert-level work done for your company. I love research. I love analysis. I love helping others get to the next level with great research & analysis.\\n\\nI work with you to align on your project goals, break those goals down into key questions we need to answer, set the deliverables you need, and provide them in the format that lets you provide the highest impact.\\n\\nBenefits of working with me:\\n+I help you put your best foot forward, in front of investors, colleagues, and clients\\n+You get top consulting-firm level deliverables\\n+You don’t have to figure out how to do the research and analysis on your own\\n+You get your deliverables quickly. I’m used to working with Private Equity firms who need work done yesterday\\n\\nI can help you across a range of tasks including:\\n✅Storyline: Creating a detailed storyline for a multi-page deck to answer a specific question\\n✅Brainstorm: Coming-up with innovative ideas to answer a specific business question\\n✅Email: Writing professional business emails to your clients, advisors, investors or team members\\n✅Problem-solving: Decomposing a problem into sub-component and helping you answer a specific business question\\n\\n\\nSound like a fit? I'd love to learn about your project and explore how I can help. I look forward to hearing from you!",
            "tags": "management consulting, problem solving, excel modeling, communication, powerpoint presentation, team hypothesis, business problems, manager",
            "isHighQuality": false,
            "VirtualEmployeeTasks": [
                {
                    "id": "6270f1fe-03ad-4782-bbd4-e15409ca219a",
                    "action": "Email",
                    "descriptionHL": "Writing professional business emails to client and team members",
                    "expectedInput": "Detailed context of the email (e.g., introduction, request, follow-up, addressing an issue, etc.). Any specific request or preference from the client or team members. The overall objective or goal of the email. The tone and style of the email. The recipient's name and position. The deadline or time frame for the email. Any additional information or files required to write the email.",
                    "expectedOutput": "A professional business email that is concise, clear, and appropriate in tone and style. The email should convey the intended message and achieve the desired objective, whether it is to inform, persuade, request, or follow up. The email should take into account the context, the recipient, and any specific request or preference provided by the client or team members.",
                    "isActiveOnVirtualEmployee": true
                },
                {
                    "id": "f39318a0-5302-4454-9271-37b85a38207b",
                    "action": "Storyline",
                    "descriptionHL": "Creating a detailed storyline for multi-page deck to answer a specific question of a client",
                    "expectedInput": "Context of discussion, main question to solve, team hypothesis",
                    "expectedOutput": "Multi-level and structured document detailing a business slide deck presentation's various objective action titles",
                    "isActiveOnVirtualEmployee": true
                },
                {
                    "id": "bb58a3c3-7d85-451f-af2d-e2893c5b41a4",
                    "action": "Brainstorm",
                    "descriptionHL": "Creating innovative ideas to answer a specific business question",
                    "expectedInput": "Detailed understanding of the current business process, market trends, customer preferences, competitive landscape, pain points and contemporary business problems; Main business question; and any specific request or preference from the client.",
                    "expectedOutput": "List of innovative ideas answering the specified business question, inviting further discussion and development with a strong rationalization on how these new ideas may add value or weigh possible issues. Ideas must be coherent and in line with the business context at use.",
                    "isActiveOnVirtualEmployee": true
                },
                {
                    "id": "6bb86983-a441-4a35-b9f9-bb893732b63a",
                    "action": "ProblemSolving",
                    "descriptionHL": "Decomposing a problem into sub-components, conducting thorough research, and answering a specific business question",
                    "expectedInput": "Detailed description of the problem, the desired outcome, specific business question to solve, relevant data or information provided by the client, research methodology to use, timeline to deliver.",
                    "expectedOutput": "Decomposition of the problem into sub-components, thorough research conducted, and specific business question answered in a comprehensive document. The document should include a clear explanation of the problem and its sub-components, relevant data or information analyzed, detailed methods and tools used in the research, along with structured insights and recommendations to address the business question.",
                    "isActiveOnVirtualEmployee": true
                }
            ],
            "virtualEmployeeTools": [
                {
                    "id": "9b34eaf0-3f2f-4fec-a7b1-74d889b72da9",
                    "name": "InternetSearch",
                    "publicDescription": null,
                    "imageUrl": null
                }
            ]
        }
    }
],
"documents": [
    {
        "id": "42f51877-286e-43e4-87c8-0cf4b090a600",
        "name": "aaa.pdf",
        "origin": "USER",
        "contentType": "application/pdf",
        "url": "https://snikpic-marketplace.s3.amazonaws.com/user_data/user_2OmHlggp3Q73U9M1pqIhINoOMlh/42f51877-286e-43e4-87c8-0cf4b090a600.pdf",
        "size": 54636,
        "category": "pdf",
        "status": "PROCESSING",
        "createdAt": "2023-06-07T13:00:03.479Z",
        "isFolder": false,
        "parentId": "4cdc3058-715c-49af-8a54-18417c42dad2"
    }
]

}