MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Account/User Management Endpoints

List of endpoints to manage user and account access/security

GET api/informations

Example request:
curl --request GET \
    --get "http://diabolocom-ai.local/api/informations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://diabolocom-ai.local/api/informations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "name": "Dolor nemo quia vel in. Sunt labore debitis velit. Amet et vero nulla repudiandae perspiciatis.",
        "account": {
            "email": "marine11@example.net",
            "name": "Michèle Bonneau"
        }
    }
}
 

Request      

GET api/informations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Databuckets Endpoints

List of endpoints associated to databuckets

GET api/buckets

Example request:
curl --request GET \
    --get "http://diabolocom-ai.local/api/buckets" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://diabolocom-ai.local/api/buckets"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "b1ee4370-9b56-4b87-8eb8-dee59919eb52",
            "title": "Accusantium voluptatem adipisci consequatur repellat qui ipsa.",
            "created_at": 918479857,
            "entries_count": 1,
            "webhooks": {
                "enabled": false,
                "link": null,
                "signing_enabled": false,
                "secret": null
            }
        },
        {
            "id": "bf44cebf-498c-4cea-90f5-6bdeafb8e375",
            "title": "Saepe ducimus tempore adipisci.",
            "created_at": 530915054,
            "entries_count": 1,
            "webhooks": {
                "enabled": false,
                "link": null,
                "signing_enabled": false,
                "secret": null
            }
        }
    ]
}
 

Request      

GET api/buckets

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/buckets/{dataBucket}/entries

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/buckets/pariatur/entries" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": \"xntefluuqhngztgiv\",
    \"entries\": \"jlpuyh\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/buckets/pariatur/entries"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "content": "xntefluuqhngztgiv",
    "entries": "jlpuyh"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "added_entries": 5
}
 

Request      

POST api/buckets/{dataBucket}/entries

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

dataBucket   string   

Example: pariatur

Body Parameters

content   string  optional  

Le texte value doit contenir au moins 1 caractères. Le texte de value ne peut contenir plus de 10000 caractères. Example: xntefluuqhngztgiv

meta   object  optional  
classifications   object  optional  
entries   string[]  optional  

Le tableau value ne peut contenir plus de 50 éléments. Example: jlpuyh

content   string   

Le texte value doit contenir au moins 1 caractères. Le texte de value ne peut contenir plus de 10000 caractères. Example: h

meta   object  optional  
classifications   object  optional  

POST api/buckets

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/buckets" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"nwuyaejs\",
    \"webhooks_enabled\": false,
    \"webhooks_signing_enabled\": true
}"
const url = new URL(
    "http://diabolocom-ai.local/api/buckets"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "nwuyaejs",
    "webhooks_enabled": false,
    "webhooks_signing_enabled": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": "id_of_new_databucket"
}
 

Request      

POST api/buckets

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Must not be greater than 255 characters. Example: nwuyaejs

webhooks_enabled   boolean  optional  

Example: false

webhooks_signing_enabled   boolean  optional  

This field is required when webhooks_enabled is true. Example: true

GET api/buckets/{dataBucket}/entries

Example request:
curl --request GET \
    --get "http://diabolocom-ai.local/api/buckets/dignissimos/entries?page=1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://diabolocom-ai.local/api/buckets/dignissimos/entries"
);

