POST - Class Track Analysis

This API enables authenticated users to submit class-level audio recordings for comprehensive AI-powered analysis and evaluation using CrazyGoldFish AI technology. The endpoint performs thorough validation of audio links, securely stores educational metadata, and initiates a processing workflow for transcript generation and rubric-based AI evaluation. For metadata ID references, please consult the Metadata API Documentation.

Key Capabilities:

Secure Audio Validation: Accepts only publicly accessible HTTPS URLs pointing to .mp3 audio files
Comprehensive Metadata Management: Captures and stores institutional, teacher, board, grade, subject, and rubric information
Flexible Rubric Integration: Supports both UUID and integer-based rubric identifier formats

Typical Use Case: Submitting a Classroom Recording for AI Analysis

An educator uploads a classroom recording to a public cloud storage service and obtains a secure HTTPS URL
The teacher submits the audio URL along with comprehensive class metadata including board, grade, subject, and rubric details
The system performs rigorous validation of both URL format and metadata completeness before initiating processing
Upon successful validation, the system returns a unique analysis identifier for tracking the evaluation progress

Only publicly accessible HTTPS URLs ending with .mp3 file extensions are accepted. Private URLs, non-HTTPS links, or unsupported file formats will result in validation errors and request rejection.

POST

class-track

analysis

Create Class Track Analysis

curl --request POST \
  --url https://api-staging.crazygoldfish.com/class-track/v1/analysis \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "institution_id": "inst_12345",
  "teacher_id": "teacher_67890",
  "board_id": "550e8400-e29b-41d4-a716-446655440000",
  "grade_id": "550e8400-e29b-41d4-a716-446655440001",
  "subject_id": "550e8400-e29b-41d4-a716-446655440002",
  "rubric_id": "550e8400-e29b-41d4-a716-446655440003",
  "date": "2024-01-15",
  "link": "https://example.com/class-recording.mp3"
}
'

{
  "detail": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440004",
      "message": "Class track analysis process started!"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

teacher_id

string

required

Teacher ID (required)

Example:

"teacher_67890"

board_id

string<uuid>

required

Board UUID (required)

Example:

"550e8400-e29b-41d4-a716-446655440000"

grade_id

string<uuid>

required

Grade UUID (required)

Example:

"550e8400-e29b-41d4-a716-446655440001"

subject_id

string<uuid>

required

Subject UUID (required)

Example:

"550e8400-e29b-41d4-a716-446655440002"

rubric_id

string<uuid>

required

Rubric UUID or integer ID (required)

Example:

"550e8400-e29b-41d4-a716-446655440003"

date

string<date>

required

Analysis date (required, cannot be future date)

Example:

"2024-01-15"

link

string<uri>

required

Public HTTPS URL to .mp3 file (required)

Pattern: ^https://.*\.mp3$

Example:

"https://example.com/class-recording.mp3"

institution_id

string

Institution ID (optional)

Example:

"inst_12345"

Response

Class track analysis process initiated successfully.

detail

object[]

required

Show child attributes

GET - Class Track Analysis This API enables authenticated users to **retrieve comprehensive analysis results** for previously submitted class-level audio recordings. The endpoint provides detailed AI-powered evaluation results, including teaching scores, rubric assessments, classroom insights, action plans, and extracted transcripts. **Key Capabilities:** - **Status Monitoring**: Returns current processing status for ongoing analyses - **Comprehensive Results**: Provides detailed teaching evaluation with star ratings and insights - **Rubric Assessment**: Delivers category-wise scoring with observations and recommendations - **Classroom Insights**: Offers actionable feedback across multiple teaching dimensions - **Action Plans**: Supplies immediate, short-term, and long-term improvement strategies - **Transcript Access**: Includes the complete extracted transcript from the audio recording **Typical Use Case: Retrieving Analysis Results** - An educator submits a classroom recording and receives an analysis ID - The teacher uses the analysis ID to check the processing status - Once completed, the system returns comprehensive evaluation results - The educator reviews detailed feedback, scores, and improvement recommendations <Tip> Want to receive automatic notifications when class track evaluation is processed? Set up webhooks to get real-time updates on question extraction. Check out the [Webhooks](/api-reference/endpoint/webhook/v1-get-webhook-template). </Tip>

Create Class Track Analysis

curl --request POST \
  --url https://api-staging.crazygoldfish.com/class-track/v1/analysis \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "institution_id": "inst_12345",
  "teacher_id": "teacher_67890",
  "board_id": "550e8400-e29b-41d4-a716-446655440000",
  "grade_id": "550e8400-e29b-41d4-a716-446655440001",
  "subject_id": "550e8400-e29b-41d4-a716-446655440002",
  "rubric_id": "550e8400-e29b-41d4-a716-446655440003",
  "date": "2024-01-15",
  "link": "https://example.com/class-recording.mp3"
}
'

{
  "detail": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440004",
      "message": "Class track analysis process started!"
    }
  ]
}

Documentation Index

Authorizations

Body

Response