Getting Started
Using Roundtable Alias
- Overview
- Checks and Flags
Developer Resources
- POSTAPI Specification
- Integrations
Developer Resources
API Specification
POST
/
v017
Copy
curl --request POST \
--url https://api.roundtable.ai/alias/v017 \
--header 'Content-Type: application/json' \
--header 'api_key: <api_key>' \
--data '{
"participant_id": "participant_123",
"question_histories": {
"Q1": [
{
"s": "I",
"t": 0
},
{
"s": "Im",
"t": 429
}
]
},
"questions": {
"Q1": "How do you feel our software has impacted your daily workflow?"
},
"responses": {
"Q1": "I really like pineapple on pizza."
},
"survey_id": "survey_456",
"low_effort_threshold": 0
}'
Copy
{
"error": false,
"flagged": true,
"num_checks_failed": 1,
"response_groups": {
"Q1": 1
},
"checks": {
"Q1": [
"Automated test: Off-topic"
]
},
"effort_ratings": {
"Q1": 4
},
"typing_url": "<string>",
"model": "alias-v017"
}
Headers
API key for authentication. Include this in the header of your request.
Body
application/json
Response
200 - application/json
Analysis result
The response is of type object
.
Copy
curl --request POST \
--url https://api.roundtable.ai/alias/v017 \
--header 'Content-Type: application/json' \
--header 'api_key: <api_key>' \
--data '{
"participant_id": "participant_123",
"question_histories": {
"Q1": [
{
"s": "I",
"t": 0
},
{
"s": "Im",
"t": 429
}
]
},
"questions": {
"Q1": "How do you feel our software has impacted your daily workflow?"
},
"responses": {
"Q1": "I really like pineapple on pizza."
},
"survey_id": "survey_456",
"low_effort_threshold": 0
}'
Copy
{
"error": false,
"flagged": true,
"num_checks_failed": 1,
"response_groups": {
"Q1": 1
},
"checks": {
"Q1": [
"Automated test: Off-topic"
]
},
"effort_ratings": {
"Q1": 4
},
"typing_url": "<string>",
"model": "alias-v017"
}
Assistant
Responses are generated using AI and may contain mistakes.