SaaS Pilot fluxo API

fluxo-saaspilot.md

Auth

Para todas as rotas a seguir, enviar no header o authorization: Bearer saaspk-********

Pergunta (answers)

path

POST /api/v1/answers

Payload

{
   "user_input":"favor ajusta o cnpj para 08134761000148, os demais dados atualizo depois",
   "conversation_id":217,
   "user_api_key":"3k97h353lV6*************qZpEIJs",
   "user_description":"Whenever possible, address the user by the name 'Glauber' to make the conversation more personal and welcoming.",
   "mock_api_responses":false,
   "stream":true,
   "speechLanguage":"pt-BR"
}

Retorno

data: {"id":217,"role":"assistant","content":"Reason"}data: {"id":217,"role":"assistant","content":"ing"}data: {"id":217,"role":"assistant","content":":\n"}data: {"id":217,"role":"assistant","content":"1"}data: {"id":217,"role":"assistant","content":"."}data: {"id":217,"role":"assistant","content":" O"}data: {"id":217,"role":"assistant","content":" usuário"}data: {"id":217,"role":"assistant","content":" dese"}data: {"id":217,"role":"assistant","content":"ja"}data: {"id":217,"role":"assistant","content":" criar"}data: {"id":217,"role":"assistant","content":" um"}data: {"id":217,"role":"assistant","content":" novo"}data: {"id":217,"role":"assistant","content":" cliente"}data: {"id":217,"role":"assistant","content":" com"}data: {"id":217,"role":"assistant","content":" o"}data: {"id":217,"role":"assistant","content":" nome"}data: {"id":217,"role":"assistant","content":" \""}data: {"id":217,"role":"assistant","content":"E"}data: {"id":217,"role":"assistant","content":"du"}data: {"id":217,"role":"assistant","content":"ardo"}data: {"id":217,"role":"assistant","content":" e"}data: {"id":217,"role":"assistant","content":" Lore"}data: {"id":217,"role":"assistant","content":"na"}data: {"id":217,"role":"assistant","content":" Fot"}data: {"id":217,"role":"assistant","content":"ograf"}data: {"id":217,"role":"assistant","content":"ias"}data: {"id":217,"role":"assistant","content":" ME"}data: {"id":217,"role":"assistant","content":"\""}data: {"id":217,"role":"assistant","content":" e"}data: {"id":217,"role":"assistant","content":" o"}data: {"id":217,"role":"assistant","content":" CN"}data: {"id":217,"role":"assistant","content":"PJ"}data: {"id":217,"role":"assistant","content":" \""}data: {"id":217,"role":"assistant","content":"081"}data: {"id":217,"role":"assistant","content":"347"}data: {"id":217,"role":"assistant","content":"610"}data: {"id":217,"role":"assistant","content":"001"}data: {"id":217,"role":"assistant","content":"48"}data: {"id":217,"role":"assistant","content":"\".\n"}data: {"id":217,"role":"assistant","content":"2"}data: {"id":217,"role":"assistant","content":"."}data: {"id":217,"role":"assistant","content":" A"}data: {"id":217,"role":"assistant","content":" função"}data: {"id":217,"role":"assistant","content":" create"}data: {"id":217,"role":"assistant","content":"_customer"}data: {"id":217,"role":"assistant","content":" pode"}data: {"id":217,"role":"assistant","content":" ser"}data: {"id":217,"role":"assistant","content":" us"}data: {"id":217,"role":"assistant","content":"ada"}data: {"id":217,"role":"assistant","content":" para"}data: {"id":217,"role":"assistant","content":" criar"}data: {"id":217,"role":"assistant","content":" um"}data: {"id":217,"role":"assistant","content":" novo"}data: {"id":217,"role":"assistant","content":" cliente"}data: {"id":217,"role":"assistant","content":".\n"}data: {"id":217,"role":"assistant","content":"3"}data: {"id":217,"role":"assistant","content":"."}data: {"id":217,"role":"assistant","content":" Como"}data: {"id":217,"role":"assistant","content":" o"}data: {"id":217,"role":"assistant","content":" usuário"}data: {"id":217,"role":"assistant","content":" não"}data: {"id":217,"role":"assistant","content":" for"}data: {"id":217,"role":"assistant","content":"ne"}data: {"id":217,"role":"assistant","content":"ceu"}data: {"id":217,"role":"assistant","content":" outras"}data: {"id":217,"role":"assistant","content":" informações"}data: {"id":217,"role":"assistant","content":","}data: {"id":217,"role":"assistant","content":" como"}data: {"id":217,"role":"assistant","content":" email"}data: {"id":217,"role":"assistant","content":","}data: {"id":217,"role":"assistant","content":" telefone"}data: {"id":217,"role":"assistant","content":" ou"}data: {"id":217,"role":"assistant","content":" end"}data: {"id":217,"role":"assistant","content":"ereço"}data: {"id":217,"role":"assistant","content":","}data: {"id":217,"role":"assistant","content":" ess"}data: {"id":217,"role":"assistant","content":"es"}data: {"id":217,"role":"assistant","content":" campos"}data: {"id":217,"role":"assistant","content":" serão"}data: {"id":217,"role":"assistant","content":" deix"}data: {"id":217,"role":"assistant","content":"ados"}data: {"id":217,"role":"assistant","content":" em"}data: {"id":217,"role":"assistant","content":" br"}data: {"id":217,"role":"assistant","content":"anco"}data: {"id":217,"role":"assistant","content":" por"}data: {"id":217,"role":"assistant","content":" enquanto"}data: {"id":217,"role":"assistant","content":".\n\n"}data: {"id":217,"role":"assistant","content":"Commands"}data: {"id":217,"role":"assistant","content":":\n"}data: {"id":217,"role":"assistant","content":"create"}data: {"id":217,"role":"assistant","content":"_customer"}data: {"id":217,"role":"assistant","content":"(name"}data: {"id":217,"role":"assistant","content":"=\""}data: {"id":217,"role":"assistant","content":"E"}data: {"id":217,"role":"assistant","content":"du"}data: {"id":217,"role":"assistant","content":"ardo"}data: {"id":217,"role":"assistant","content":" e"}data: {"id":217,"role":"assistant","content":" Lore"}data: {"id":217,"role":"assistant","content":"na"}data: {"id":217,"role":"assistant","content":" Fot"}data: {"id":217,"role":"assistant","content":"ograf"}data: {"id":217,"role":"assistant","content":"ias"}data: {"id":217,"role":"assistant","content":" ME"}data: {"id":217,"role":"assistant","content":"\","}data: {"id":217,"role":"assistant","content":" cpf"}data: {"id":217,"role":"assistant","content":"C"}data: {"id":217,"role":"assistant","content":"npj"}data: {"id":217,"role":"assistant","content":"=\""}data: {"id":217,"role":"assistant","content":"081"}data: {"id":217,"role":"assistant","content":"347"}data: {"id":217,"role":"assistant","content":"610"}data: {"id":217,"role":"assistant","content":"001"}data: {"id":217,"role":"assistant","content":"48"}data: {"id":217,"role":"assistant","content":"\")"}data: {"id":217,"role":"confirmation","content":"[{\"actionId\":53,\"args\":{\"name\":\"Eduardo e Lorena Fotografias ME\",\"cpfCnpj\":\"08134761000148\"},\"name\":\"create_customer\",\"argsForDisplay\":{\"Nome do cliente\":\"Eduardo e Lorena Fotografias ME\",\"CNPJ/CPF do cliente\":\"08134761000148\"},\"suggestionForDisplay\":\"Nome do cliente: Eduardo e Lorena Fotografias ME\\nCNPJ/CPF do cliente: 08134761000148\\n\"}]"}