const params = {
    "page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "content": "Sit aut et fuga tempora sunt totam perferendis repellendus iusto perferendis fugiat iusto eligendi quia rem culpa vitae voluptate expedita qui modi amet placeat voluptatem aut assumenda ut cupiditate ut laboriosam fugit quod autem aut.",
            "meta": [],
            "classifications": [],
            "created_at": 1725140019,
            "results": [
                {
                    "id": "225a9257-7f4d-4234-9ca2-135c33d914ea",
                    "textual_result": "Si Madame veut me faire l'honneur d'en user, dit le.",
                    "numeric_result": 1
                }
            ]
        },
        {
            "content": "Sequi alias minus temporibus dolor et et amet reiciendis ipsam harum sint non dolorum omnis aut rem ducimus consectetur et quod rem eaque cupiditate provident numquam consequatur consequatur provident quia fugiat praesentium.",
            "meta": [],
            "classifications": [],
            "created_at": 1118778332,
            "results": [
                {
                    "id": "b4d5ed30-d86f-41c9-96a9-f57d1c43acad",
                    "textual_result": "Charles Bovary, se fit un devoir de prodiguer au médecin.",
                    "numeric_result": 5
                }
            ]
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "/",
        "per_page": 15,
        "to": 2,
        "total": 2
    }
}
 

Request      

GET api/buckets/{dataBucket}/entries

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

dataBucket   string   

Example: dignissimos

Query Parameters

page   string  optional  

Example: 1

Inference Endpoints

List of endpoints for inference

POST api/job/tasks

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/job/tasks" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "original_call_id=hic"\
    --form "task=ai-insight"\
    --form "job_id=sed"\
    --form "results_webhook_callback_url=http://kovacek.biz/nostrum-cum-vel-magnam-numquam-maiores-cupiditate-eos"\
    --form "keep_audio_after_analysis=1"\
    --form "configuration[vocabulary]=owpwcxo"\
    --form "configuration[company_name]=nllyyrbwrgdclkgvqgom"\
    --form "configuration[asr][prompt]=atjucfjfrfisxzrqvtwqnyqk"\
    --form "configuration[asr][lang]=et"\
    --form "configuration[asr][segments_to_crop][]=repellat"\
    --form "configuration[insights][output_lang]=consequatur"\
    --form "base_64_file=explicabo"\
    --form "diabolocom_call_id=aut"\
    --form "voicemail=1"\
    --form "generate_tags_with_summary="\
    --form "insight_task=actions-extraction"\
    --form "insight_tasks[]=products-extraction"\
    --form "insights_preset_chain=qm-criteria-evaluation"\
    --form "meta[]=adipisci"\
    --form "file=@/tmp/phpB3douB" 
const url = new URL(
    "http://diabolocom-ai.local/api/job/tasks"
);

const headers = {
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('original_call_id', 'hic');
body.append('task', 'ai-insight');
body.append('job_id', 'sed');
body.append('results_webhook_callback_url', 'http://kovacek.biz/nostrum-cum-vel-magnam-numquam-maiores-cupiditate-eos');
body.append('keep_audio_after_analysis', '1');
body.append('configuration[vocabulary]', 'owpwcxo');
body.append('configuration[company_name]', 'nllyyrbwrgdclkgvqgom');
body.append('configuration[asr][prompt]', 'atjucfjfrfisxzrqvtwqnyqk');
body.append('configuration[asr][lang]', 'et');
body.append('configuration[asr][segments_to_crop][]', 'repellat');
body.append('configuration[insights][output_lang]', 'consequatur');
body.append('base_64_file', 'explicabo');
body.append('diabolocom_call_id', 'aut');
body.append('voicemail', '1');
body.append('generate_tags_with_summary', '');
body.append('insight_task', 'actions-extraction');
body.append('insight_tasks[]', 'products-extraction');
body.append('insights_preset_chain', 'qm-criteria-evaluation');
body.append('meta[]', 'adipisci');
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "job_id": "some-job-id",
    "job_status_endpoint_url": "http://urltogetstatusendpoint.com",
    "audio_id": "id-of-phone-call"
}
 

Example response (403):


{
    "message": "You are not allowed to use this endpoint, please contact our sales team to get access"
}
 

Request      

POST api/job/tasks

Headers

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

original_call_id   string  optional  

Example: hic

task   string   

Example: ai-insight

Must be one of:
  • transcription
  • ai-insight
  • transcription-to-ai-insight
job_id   string  optional  

