Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.coraltalk.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Oral assessments

An oral assessment is a voice-based exam where students converse with Coral and receive AI-powered evaluation.

​
Endpoints

MethodPathDescription
POST/oral-assessmentsCreate
GET/oral-assessmentsList (?classId= optional)
GET/oral-assessments/:idGet
PUT/oral-assessments/:idUpdate
DELETE/oral-assessments/:idDelete

​
Create

FieldRequiredDefaultDescription
nameYes—Assessment title
classIdYes—Class ID
durationNo600Max duration (seconds)
examTypeNo"Generic""Generic", "Personalized", or "Hybrid"
questionsNo—Array of { id, text }
curl -X POST "https://app.coraltalk.com/api/v1/prod/oral-assessments" \
  -H "Authorization: Bearer ct_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Midterm Oral Exam",
    "classId": "CLASS_ID",
    "duration": 900,
    "questions": [
      { "id": "1", "text": "Explain cellular respiration." }
    ]
  }'

​
Student URL

https://app.coraltalk.com/exam/{EXAM_ID}
Or on a custom domain: https://exams.yourschool.edu/exam/{EXAM_ID}