Resources · Reference

API documentation

Use the Vioniko HTTP API from your own backend. Issue a key on /developers and pass it on every request.

Overview

The Vioniko HTTP API exposes the data your assistants and voice bots collect — customer records, run summaries and attached PDFs. All endpoints accept JSON.

Base URL

https://www.chatvioniko.com/api

Format

application/json

Authentication

Pass your API key as a query parameter (legacy) or as a Bearer token. Issue keys at /developers.

bash
curl "https://www.chatvioniko.com/api/pdfcustomers?apiKey=YOUR_KEY&fileName=invoice.pdf&date=2024-03-14&telephone=1234567890&name=John%20Doe"

Fetch customers

Wrap the call in a small helper so retries and redirects are handled the same way every time. The helper takes:

  • apiKeyapiKeyParam
  • fileNamefileNameParam
  • datedateParam
  • telephonetelephoneParam
  • namenameParam
javascript
const https = require('https');

function fetchCustomerData(
  apiKey,
  fileName,
  date,
  telephone,
  name,
  attempt = 0,
) {
  const queryParams = new URLSearchParams({
    apiKey,
    fileName,
    date,
    telephone,
    name,
  }).toString();
  const options = {
    hostname: 'www.chatvioniko.com',
    path: `/api/pdfcustomers?${queryParams}`,
    method: 'GET',
  };

  const req = https.request(options, (res) => {
    if ([301, 302, 307, 308].includes(res.statusCode) && res.headers.location) {
      if (attempt > 5) {
        console.error('Too many redirects');
        return;
      }
      console.log(`Redirecting to ${res.headers.location}`);
      const url = new URL(res.headers.location);
      options.hostname = url.hostname;
      options.path = url.pathname + url.search;
      fetchCustomerData(apiKey, fileName, date, telephone, name, attempt + 1);
      return;
    }

    console.log(`statusCode: ${res.statusCode}`);

    let data = '';
    res.on('data', (chunk) => {
      data += chunk;
    });

    res.on('end', () => {
      try {
        const parsedData = JSON.parse(data);
        console.log('Response:', parsedData);
      } catch (error) {
        console.error('Error parsing JSON:', error);
      }
    });
  });

  req.on('error', (error) => {
    console.error(error);
  });

  req.end();
}

// Example usage
fetchCustomerData(
  'api-key',
  'fileName.pdf',
  '2024-03-14',
  '1234567890',
  'John Doe',
);

Errors

Errors are returned as JSON with an error field. Most common causes are an invalid key, an expired subscription, or rate limiting.

Video tutorials

Short walkthroughs to help you master Vioniko AI faster.

No videos match your filters yet.

Try clearing a filter or come back later — we add walkthroughs every week.