Rota confirmar (confirm)

path

POST /api/v1/confirm

Payload

{
   "conversation_id":217,
   "user_api_key":"3k97h353*****************XdpP5qZpEIJs",
   "confirm":true,
   "mock_api_responses":false
}

Retorno

Pode ignorar, basta olhar se status code foi 200
Nota, dentro de content e o retorno da API que foi chamada, no exemplo eu criei um cliente na API do Base.

{
    "outs": [
        {
            "role": "function",
            "name": "create_customer",
            "content": "{\n  \"name\": \"Eduardo e Lorena Fotografias ME\",\n  \"cpfCnpj\": \"08134761000148\",\n  \"email\": null,\n  \"phone\": null,\n  \"mobilePhone\": null,\n  \"billingAddress\": {\n    \"postalCode\": null,\n    \"address\": null,\n    \"addressNumber\": null,\n    \"complement\": null,\n    \"province\": null,\n    \"cityName\": null,\n    \"stateAbbrev\": null,\n    \"country\": null\n  },\n  \"deliveryAddress\": {\n    \"postalCode\": null,\n    \"address\": null,\n    \"addressNumber\": null,\n    \"complement\": null,\n    \"province\": null,\n    \"cityName\": null,\n    \"stateAbbrev\": null,\n    \"country\": null,\n    \"name\": null,\n    \"cpfCnpj\": null,\n    \"email\": null,\n    \"phone\": null\n  },\n  \"taxInformation\": {\n    \"stateInscription\": null,\n    \"municipalInscription\": null,\n    \"typeOfTaxPayer\": null,\n    \"finalConsumer\": false,\n    \"simpleTax\": false,\n    \"ruralProducer\": false\n  },\n  \"externalReference\": null,\n  \"observations\": null,\n  \"id\": 101190581,\n  \"deleted\": false,\n  \"asaasId\": \"cus_000006569425\"\n}",
            "urls": [
                {
                    "name": "Documentacao",
                    "url": "https://docs.baseerp.com.br/reference/createcustomer#/"
                }
            ]
        }
    ]
}