Example: sed

results_webhook_callback_url   string  optional  

Must be a valid URL. Example: http://kovacek.biz/nostrum-cum-vel-magnam-numquam-maiores-cupiditate-eos

keep_audio_after_analysis   boolean  optional  

Example: true

configuration   object  optional  

This field is required when job_id is not present.

vocabulary   string  optional  

This field is required when job_id is not present. Le texte de value ne peut contenir plus de 300 caractères. Example: owpwcxo

company_name   string  optional  

This field is required when job_id is not present. Le texte de value ne peut contenir plus de 50 caractères. Example: nllyyrbwrgdclkgvqgom

asr   object  optional  
prompt   string  optional  

Le texte de value ne peut contenir plus de 400 caractères. Example: atjucfjfrfisxzrqvtwqnyqk

lang   string  optional  

Example: et

segments_to_crop   integer[]  optional  
start   integer  optional  

Example: 5

end   integer  optional  

Example: 12

insights   object  optional  
tasks_parameters   object  optional  
output_lang   string  optional  

Example: consequatur

file   file  optional  

This field is required when none of job_id, base_64_file, and diabolocom_call_id are present. Must be a file. La taille du fichier de value ne peut pas dépasser 61440 kilo-octets. Example: /tmp/phpB3douB

base_64_file   string  optional  

This field is required when none of job_id, file, and diabolocom_call_id are present. Example: explicabo

diabolocom_call_id   string  optional  

This field is required when none of job_id, base_64_file, and file are present. Example: aut

voicemail   boolean  optional  

Example: true

generate_tags_with_summary   boolean  optional  

Example: false

insight_task   string  optional  

This field is required when none of insight_tasks and insights_preset_chain are present. Example: actions-extraction

Must be one of:
  • call-reason-extraction
  • actions-extraction
  • sequencing
  • summarization
  • nps-estimation
  • quality-monitoring-criteria-evaluation
  • quality-monitoring-criterion-generation
  • contact-reason-classification
  • email-multiclass-tagging
  • knowledge-based-question-answering
  • language-detection
  • rating-estimation
  • email-addresses-extraction
  • products-extraction
  • monetary-values-extraction
  • locations-extraction
  • names-extraction
  • touchpoints-extraction
  • phone-numbers-extraction
  • satisfaction-factors
insight_tasks   string[]  optional  
Must be one of:
  • call-reason-extraction
  • actions-extraction
  • sequencing
  • summarization
  • nps-estimation
  • quality-monitoring-criteria-evaluation
  • quality-monitoring-criterion-generation
  • contact-reason-classification
  • email-multiclass-tagging
  • knowledge-based-question-answering
  • language-detection
  • rating-estimation
  • email-addresses-extraction
  • products-extraction
  • monetary-values-extraction
  • locations-extraction
  • names-extraction
  • touchpoints-extraction
  • phone-numbers-extraction
  • satisfaction-factors
insights_preset_chain   string  optional  

This field is required when none of insight_task and insight_tasks are present. Example: qm-criteria-evaluation

Must be one of:
  • all-on-shelf
  • essentials
  • simple
  • carrefour-complete-collection
  • qm-criteria-evaluation
meta   string[]  optional  

