curl --request POST \
--url https://api.avidoai.com/v0/quickstarts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <api-key>' \
--data '
{
"name": "<string>",
"initiatedBy": "<string>",
"status": "PENDING",
"conversations": {
"topics": [],
"metadata": {
"initialBaseline": 0,
"conversations": 0,
"tasks": 0,
"topics": 0
}
}
}
'{
"data": {
"id": "<string>",
"name": "<string>",
"status": "PENDING",
"createdAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z",
"conversations": {
"topics": [],
"metadata": {
"initialBaseline": 0,
"conversations": 0,
"tasks": 0,
"topics": 0
}
},
"styleGuide": {
"name": "<string>",
"relatedQuickstart": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sections": [
{
"heading": "Tone",
"content": "Use professional and clear language",
"approved": true
}
]
}
}
}Creates a new quickstart
curl --request POST \
--url https://api.avidoai.com/v0/quickstarts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <api-key>' \
--data '
{
"name": "<string>",
"initiatedBy": "<string>",
"status": "PENDING",
"conversations": {
"topics": [],
"metadata": {
"initialBaseline": 0,
"conversations": 0,
"tasks": 0,
"topics": 0
}
}
}
'{
"data": {
"id": "<string>",
"name": "<string>",
"status": "PENDING",
"createdAt": "2023-11-07T05:31:56Z",
"modifiedAt": "2023-11-07T05:31:56Z",
"conversations": {
"topics": [],
"metadata": {
"initialBaseline": 0,
"conversations": 0,
"tasks": 0,
"topics": 0
}
},
"styleGuide": {
"name": "<string>",
"relatedQuickstart": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sections": [
{
"heading": "Tone",
"content": "Use professional and clear language",
"approved": true
}
]
}
}
}Your unique Avido API key
Your unique Avido Application ID
Request schema for creating a new quickstart
The name of the quickstart
The user who created the quickstart
PENDING, IN_PROGRESS, BASELINE_REVIEW, AWAITING_STYLE_REVIEW, REVIEWING_STYLE, AWAITING_STYLE_CONFIRMATION, AWAITING_VOTING, COMPLETED, FAILED Show child attributes
Successful response
Response schema for a single quickstart
A quickstart is a set of conversations that can be used to test a style guide
Show child attributes