Skip to main content

Quick Start for Generation

In this guide, we'll walk you through how to get started with the Generation endpoint of the Agent Assist API. This endpoint allows you to generate automated responses based on customer inquiries, using templates or flexible responses.

Follow these steps to integrate the generation functionality into your application.

Step 1: Prepare the Payload​

To generate a response, you need to prepare a request payload. You can send a request with or without a template. Here is an example of a request with a template and metadata:

{
  "subject": "Demande de remboursement suite à un accident de voiture",
  "body": "Bonjour,\n\nJe vous écris pour déclarer un sinistre suite à un accident de voiture survenu le 10 septembre 2024. Mon véhicule a été gravement endommagé, et je souhaiterais obtenir un remboursement pour les réparations.\n\nVoici les détails :\n- Numéro de contrat : 123456789\n- Date de l'accident : 10/09/2024\n- Lieu : Paris, France\n\nMerci de m'indiquer les démarches à suivre pour la prise en charge du sinistre.\n\nCordialement,\nJean Dupont",
  "metadata": {
    "date": "2024-09-11",
    "policy_number": "123456789",
    "sender": "jean.dupont@mail.com"
  },
  "template": "Bonjour [Nom du Client],\n\nMerci de nous avoir contactés. Nous sommes désolés d'apprendre l'accident et espérons que tout le monde est en sécurité. Pour déclarer un accident auprès de nos services, veuillez suivre les étapes ci-dessous :\n\n..."
}

You can also omit the template, subject, or metadata fields if they are not needed for your use case.

Step 2: Send the Request​

Once your payload is ready, send it via a POST request to the following endpoint:

Endpoint: POST /api/companies/{companyCuid}/orchestrators/{orchestratorCuid}/generation

Example cURL Request:

curl -X POST https://api.dialonce.ai/agent-assist/v1/companies/{companyCuid}/orchestrators/{orchestratorCuid}/generation \
  -H "Authorization: Bearer YOUR_BEARER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Demande de remboursement suite à un accident de voiture",
    "body": "Bonjour,\n\nJe vous écris pour déclarer un sinistre suite à un accident de voiture...",
    "metadata": {
      "date": "2024-09-11",
      "policy_number": "123456789",
      "sender": "jean.dupont@mail.com"
    },
    "template": "Bonjour [Nom du Client],\n\nMerci de nous avoir contactés..."
  }'

Step 3: Handle the Response​

The response will contain the generated reply based on the sources from crai-office. Here's an example of a successful response:

{
  "response": "Bonjour Jean Dupont,\n\nMerci de nous avoir contactés. Nous sommes désolés d'apprendre l'accident et espérons que tout le monde est en sécurité. Pour déclarer un accident auprès de nos services, veuillez suivre les étapes ci-dessous :\n\n..."
}

Next Steps​

Now that you've seen how to make a basic request, you can explore more advanced options: