Skip to main content
POST
/
v0
/
quickstarts
/
upload-csv
Upload quickstart via CSV file
curl --request POST \
  --url https://api.avidoai.com/v0/quickstarts/upload-csv \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --form 'file=<unknown>' \
  --form 'fileName=Initial quickstart' \
  --form materialType=conversations \
  --form replaceUploadId=123e4567-e89b-12d3-a456-426614174000 \
  --form quickstartId=456e7890-e89b-12d3-a456-426614174001
{
  "message": "Resource not found"
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Body

multipart/form-data

Request for uploading quickstart via CSV file

​
file
any
required

CSV file containing quickstart conversations

​
fileName
string
required

Name for this import

Example:

"Initial quickstart"

​
materialType
enum<string>

Type of material being uploaded (conversations, knowledge_base, or policy)

Available options:
conversations,
knowledge_base,
policy
​
replaceUploadId
string<uuid>

ID of the existing upload to replace. When provided, the old upload will be deleted after successful processing of the new file.

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"

​
quickstartId
string<uuid>

ID of the quickstart this upload belongs to (for QuickstartV2). Files will be associated with this 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:

"456e7890-e89b-12d3-a456-426614174001"

Response

CSV file uploaded and queued for processing successfully