Pergunta pos confirmation

Segredo, mandar user_input sem pergunta(string vazia).

path

POST /api/v1/answers

Payload

{
   "user_input":"",
   "conversation_id":217,
   "user_api_key":"3k97h353lV6**************EIJs",
   "user_description":"Whenever possible, address the user by the name 'Glauber' to make the conversation more personal and welcoming.",
   "mock_api_responses":false,
   "stream":true,
   "speechLanguage":"pt-BR"
}

Retorno

data: {"id":217,"role":"assistant","content":"Reason"}data: {"id":217,"role":"assistant","content":"ing"}data: {"id":217,"role":"assistant","content":":\n"}data: {"id":217,"role":"assistant","content":"1"}data: {"id":217,"role":"assistant","content":"."}data: {"id":217,"role":"assistant","content":" O"}data: {"id":217,"role":"assistant","content":" cliente"}data: {"id":217,"role":"assistant","content":" \""}data: {"id":217,"role":"assistant","content":"E"}data: {"id":217,"role":"assistant","content":"du"}data: {"id":217,"role":"assistant","content":"ardo"}data: {"id":217,"role":"assistant","content":" e"}data: {"id":217,"role":"assistant","content":" Lore"}data: {"id":217,"role":"assistant","content":"na"}data: {"id":217,"role":"assistant","content":" Fot"}data: {"id":217,"role":"assistant","content":"ograf"}data: {"id":217,"role":"assistant","content":"ias"}data: {"id":217,"role":"assistant","content":" ME"}data: {"id":217,"role":"assistant","content":"\""}data: {"id":217,"role":"assistant","content":" foi"}data: {"id":217,"role":"assistant","content":" cri"}data: {"id":217,"role":"assistant","content":"ado"}data: {"id":217,"role":"assistant","content":" com"}data: {"id":217,"role":"assistant","content":" sucesso"}data: {"id":217,"role":"assistant","content":" com"}data: {"id":217,"role":"assistant","content":" o"}data: {"id":217,"role":"assistant","content":" CN"}data: {"id":217,"role":"assistant","content":"PJ"}data: {"id":217,"role":"assistant","content":" \""}data: {"id":217,"role":"assistant","content":"081"}data: {"id":217,"role":"assistant","content":"347"}data: {"id":217,"role":"assistant","content":"610"}data: {"id":217,"role":"assistant","content":"001"}data: {"id":217,"role":"assistant","content":"48"}data: {"id":217,"role":"assistant","content":"\".\n"}data: {"id":217,"role":"assistant","content":"2"}data: {"id":217,"role":"assistant","content":"."}data: {"id":217,"role":"assistant","content":" O"}data: {"id":217,"role":"assistant","content":" ID"}data: {"id":217,"role":"assistant","content":" do"}data: {"id":217,"role":"assistant","content":" cliente"}data: {"id":217,"role":"assistant","content":" rec"}data: {"id":217,"role":"assistant","content":"ém"}data: {"id":217,"role":"assistant","content":"-"}data: {"id":217,"role":"assistant","content":"cri"}data: {"id":217,"role":"assistant","content":"ado"}data: {"id":217,"role":"assistant","content":" é"}data: {"id":217,"role":"assistant","content":" "}data: {"id":217,"role":"assistant","content":"101"}data: {"id":217,"role":"assistant","content":"190"}data: {"id":217,"role":"assistant","content":"581"}data: {"id":217,"role":"assistant","content":" e"}data: {"id":217,"role":"assistant","content":" o"}data: {"id":217,"role":"assistant","content":" as"}data: {"id":217,"role":"assistant","content":"a"}data: {"id":217,"role":"assistant","content":"as"}data: {"id":217,"role":"assistant","content":"Id"}data: {"id":217,"role":"assistant","content":" é"}data: {"id":217,"role":"assistant","content":" \""}data: {"id":217,"role":"assistant","content":"cus"}data: {"id":217,"role":"assistant","content":"_"}data: {"id":217,"role":"assistant","content":"000"}data: {"id":217,"role":"assistant","content":"006"}data: {"id":217,"role":"assistant","content":"569"}data: {"id":217,"role":"assistant","content":"425"}data: {"id":217,"role":"assistant","content":"\".\n"}data: {"id":217,"role":"assistant","content":"3"}data: {"id":217,"role":"assistant","content":"."}data: {"id":217,"role":"assistant","content":" As"}data: {"id":217,"role":"assistant","content":" outras"}data: {"id":217,"role":"assistant","content":" informações"}data: {"id":217,"role":"assistant","content":" do"}data: {"id":217,"role":"assistant","content":" cliente"}data: {"id":217,"role":"assistant","content":" ainda"}data: {"id":217,"role":"assistant","content":" estão"}data: {"id":217,"role":"assistant","content":" v"}data: {"id":217,"role":"assistant","content":"az"}data: {"id":217,"role":"assistant","content":"ias"}data: {"id":217,"role":"assistant","content":","}data: {"id":217,"role":"assistant","content":" conforme"}data: {"id":217,"role":"assistant","content":" solicit"}data: {"id":217,"role":"assistant","content":"ado"}data: {"id":217,"role":"assistant","content":" pelo"}data: {"id":217,"role":"assistant","content":" usuário"}data: {"id":217,"role":"assistant","content":".\n\n"}data: {"id":217,"role":"assistant","content":"Tell"}data: {"id":217,"role":"assistant","content":" user"}data: {"id":217,"role":"assistant","content":":"}data: {"id":217,"role":"assistant","content":" G"}data: {"id":217,"role":"assistant","content":"la"}data: {"id":217,"role":"assistant","content":"uber"}data: {"id":217,"role":"assistant","content":","}data: {"id":217,"role":"assistant","content":" o"}data: {"id":217,"role":"assistant","content":" novo"}data: {"id":217,"role":"assistant","content":" cliente"}data: {"id":217,"role":"assistant","content":" \""}data: {"id":217,"role":"assistant","content":"E"}data: {"id":217,"role":"assistant","content":"du"}data: {"id":217,"role":"assistant","content":"ardo"}data: {"id":217,"role":"assistant","content":" e"}data: {"id":217,"role":"assistant","content":" Lore"}data: {"id":217,"role":"assistant","content":"na"}data: {"id":217,"role":"assistant","content":" Fot"}data: {"id":217,"role":"assistant","content":"ograf"}data: {"id":217,"role":"assistant","content":"ias"}data: {"id":217,"role":"assistant","content":" ME"}data: {"id":217,"role":"assistant","content":"\""}data: {"id":217,"role":"assistant","content":" foi"}data: {"id":217,"role":"assistant","content":" cri"}data: {"id":217,"role":"assistant","content":"ado"}data: {"id":217,"role":"assistant","content":" com"}data: {"id":217,"role":"assistant","content":" sucesso"}data: {"id":217,"role":"assistant","content":" com"}data: {"id":217,"role":"assistant","content":" o"}data: {"id":217,"role":"assistant","content":" CN"}data: {"id":217,"role":"assistant","content":"PJ"}data: {"id":217,"role":"assistant","content":" \""}data: {"id":217,"role":"assistant","content":"081"}data: {"id":217,"role":"assistant","content":"347"}data: {"id":217,"role":"assistant","content":"610"}data: {"id":217,"role":"assistant","content":"001"}data: {"id":217,"role":"assistant","content":"48"}data: {"id":217,"role":"assistant","content":"\"."}data: {"id":217,"role":"assistant","content":" O"}data: {"id":217,"role":"assistant","content":" ID"}data: {"id":217,"role":"assistant","content":" do"}data: {"id":217,"role":"assistant","content":" novo"}data: {"id":217,"role":"assistant","content":" cliente"}data: {"id":217,"role":"assistant","content":" é"}data: {"id":217,"role":"assistant","content":" "}data: {"id":217,"role":"assistant","content":"101"}data: {"id":217,"role":"assistant","content":"190"}data: {"id":217,"role":"assistant","content":"581"}data: {"id":217,"role":"assistant","content":"."}data: {"id":217,"role":"assistant","content":" Você"}data: {"id":217,"role":"assistant","content":" pode"}data: {"id":217,"role":"assistant","content":" atual"}data: {"id":217,"role":"assistant","content":"izar"}data: {"id":217,"role":"assistant","content":" as"}data: {"id":217,"role":"assistant","content":" outras"}data: {"id":217,"role":"assistant","content":" informações"}data: {"id":217,"role":"assistant","content":" do"}data: {"id":217,"role":"assistant","content":" cliente"}data: {"id":217,"role":"assistant","content":" quando"}data: {"id":217,"role":"assistant","content":" est"}data: {"id":217,"role":"assistant","content":"iver"}data: {"id":217,"role":"assistant","content":" pronto"}data: {"id":217,"role":"assistant","content":"."}