Skip to main content
PUT
/
v0
/
quickstarts
/
{id}
Update a quickstart
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
}
'
{
  "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"
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

​
id
string<uuid>
required

The unique identifier of the quickstart

Pattern: ^([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)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json

Request body for updating a quickstart

​
title
string

The title of the quickstart

Required string length: 1 - 255
Example:

"My Quickstart"

​
description
string

The description of the quickstart (empty strings are treated as omitted)

Maximum string length: 2048
Example:

"A quickstart for onboarding"

​
status
enum<string>

The status of the quickstart

Available options:
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
Example:

"MATERIALS_PROCESSING"

​
generateKbFromMaterials
boolean

When true, the quickstart builds a structured knowledge base from the available uploaded conversations, documents, and scraped web pages

Example:

true

​
reuseTasksTopics
boolean

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.

Example:

true

Response

Successfully updated quickstart

Response containing a single quickstart

​
data
object
required