curl --request PUT \
--url https://api.avidoai.com/v0/quickstarts/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <api-key>' \
--data '
{
"title": "My Quickstart",
"description": "A quickstart for onboarding",
"status": "MATERIALS_PROCESSING",
"generateKbFromMaterials": true,
"reuseTasksTopics": true
}
'import requests
url = "https://api.avidoai.com/v0/quickstarts/{id}"
payload = {
"title": "My Quickstart",
"description": "A quickstart for onboarding",
"status": "MATERIALS_PROCESSING",
"generateKbFromMaterials": True,
"reuseTasksTopics": True
}
headers = {
"x-api-key": "<api-key>",
"x-application-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-api-key': '<api-key>',
'x-application-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
title: 'My Quickstart',
description: 'A quickstart for onboarding',
status: 'MATERIALS_PROCESSING',
generateKbFromMaterials: true,
reuseTasksTopics: true
})
};
fetch('https://api.avidoai.com/v0/quickstarts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.avidoai.com/v0/quickstarts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'My Quickstart',
'description' => 'A quickstart for onboarding',
'status' => 'MATERIALS_PROCESSING',
'generateKbFromMaterials' => true,
'reuseTasksTopics' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-application-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.avidoai.com/v0/quickstarts/{id}"
payload := strings.NewReader("{\n \"title\": \"My Quickstart\",\n \"description\": \"A quickstart for onboarding\",\n \"status\": \"MATERIALS_PROCESSING\",\n \"generateKbFromMaterials\": true,\n \"reuseTasksTopics\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-application-id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.avidoai.com/v0/quickstarts/{id}")
.header("x-api-key", "<api-key>")
.header("x-application-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"My Quickstart\",\n \"description\": \"A quickstart for onboarding\",\n \"status\": \"MATERIALS_PROCESSING\",\n \"generateKbFromMaterials\": true,\n \"reuseTasksTopics\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avidoai.com/v0/quickstarts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["x-application-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"My Quickstart\",\n \"description\": \"A quickstart for onboarding\",\n \"status\": \"MATERIALS_PROCESSING\",\n \"generateKbFromMaterials\": true,\n \"reuseTasksTopics\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"title": "My Quickstart",
"status": "MATERIALS_UPLOAD",
"generateKbFromMaterials": false,
"reuseTasksTopics": false,
"description": "A quickstart for onboarding"
}
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}{
"message": "Invalid request data",
"issues": [
{
"code": "invalid_string",
"message": "Invalid UUID",
"path": [
"id"
]
}
]
}{
"message": "Resource not found"
}Update a quickstart
Updates an existing quickstart with the provided details.
curl --request PUT \
--url https://api.avidoai.com/v0/quickstarts/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <api-key>' \
--data '
{
"title": "My Quickstart",
"description": "A quickstart for onboarding",
"status": "MATERIALS_PROCESSING",
"generateKbFromMaterials": true,
"reuseTasksTopics": true
}
'import requests
url = "https://api.avidoai.com/v0/quickstarts/{id}"
payload = {
"title": "My Quickstart",
"description": "A quickstart for onboarding",
"status": "MATERIALS_PROCESSING",
"generateKbFromMaterials": True,
"reuseTasksTopics": True
}
headers = {
"x-api-key": "<api-key>",
"x-application-id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-api-key': '<api-key>',
'x-application-id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
title: 'My Quickstart',
description: 'A quickstart for onboarding',
status: 'MATERIALS_PROCESSING',
generateKbFromMaterials: true,
reuseTasksTopics: true
})
};
fetch('https://api.avidoai.com/v0/quickstarts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.avidoai.com/v0/quickstarts/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'title' => 'My Quickstart',
'description' => 'A quickstart for onboarding',
'status' => 'MATERIALS_PROCESSING',
'generateKbFromMaterials' => true,
'reuseTasksTopics' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-application-id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.avidoai.com/v0/quickstarts/{id}"
payload := strings.NewReader("{\n \"title\": \"My Quickstart\",\n \"description\": \"A quickstart for onboarding\",\n \"status\": \"MATERIALS_PROCESSING\",\n \"generateKbFromMaterials\": true,\n \"reuseTasksTopics\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-application-id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.avidoai.com/v0/quickstarts/{id}")
.header("x-api-key", "<api-key>")
.header("x-application-id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"My Quickstart\",\n \"description\": \"A quickstart for onboarding\",\n \"status\": \"MATERIALS_PROCESSING\",\n \"generateKbFromMaterials\": true,\n \"reuseTasksTopics\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.avidoai.com/v0/quickstarts/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["x-application-id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"My Quickstart\",\n \"description\": \"A quickstart for onboarding\",\n \"status\": \"MATERIALS_PROCESSING\",\n \"generateKbFromMaterials\": true,\n \"reuseTasksTopics\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"title": "My Quickstart",
"status": "MATERIALS_UPLOAD",
"generateKbFromMaterials": false,
"reuseTasksTopics": false,
"description": "A quickstart for onboarding"
}
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}{
"message": "Resource not found"
}{
"message": "Invalid request data",
"issues": [
{
"code": "invalid_string",
"message": "Invalid UUID",
"path": [
"id"
]
}
]
}{
"message": "Resource not found"
}Authorizations
Your unique Avido API key
Your unique Avido Application ID
Path Parameters
The unique identifier of the quickstart
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"123e4567-e89b-12d3-a456-426614174000"
Body
Request body for updating a quickstart
The title of the quickstart
1 - 255"My Quickstart"
The description of the quickstart (empty strings are treated as omitted)
2048"A quickstart for onboarding"
The status of the quickstart
MATERIALS_UPLOAD, MATERIALS_PROCESSING, MATERIALS_PROCESSING_FAILED, TASKS_TOPICS_REVIEW, KB_PROCESSING, KB_PROCESSING_FAILED, KB_REVIEW, POLICIES_PROCESSING, POLICIES_PROCESSING_FAILED, POLICIES_REVIEW, COMPLETE "MATERIALS_PROCESSING"
When true, the quickstart builds a structured knowledge base from the available uploaded conversations, documents, and scraped web pages
true
When true, the quickstart reuses the application's existing tasks and topics instead of generating new ones. Can only be set while the quickstart is in MATERIALS_UPLOAD.
true
Response
Successfully updated quickstart
Response containing a single quickstart
Show child attributes
Show child attributes