Skip to main content
POST
/
chat
Generate Assessment
curl --request POST \
  --url https://api.example.com/chat
{
  "status": "<string>",
  "job_id": "<string>"
}
Initiates an asynchronous assessment generation job based on provided content and Bloom’s taxonomy requirements.

Request

Query Parameters

query
string
required
The chat query or content description from the user. This serves as the basis for generating assessment questions.
collection_name
string
required
The Qdrant collection name to search for relevant content. This identifies which knowledge base to generate questions from.
blooms_requirements
string
Bloom’s taxonomy requirements string specifying the number and type of questions to generate for each cognitive level.Format: "X remember, Y understand, Z apply, A analyze, B evaluate, C create"

Response

status
string
Job status - will be "queued" when successfully initiated.
job_id
string
Unique identifier for the queued job. Use this to check job status via the Job Status endpoint.

Example Request

curl -X POST "http://localhost:8000/chat?query=Chapter%203%20Photosynthesis&collection_name=biology_textbook&blooms_requirements=5%20remember%2C%203%20understand%2C%204%20apply%2C%203%20analyze%2C%202%20evaluate%2C%203%20create" \
  -H "Content-Type: application/json"

Example Response

{
  "status": "queued",
  "job_id": "abc123-def456-ghi789"
}

Notes

  • This endpoint queues a background job with a 600-second (10-minute) timeout
  • The job processes the query, searches the specified collection, and generates MCQs based on Bloom’s taxonomy requirements
  • Use the returned job_id to poll the Job Status endpoint for completion
  • No authentication is required for this endpoint

Next Steps

After receiving the job_id, poll the Job Status endpoint to check when generation is complete, then Save the assessment to your account.

Build docs developers (and LLMs) love