curl --request GET \
--url https://api.avidoai.com/v0/quickstarts/{id} \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <api-key>'{
"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
}
]
}
}
}Retrieves a single quickstart by its unique identifier
curl --request GET \
--url https://api.avidoai.com/v0/quickstarts/{id} \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <api-key>'{
"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
The unique identifier of the quickstart
"123e4567-e89b-12d3-a456-426614174000"
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