The Predictions API from Renaissance — 3 operation(s) for predictions.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/renaissance-predictions-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Student Proficiency Service Predictions API
description: '# Student Proficiency Service API
This service provides predictions for student proficiency in various math skills.'
version: 1.0.0
tags:
- name: Predictions
paths:
/v1/skill:
post:
tags:
- Predictions
summary: Predict student proficiency on a single skill
description: 'Generate proficiency predictions for multiple students across multiple skills.
The endpoint accepts a list of student IDs and skill IDs and returns predictions
for each student-skill combination. Predictions include the percentage correct
and the timestamp when the prediction was generated.'
operationId: predict_proficiency_v1_skill_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SingleSkillInferenceRequest'
required: true
responses:
'200':
description: List of predictions for each student-skill combination
content:
application/json:
schema:
$ref: '#/components/schemas/SingleSkillInferenceResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/v1/skill-groups:
post:
tags:
- Predictions
summary: Predict student proficiency for a group of skills
description: 'Generate proficiency predictions for multiple students across multiple skills, aggregate results by skill.
The endpoint accepts a list of student IDs and skill IDs and returns predictions
for each student-skill group.'
operationId: predict_group_proficiency_v1_skill_groups_post
security:
- HTTPBearer: []
parameters:
- name: include_individual_predictions
in: query
required: false
schema:
type: boolean
description: When true, include individual skill predictions for each student in the response
default: false
title: Include Individual Predictions
description: When true, include individual skill predictions for each student in the response
- name: include_student_info
in: query
required: false
schema:
type: boolean
description: When true, include student first and last names in predictions
default: false
title: Include Student Info
description: When true, include student first and last names in predictions
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GroupSkillInferenceRequest'
responses:
'200':
description: List of predictions for each student-skill group
content:
application/json:
schema:
$ref: '#/components/schemas/GroupSkillInferenceResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/skill-groups/by-class:
post:
tags:
- Predictions
summary: Predict student proficiency for a class
description: 'Generate proficiency predictions for all students in a class across multiple skills.
This endpoint queries the class roster to get student IDs, then runs the same
inference logic as /v1/skill-groups.
Use the include_student_info query parameter to include student names in the response.'
operationId: predict_group_proficiency_by_class_v1_skill_groups_by_class_post
security:
- HTTPBearer: []
parameters:
- name: include_individual_predictions
in: query
required: false
schema:
type: boolean
description: When true, include individual skill predictions for each student
default: false
title: Include Individual Predictions
description: When true, include individual skill predictions for each student
- name: include_student_info
in: query
required: false
schema:
type: boolean
description: When true, include student first and last names in predictions
default: false
title: Include Student Info
description: When true, include student first and last names in predictions
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ByClassInferenceRequest'
responses:
'200':
description: List of predictions for each student in the class
content:
application/json:
schema:
$ref: '#/components/schemas/GroupSkillInferenceResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
StudentMetadata:
properties:
first_name:
anyOf:
- type: string
- type: 'null'
title: First Name
description: Student's first name
last_name:
anyOf:
- type: string
- type: 'null'
title: Last Name
description: Student's last name
type: object
title: StudentMetadata
description: Optional student metadata included when include_student_info=true
GroupSkillInferenceResponse:
properties:
request_id:
type: string
title: Request Id
description: Unique identifier for this API request
example: 7h8i9j0k1l2m
predictions:
items:
$ref: '#/components/schemas/GroupSkillInferencePrediction'
type: array
title: Predictions
description: List of predictions for each student-skill group
type: object
required:
- request_id
- predictions
title: GroupSkillInferenceResponse
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
GroupSkillInferencePrediction:
properties:
student_renaissance_rp_identifier:
type: string
title: Student Renaissance Rp Identifier
description: Renaissance Growth Platform student identifier
example: 7424932e-cfae-4353-b2da-3408acb0fa88
requested_skill_ids:
items:
type: string
type: array
title: Requested Skill Ids
description: List of requested skill identifiers
example:
- fba2bfaa479de311b77c005056801da1
- 01a3bfaa479de311b77c005056801da1
- 72a3bfaa479de311b77c005056801da1
practiced_skill_ids:
items:
type: string
type: array
title: Practiced Skill Ids
description: List of practiced skill identifiers with valid predictions
example:
- fba2bfaa479de311b77c005056801da1
- 01a3bfaa479de311b77c005056801da1
unpracticed_skill_ids:
items:
type: string
type: array
title: Unpracticed Skill Ids
description: List of requested skill identifiers that have not enough data for predictions or have not been practiced by the student
example:
- 72a3bfaa479de311b77c005056801da1
invalid_skill_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Invalid Skill Ids
description: List of requested skill identifiers that are invalid for the client
example:
- 72a3bfaa479de311b77c005056801da1
nullable: true
proficiency:
anyOf:
- type: number
maximum: 100.0
minimum: 0.0
- type: 'null'
title: Proficiency
description: Predicted percentage correct (0-100)
example: 85.5
prediction_type:
anyOf:
- type: string
- type: 'null'
title: Prediction Type
description: Products contributing to predicted proficiency score (has_star, has_freckle)
example: has_star,has_freckle
instructional_group:
anyOf:
- $ref: '#/components/schemas/InstructionalGroup'
- type: 'null'
description: Instructional group
example: enrichment
error:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Error
description: Error information if prediction failed
example:
code: insufficient_data
details:
invalidSkills:
- skill 5
practicedSkills:
- skill 4
reason: skills_not_practiced
recommendation: Student needs to practice "skill 1", "skill 2" and/or "skill 3" before predictions for these skills can be generated
requestedSkills:
- skill 1
- skill 2
- skill 3
- skill 4
unpracticedSkills:
- skill 1
- skill 2
- skill 3
message: 'Error generating predictions: Student has not practiced the skills specified'
individual_predictions:
anyOf:
- additionalProperties:
$ref: '#/components/schemas/SingleSkillInferencePrediction'
type: object
- type: 'null'
title: Individual Predictions
description: Individual skill predictions for this student, keyed by skill ID. Only included when include_individual_predictions=true in the request.
student_metadata:
anyOf:
- $ref: '#/components/schemas/StudentMetadata'
- type: 'null'
description: Student metadata (only included when include_student_info=true)
type: object
required:
- student_renaissance_rp_identifier
- requested_skill_ids
- practiced_skill_ids
- unpracticed_skill_ids
- invalid_skill_ids
title: GroupSkillInferencePrediction
InstructionalGroup:
type: string
enum:
- APPROACHING
- INSTRUCTIONAL
- ENRICHMENT
title: InstructionalGroup
SingleSkillInferenceRequest:
properties:
student_rgp_ids:
items:
type: string
type: array
minItems: 1
title: Student Rgp Ids
description: List of Renaissance Growth Platform student identifiers
example:
- 7424932e-cfae-4353-b2da-3408acb0fa88
- 0b6fa02a-bfa5-4008-a016-12528451881c
rl_skill_ids:
items:
type: string
type: array
minItems: 1
title: Rl Skill Ids
description: List of Renaissance Learning skill identifiers
example:
- fba2bfaa479de311b77c005056801da1
- 01a3bfaa479de311b77c005056801da1
- 72a3bfaa479de311b77c005056801da1
type: object
required:
- student_rgp_ids
- rl_skill_ids
title: SingleSkillInferenceRequest
example:
rl_skill_ids:
- 4b3676fc-f7a5-47ae-84c5-2bca8e09ed5d
- 60bbc51a-a39f-e311-9503-005056801da1
- 5db878ca-c8f1-4ac4-b216-0f41c7ab9666
- 21a5bfaa-479d-e311-b77c-005056801da1
student_rgp_ids:
- 93da681e-b689-4e05-8bd3-ac708bd3a464
- 93da684c-fa6f-4929-bcf1-df2b8714024a
ByClassInferenceRequest:
properties:
class_id:
type: string
title: Class Id
description: Class identifier (class_renaissance_rp_identifier)
example: 7424932e-cfae-4353-b2da-3408acb0fa88
rl_skill_ids:
items:
type: string
type: array
minItems: 1
title: Rl Skill Ids
description: List of requested skill identifiers
example:
- fba2bfaa479de311b77c005056801da1
- 01a3bfaa479de311b77c005056801da1
type: object
required:
- class_id
- rl_skill_ids
title: ByClassInferenceRequest
example:
class_id: 7424932e-cfae-4353-b2da-3408acb0fa88
rl_skill_ids:
- 4b3676fc-f7a5-47ae-84c5-2bca8e09ed5d
- 60bbc51a-a39f-e311-9503-005056801da1
GroupSkillInferenceRequest:
properties:
student_rgp_ids:
items:
type: string
type: array
minItems: 1
title: Student Rgp Ids
description: List of Renaissance Growth Platform student identifiers
example:
- 7424932e-cfae-4353-b2da-3408acb0fa88
- 0b6fa02a-bfa5-4008-a016-12528451881c
rl_skill_ids:
items:
type: string
type: array
minItems: 1
title: Rl Skill Ids
description: List of Renaissance Learning skill identifiers
example:
- fba2bfaa479de311b77c005056801da1
- 01a3bfaa479de311b77c005056801da1
- 72a3bfaa479de311b77c005056801da1
type: object
required:
- student_rgp_ids
- rl_skill_ids
title: GroupSkillInferenceRequest
example:
rl_skill_ids:
- 4b3676fc-f7a5-47ae-84c5-2bca8e09ed5d
- 60bbc51a-a39f-e311-9503-005056801da1
- 5db878ca-c8f1-4ac4-b216-0f41c7ab9666
- 21a5bfaa-479d-e311-b77c-005056801da1
student_rgp_ids:
- 93da681e-b689-4e05-8bd3-ac708bd3a464
- 93da684c-fa6f-4929-bcf1-df2b8714024a
SingleSkillInferenceResponse:
properties:
request_id:
type: string
title: Request Id
description: Unique identifier for this API request
example: a1b2c3d4e5f6
predictions:
items:
$ref: '#/components/schemas/SingleSkillInferencePrediction'
type: array
title: Predictions
description: List of predictions for each student-skill combination
type: object
required:
- request_id
- predictions
title: SingleSkillInferenceResponse
example:
predictions:
- predicted_pct_correct: 85.5
prediction_model: math_proficiency_v2.1
prediction_ts: '2024-03-21 14:30:00'
prediction_type: has_star,has_freckle
rl_skill_id: fba2bfaa479de311b77c005056801da1
skill_is_practiced: true
student_renaissance_rp_identifier: 7424932e-cfae-4353-b2da-3408acb0fa88
request_id: a1b2c3d4e5f6
SingleSkillInferencePrediction:
properties:
student_renaissance_rp_identifier:
type: string
title: Student Renaissance Rp Identifier
description: Renaissance Growth Platform student identifier
example: 7424932e-cfae-4353-b2da-3408acb0fa88
rl_skill_id:
type: string
title: Rl Skill Id
description: Renaissance Learning skill identifier
example: fba2bfaa479de311b77c005056801da1
prediction_model:
type: string
title: Prediction Model
description: Name/version of the prediction model used
example: math_proficiency_v2.1
predicted_pct_correct:
type: number
maximum: 100.0
minimum: 0.0
title: Predicted Pct Correct
description: Predicted percentage correct (0-100)
example: 85.5
prediction_type:
type: string
title: Prediction Type
description: Products contributing to predicted proficiency score (has_star, has_freckle)
example: has_star,has_freckle
skill_is_practiced:
type: boolean
title: Skill Is Practiced
description: Indicator to identify if the skill was practiced by the student
example: true
prediction_ts:
type: string
title: Prediction Ts
description: Timestamp when the prediction was generated in 'YYYY-MM-DD HH:MM:SS' format
example: '2024-03-21 14:30:00'
instructional_group:
anyOf:
- $ref: '#/components/schemas/InstructionalGroup'
- type: 'null'
description: Instructional group based on predicted proficiency
example: INSTRUCTIONAL
proficiency:
anyOf:
- type: number
maximum: 100.0
minimum: 0.0
- type: 'null'
title: Proficiency
description: 'Blended proficiency score (model prediction averaged with STAR performance). '
example: 72.5
type: object
required:
- student_renaissance_rp_identifier
- rl_skill_id
- prediction_model
- predicted_pct_correct
- prediction_type
- skill_is_practiced
- prediction_ts
title: SingleSkillInferencePrediction
securitySchemes:
HTTPBearer:
type: http
scheme: bearer