登录

Quick Start

Set up your API key, make your first evaluation request, and parse structured AI feedback. All in under 5 minutes.

All API requests use the base URL https://api.tutorflow.io.

1. Create a Workspace

Sign up at tutorflow.io and create a platform workspace from the TutorFlow dashboard. This workspace is used to manage API keys, usage, and billing. The slug must contain only lowercase letters, numbers, and hyphens.

After creating a workspace, verify your email address and purchase credits to start making API calls. Then choose the evaluation tier that matches your product: fast at $0.01, standard at $0.03, and advanced at $0.05 per evaluation.

curl -X POST https://api.tutorflow.io/v1/platform/workspaces \
  -H "Authorization: Bearer tf_platform_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My EdTech",
    "slug": "my-edtech",
    "email": "dev@myedtech.com"
  }'

2. Generate an API Key

Generate an API key. Keys are securely hashed. You only see the raw key once, so store it securely.

curl -X POST https://api.tutorflow.io/v1/platform/api-keys \
  -H "Authorization: Bearer tf_platform_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production Key",
    "workspaceId": "workspace-uuid"
  }'

Response:

{
  "apiKey": "tf_platform_..."
}

3. Make Your First API Call

Send an evaluation request using your API key:

curl -X POST https://api.tutorflow.io/v1/platform/evaluations \
  -H "Authorization: Bearer tf_platform_..." \
  -H "Content-Type: application/json" \
  -d '{
    "evaluationType": "open_ended",
    "questionText": "What causes seasons on Earth?",
    "learnerAnswer": "The tilt of Earth axis causes seasons.",
    "language": "en",
    "maxScore": 10
  }'

4. Parse the Response

The API returns structured AI feedback:

{
  "id": "2f4ad455-1e8e-4b6c-9f3a-7ebf4cf6f483",
  "status": "COMPLETED",
  "evaluationType": "open_ended",
  "score": 7,
  "maxScore": 10,
  "normalizedScore": 0.7,
  "strengths": [
    "Correctly identifies Earth's axial tilt as the cause"
  ],
  "suggestions": [
    "Explain how tilt affects sunlight angle and duration",
    "Mention the difference between hemispheres"
  ],
  "feedbackSummary": "Good understanding of the basic concept...",
  "createdAt": "2026-03-19T12:00:00.000Z",
  "completedAt": "2026-03-19T12:00:01.000Z"
}

Next Steps

IntroductionAuthentication