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
A unique ID for the quickstart
The name of the quickstart
PENDING, IN_PROGRESS, BASELINE_REVIEW, AWAITING_STYLE_REVIEW, REVIEWING_STYLE, AWAITING_STYLE_CONFIRMATION, AWAITING_VOTING, COMPLETED, FAILED Show child attributes
A list of the topics covered in the quickstart
Show child attributes
The topic of the evaluation case, indicating the general category for the user's request
The baseline score from 1-5
1 <= x <= 5Show child attributes
The title of the task describing what the user wants in the format 'Block Credit Card' if the user wants to block their credit card
The description of the task in the format 'The user wants to block their credit card' if the user wants to block their credit card
A list of the conversations for this task and topic combination
Show child attributes
A unique ID for the conversation
The user's question to the agent
The agent's response to the user
Naturalness score calculated as an average of the 5 metrics
A brief explanation for your rating, referring to specific aspects of the response and the query. Make sure that the explanation is formatted as markdown, and that it is easy to read and understand.
Style score
A brief explanation for your rating, referring to specific aspects of the response and the query. Make sure that the explanation is formatted as markdown, and that it is easy to read and understand.
The baseline score from 1-5
1 <= x <= 5Show child attributes
The initial baseline score from 1-5
The number of conversations in the quickstart
The number of tasks in the quickstart
The number of topics in the quickstart
Show child attributes