aumoai - saascore v1¶

Chat Messages¶

POST /api/v1/chat/messages/create-chat-session/{workspace_id}/{channel}/{channel_plugin}/{channel_id}¶

Create Chat Session Post

Input parameters

Parameter	In	Type	Nullable	Description
`aumo-key`	header	string	No	AUMO Key.
`channel`	path	string	No	Canal de comunicação.
`channel_id`	path	string	No	ID da configuração no sistema do canal de comunicação.
`channel_plugin`	path	string	No	Plugin a ser usado.
`workspace_id`	path	string	No	Workspace.

Request body

application/json

{
    "persona_id": 0,
    "agi_id": "string",
    "channel_session_id": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "persona_id": {
            "type": "integer",
            "title": "Persona ID",
            "description": "Persona ID",
            "default": 0,
            "examples": [
                "0",
                "1",
                "2"
            ]
        },
        "agi_id": {
            "type": "string",
            "title": "AGI ID",
            "description": "AGI ID",
            "examples": [
                "018f4e6b-3308-77de-b735-16f828b3d2f0"
            ]
        },
        "channel_session_id": {
            "type": "string",
            "title": "Channel Session ID",
            "description": "Chat ID assigned by the channel",
            "examples": [
                "018f4e6b-4060-75cf-b9e8-e6dabce743b6"
            ]
        }
    },
    "type": "object",
    "required": [
        "agi_id",
        "channel_session_id"
    ],
    "title": "CreateChatSessionRequest"
}

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

POST /api/v1/chat/messages/send-message/{workspace_id}/{channel}/{channel_plugin}/{channel_id}/bychannelsession/{channel_session_id}¶

Chat Message Post

Input parameters

Parameter	In	Type	Nullable	Description
`aumo-key`	header	string	No	AUMO Key.
`channel`	path	string	No	Canal de comunicação.
`channel_id`	path	string	No	ID da configuração no sistema do canal de comunicação.
`channel_plugin`	path	string	No	Plugin a ser usado.
`channel_session_id`	path	string	No	ID atribuída pelo canal à sessão onde será inserida a mensagem.
`workspace_id`	path	string	No	Workspace.

Request body

application/json

{
    "message": "string",
    "channel_user_message_id": "018f6077-402c-7bc5-87ba-b0aa712b4ed1",
    "channel_assistant_message_id": "018f6077-402c-7bc5-87ba-b0aa712b4ed2"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "message": {
            "type": "string",
            "title": "Message",
            "description": "Message to be sent to the AI",
            "examples": [
                "Hello, my name is John. Who are you?"
            ]
        },
        "channel_user_message_id": {
            "type": "string",
            "title": "Channel User Message ID",
            "description": "User Message ID assigned by the channel",
            "example": "018f6077-402c-7bc5-87ba-b0aa712b4ed1"
        },
        "channel_assistant_message_id": {
            "type": "string",
            "title": "Channel Assistant Message ID",
            "description": "Assistant Message ID assigned by the channel",
            "example": "018f6077-402c-7bc5-87ba-b0aa712b4ed2"
        }
    },
    "type": "object",
    "required": [
        "message",
        "channel_user_message_id",
        "channel_assistant_message_id"
    ],
    "title": "SendMessageRequestSchema"
}

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Schemas¶

CreateChatSessionRequest¶

Name	Type
`agi_id`	string
`channel_session_id`	string
`persona_id`	integer

HTTPValidationError¶

Name	Type
`detail`	Array<ValidationError>

SendMessageRequestSchema¶

Name	Type
`channel_assistant_message_id`	string
`channel_user_message_id`	string
`message`	string

ValidationError¶

Name	Type
`loc`	Array<>
`msg`	string
`type`	string