Skip to content

AI recommendation for coding type

POST
/v2/codebook/recommend-type
curl --request POST \
--url https://api.surveycoder.io/v2/codebook/recommend-type \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '{ "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "question_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'
Media type application/json
object
project_id
required
string format: uuid
question_id
required
string format: uuid
Example generated
{
"project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"question_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Coding type recommendation

Media type application/json
object
success
boolean
data
object
recommended_type
string
confidence
string
Allowed values: high medium low
reasoning
string
alternative_type
string
Example
{
"success": true,
"data": {
"confidence": "high"
}
}