POST api/job/text-tasks

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/job/text-tasks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"configuration\": {
        \"input_parameters\": []
    },
    \"meta\": [
        \"saepe\"
    ],
    \"output_lang\": \"quos\",
    \"task\": \"quality-monitoring-criterion-generation\",
    \"tasks\": [
        \"email-addresses-extraction\"
    ]
}"
const url = new URL(
    "http://diabolocom-ai.local/api/job/text-tasks"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "configuration": {
        "input_parameters": []
    },
    "meta": [
        "saepe"
    ],
    "output_lang": "quos",
    "task": "quality-monitoring-criterion-generation",
    "tasks": [
        "email-addresses-extraction"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/job/text-tasks

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

configuration   object   
input_parameters   object   
meta   string[]  optional  
output_lang   string  optional  

Example: quos

task   string  optional  

This field is required when tasks is not present. Example: quality-monitoring-criterion-generation

Must be one of:
  • quality-monitoring-criterion-generation
  • email-multiclass-tagging
  • contact-reason-classification
  • knowledge-based-question-answering
  • language-detection
  • rating-estimation
  • email-addresses-extraction
  • products-extraction
  • monetary-values-extraction
  • locations-extraction
  • names-extraction
  • touchpoints-extraction
  • phone-numbers-extraction
  • satisfaction-factors
tasks   string[]  optional  
Must be one of:
  • quality-monitoring-criterion-generation
  • email-multiclass-tagging
  • contact-reason-classification
  • knowledge-based-question-answering
  • language-detection
  • rating-estimation
  • email-addresses-extraction
  • products-extraction
  • monetary-values-extraction
  • locations-extraction
  • names-extraction
  • touchpoints-extraction
  • phone-numbers-extraction
  • satisfaction-factors

GET api/job/status/{job_id}

Example request:
curl --request GET \
    --get "http://diabolocom-ai.local/api/job/status/78a61c25-ea99-486c-bda9-35bbbd0d09c6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://diabolocom-ai.local/api/job/status/78a61c25-ea99-486c-bda9-35bbbd0d09c6"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "78a61c25-ea99-486c-bda9-35bbbd0d09c6",
        "original_call_id": "0b45ccdf-e936-338f-8595-7d4cb6e18ff3",
        "audio_id": "0a70debe-9c33-4e00-85e0-90848ace3a76",
        "status": "success",
        "results": {
            "audio": {
                "duration": 674
            },
            "ai-insights": {
                "llm-title": [
                    {
                        "id": "afe31d73-6103-4229-a1ab-447feaaae876",
                        "text": "Facere iusto est quaerat rerum dolores est et. Officiis explicabo laboriosam minima repellendus voluptatibus distinctio accusamus nulla. Saepe minima expedita omnis.",
                        "object": [],
                        "type": "llm-title"
                    }
                ]
            }
        }
    }
}
 

Request      

GET api/job/status/{job_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

job_id   string   

The ID of the job. Example: 78a61c25-ea99-486c-bda9-35bbbd0d09c6

Models Endpoints

List of endpoints for specific models and models infos

POST api/models/advanced_entity_recognition

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/advanced_entity_recognition" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lang\": \"id\",
    \"text\": \"nihil\",
    \"data_bucket_id\": \"et\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/advanced_entity_recognition"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lang": "id",
    "text": "nihil",
    "data_bucket_id": "et"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/advanced_entity_recognition

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

lang   string  optional  

Example: id

text   string   

Example: nihil

entities   object  optional  
data_bucket_id   string  optional  

Example: et

POST api/models/contact_reason

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/contact_reason" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"ayrmuaywzfjlnjmlvcqx\",
    \"tags\": [
        \"at\"
    ],
    \"data_bucket_id\": \"dolor\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/contact_reason"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "ayrmuaywzfjlnjmlvcqx",
    "tags": [
        "at"
    ],
    "data_bucket_id": "dolor"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/contact_reason

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

text   string   

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 4000 caractères. Example: ayrmuaywzfjlnjmlvcqx

tags   string[]   
data_bucket_id   string  optional  

Example: dolor

