Visão geral

A API de chat facilita a recuperação de chatbots e permite aos utilizadores interagir com eles através da publicação de mensagens.

URL de base

https://app.openspokenai.com/api

Autenticação

Os clientes devem autenticar-se com um cabeçalho de Autorização Básica para cada pedido:

Autorização: Básico {authString}

Onde {authString} é a cadeia de caracteres codificada em base64 do formato nome de utilizador:palavra-passe.

Exemplo de utilização: 

curl -X GET "https://app.openspokenai.com/api/chat" -H "Autorização: Basic {authString}"

Pontos finais

GET /chat

Recupera uma lista de chats activos disponíveis para interação.

Parâmetros de consulta:

grupo (opcional): Filtrar chats por um grupo especificado.

Resposta bem sucedida:

{

    "mensagem": "sucesso",

    "dados": [

        {

            "nome": "string",

            "chat_code": "string",

            "descrição": "string",

            "grupo": "string"

        }

    ]

}

Nenhum conteúdo encontrado:

{

    "mensagem": "erro",

    "dados": {

        "mensagem": "Não foi encontrado nenhum chatbot para o grupo especificado".

    }

}

POST /chat

Enviar uma mensagem para um chat específico e receber uma resposta.

Cabeçalhos:

Content-Type: application/json

Autorização: Básico {authString}

Carga útil necessária:

prompt: (string) O texto de entrada para a resposta do chat.

request_id: (string) Uma identificação única para registar o pedido.

webhook_url (opcional): (URL) O ponto final para o qual a resposta deve ser enviada via webhook.

Resposta bem sucedida:

{

    "mensagem": "sucesso",

    "dados": {

        "request_id": "string",

        "mensagem": "string"

    }

}

Respostas a erros:

Créditos insuficientes:

{

    "mensagem": "erro",

    "dados": {

        "mensagem": "Esgotou os créditos para gerar palavras. Por favor, carregue e tente novamente".

    }

}

Chatbot não encontrado:

{

    "mensagem": "erro",

    "dados": {

        "mensagem": "Chatbot não encontrado".

    }

}

Falha no webhook:

{

    "mensagem": "erro",

    "dados": {

        "mensagem": "Falha ao enviar a resposta ao webhook".

    }

}

GET /chat/balance

– Retrieves remaining word balance for authenticated user
– Returns user’s own balance, or parent account balance if user has zero words
– Required header: Authorization: Basic {authString}

Successful Response Example:
{
"mensagem": "sucesso",
"dados": {
“remaining_words”: 15000
}
}

Error Response:
{
"mensagem": "erro",
"dados": {
“message”: “Failed to retrieve balance.”
}
}