POST api/models/custom_models_runner/{training_id}

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/custom_models_runner/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"rerum\",
    \"data_bucket_id\": \"illo\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/custom_models_runner/architecto"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "rerum",
    "data_bucket_id": "illo"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/custom_models_runner/{training_id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

training_id   string   

The ID of the training. Example: architecto

Body Parameters

text   string   

Example: rerum

data_bucket_id   string  optional  

Example: illo

POST api/models/diabolocom_ai_insight

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/diabolocom_ai_insight" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"qui\",
    \"data_bucket_id\": \"ex\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/diabolocom_ai_insight"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "qui",
    "data_bucket_id": "ex"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/diabolocom_ai_insight

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

text   string   

Example: qui

data_bucket_id   string  optional  

Example: ex

POST api/models/entity_recognition

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/entity_recognition" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lang\": \"quisquam\",
    \"text\": \"dolor\",
    \"data_bucket_id\": \"dolores\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/entity_recognition"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lang": "quisquam",
    "text": "dolor",
    "data_bucket_id": "dolores"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/entity_recognition

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

lang   string   

Example: quisquam

text   string   

Example: dolor

entities   object  optional  
data_bucket_id   string  optional  

Example: dolores

POST api/models/extract_advanced_persons

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/extract_advanced_persons" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lang\": \"rerum\",
    \"text\": \"ipsum\",
    \"data_bucket_id\": \"magnam\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/extract_advanced_persons"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lang": "rerum",
    "text": "ipsum",
    "data_bucket_id": "magnam"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/extract_advanced_persons

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

lang   string  optional  

Example: rerum

text   string   

Example: ipsum

data_bucket_id   string  optional  

Example: magnam

POST api/models/extract_currencies

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/extract_currencies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lang\": \"exercitationem\",
    \"text\": \"sapiente\",
    \"data_bucket_id\": \"repudiandae\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/extract_currencies"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lang": "exercitationem",
    "text": "sapiente",
    "data_bucket_id": "repudiandae"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/extract_currencies

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

lang   string  optional  

Example: exercitationem

text   string   

Example: sapiente

data_bucket_id   string  optional  

Example: repudiandae

POST api/models/extract_emails

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/extract_emails" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lang\": \"ab\",
    \"text\": \"unde\",
    \"data_bucket_id\": \"ad\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/extract_emails"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lang": "ab",
    "text": "unde",
    "data_bucket_id": "ad"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/extract_emails

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

lang   string  optional  

Example: ab

text   string   

Example: unde

data_bucket_id   string  optional  

Example: ad

POST api/models/extract_languages

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/extract_languages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"vftackazrxmvobrtpcyuspwag\",
    \"data_bucket_id\": \"rem\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/extract_languages"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "vftackazrxmvobrtpcyuspwag",
    "data_bucket_id": "rem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/extract_languages

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

text   string   

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 4000 caractères. Example: vftackazrxmvobrtpcyuspwag

data_bucket_id   string  optional  

Example: rem

POST api/models/extract_locations

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/extract_locations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lang\": \"corrupti\",
    \"text\": \"voluptatibus\",
    \"data_bucket_id\": \"eum\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/extract_locations"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lang": "corrupti",
    "text": "voluptatibus",
    "data_bucket_id": "eum"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/extract_locations

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

lang   string  optional  

Example: corrupti

text   string   

Example: voluptatibus

data_bucket_id   string  optional  

Example: eum

POST api/models/extract_persons

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/extract_persons" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lang\": \"laborum\",
    \"text\": \"et\",
    \"data_bucket_id\": \"veniam\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/extract_persons"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lang": "laborum",
    "text": "et",
    "data_bucket_id": "veniam"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/extract_persons

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

lang   string  optional  

Example: laborum

text   string   

Example: et

data_bucket_id   string  optional  

Example: veniam

POST api/models/extract_phones

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/extract_phones" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lang\": \"ullam\",
    \"text\": \"aspernatur\",
    \"data_bucket_id\": \"aut\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/extract_phones"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lang": "ullam",
    "text": "aspernatur",
    "data_bucket_id": "aut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/extract_phones

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

lang   string  optional  

Example: ullam

text   string   

Example: aspernatur

data_bucket_id   string  optional  

Example: aut

POST api/models/fine_entity_recognition

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/fine_entity_recognition" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lang\": \"modi\",
    \"text\": \"cupiditate\",
    \"data_bucket_id\": \"dignissimos\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/fine_entity_recognition"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "lang": "modi",
    "text": "cupiditate",
    "data_bucket_id": "dignissimos"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/fine_entity_recognition

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

lang   string   

Example: modi

text   string   

Example: cupiditate

entities   object  optional  
data_bucket_id   string  optional  

Example: dignissimos

POST api/models/products

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"mcyqd\",
    \"data_bucket_id\": \"dolorem\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/products"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "mcyqd",
    "data_bucket_id": "dolorem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/products

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

text   string   

Le texte value doit contenir au moins 5 caractères. Le texte de value ne peut contenir plus de 4000 caractères. Example: mcyqd

data_bucket_id   string  optional  

Example: dolorem

POST api/models/satisfaction

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/satisfaction" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"doloremque\",
    \"data_bucket_id\": \"quam\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/satisfaction"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "doloremque",
    "data_bucket_id": "quam"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/satisfaction

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

text   string   

Example: doloremque

data_bucket_id   string  optional  

Example: quam

POST api/models/stars_estimation

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/stars_estimation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"lnaw\",
    \"data_bucket_id\": \"in\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/stars_estimation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "lnaw",
    "data_bucket_id": "in"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/stars_estimation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

text   string   

Le texte value doit contenir au moins 5 caractères. Le texte de value ne peut contenir plus de 4000 caractères. Example: lnaw

data_bucket_id   string  optional  

Example: in

POST api/models/touchpoints

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/touchpoints" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"qqqawszzbfpds\",
    \"data_bucket_id\": \"minima\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/touchpoints"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "qqqawszzbfpds",
    "data_bucket_id": "minima"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/touchpoints

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

text   string   

Le texte de value ne peut contenir plus de 4000 caractères. Example: qqqawszzbfpds

data_bucket_id   string  optional  

Example: minima

POST api/models/translation

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/translation" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"zbptgkdrsrurqwi\",
    \"input_locale\": \"en_CA\",
    \"output_locale\": \"sr_CS\",
    \"data_bucket_id\": \"suscipit\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/translation"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "zbptgkdrsrurqwi",
    "input_locale": "en_CA",
    "output_locale": "sr_CS",
    "data_bucket_id": "suscipit"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/translation

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

text   string   

Le texte de value ne peut contenir plus de 4000 caractères. Example: zbptgkdrsrurqwi

input_locale   string  optional  

Example: en_CA

output_locale   string   

Example: sr_CS

data_bucket_id   string  optional  

Example: suscipit

POST api/models/multiple

Example request:
curl --request POST \
    "http://diabolocom-ai.local/api/models/multiple" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"voluptate\",
    \"models\": [
        \"ipsa\"
    ],
    \"data_bucket_id\": \"ea\"
}"
const url = new URL(
    "http://diabolocom-ai.local/api/models/multiple"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "voluptate",
    "models": [
        "ipsa"
    ],
    "data_bucket_id": "ea"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/models/multiple

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

text   string   

Example: voluptate

models   object[]   
*   object  optional  
parameters   object  optional  
parameters   object  optional  
data_bucket_id   string  optional  

Example: ea

GET api/models/{internalModel_slug}

Example request:
curl --request GET \
    --get "http://diabolocom-ai.local/api/models/actions-extraction" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://diabolocom-ai.local/api/models/actions-extraction"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "data": {
        "slug": "actions-extraction",
        "key": "actions-extraction",
        "title": "Extraction of call actions",
        "description": "Transcribe and analyze your customers calls (multilingual transcription and analysis) to identify the actions that either took place during the call or are recommended to be completed after the call, with no data required and no additional training",
        "requires_parameters": false,
        "requires_context": true,
        "requires_locales": false,
        "requires_multiple_rows": false,
        "multiple_rows_columns": null,
        "requires_tags": null,
        "requires_presets": null,
        "available_locales": null,
        "parameters": null,
        "content": "## Description\n\nTranscribe and analyze your customers calls (multilingual transcription and analysis) to identify the actions that either took place during the call or are recommended to be completed after the call, with no data required and no additional training.\nThis model developed by <span>Diabolocom.ai</span> is trained to identify and extract the actions listed during your customer calls, including reason clarification and responsability assignment as well as completion state guidance, based on a call (audio) transcription, without further information.<br/>\nIt assists in tracking responsibilities and follow-up tasks.\n\nThis analysis includes the following features :\n- Action Items Extraction : Identifiying and listing specific actions that were discussed during the call\n- Reason Clarification : Providing clarity on the 'why' - the reasons behind each action item\n- Responsibility Assignment : Specifiying which party (agent or client) is responsible for each action item, aiding in accountability\n- Completion state Guidance : Providing guidance for each action to determine if it's completed during the call or should be performed after the call\n\nWhen you run the model, you will have these generated results :\n- The timestampted call transcript : The transcribed call (audio) including separate timestampted conversation lines for each speaker (Client/Agent)\n- The list of identified actions, having each the following details :\n\t- The action title : The action name in the format of a short description with key elements\n\t- The action reason : The underlying reason or purpose behind the action\n\t- The action responsible : The party responsible of the action (agent or client)\n\t- The action completion state : The action status depending on whether it is identified as completed during the call or should be performed after the call\n\t- The action steps : The list of sub-tasks/steps that define the action\n\n![Example](__APP_URL__storage/img/actions-extraction_en.svg \"Example\")\n\n## How to use\n- Upload a stereo phone call : Dual-channel audio (mp3, wav) < 60mb. For a better transcription and analysis quality, make sure that the channel dedicated for the Agent is the stereo right channel, and the channel dedicated for the Client is the stereo left channel\n- Choose your input audio language\n- Choose your AI analysis results language : Specify the analysis output language you want (can be different from your input audio language to enable cross-lingual analysis of the call)\n- Provide your company name : Introduce our model to the name of your company\n- Write a brief context of the call : Introduce our model to the context of the input audio\n\nExplore our model API to take advantage of additional features : \n- Transcription and analysis of defined segments of the call (ability to crop the audio)\n- Reception of a webhook message on successful AI analysis\n\n## Possible uses\n- In-depth analysis of specific calls : VIP customer calls, specific queue calls, calls with empty or no explicit post-call qualification/commentary or follow-up action list, ...\n- Agent performance assessment during the call and Quality Monitoring\n- Pre-filling of post-call follow-up fields to improve agents efficiency and reduce post-call time : call qualification, call summary/commentary, task/action list, ...\n- Integration of AI analysis generated results (actions list with parameters title, reason, responsible, completion state, steps) with CCaaS or CRM/ticketing tool : create a task/action list to perform, update the customer record, interaction or case record, ...\n- Execution of various automated processes depending on the call actions completed or to perform\n- Any other use : we provide the information, you do what you want with it !",
        "available_languages": [],
        "require_file_field": true,
        "without_text_area": true,
        "limitations": "This Diabolocom.ai analysis allows you to identify and extract the actions listed during your customer calls, including reason clarification and responsability assignment as well as completion state guidance, based on a call (audio) transcription, without any prior data. If the call content (audio) is not explicit enough because of speakers overlap or another possible reason, the resulting transcript may not exactly match the call content and the generated results may not be correct.",
        "icon": "SPEAKER",
        "secondary_icon": null,
        "color": "9F70FD",
        "documentation_url": "https://developer.diabolocom.com/#12762abb-6874-4a35-9cc1-c7d3fe211a28",
        "documentation_url_2": null,
        "category": "voice",
        "text_input_key": null
    }
}
 

Request      

GET api/models/{internalModel_slug}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

internalModel_slug   string   

The slug of the internalModel. Example: actions-extraction