Agent Self-Service Onboarding | TutorFlow Agent Platform Docs

Overview

The TutorFlow Agent Platform supports agent-driven onboarding. An AI agent can discover the service, create a workspace, obtain an API key, and begin making evaluation requests. To use the API, the agent must verify its email and purchase credits. For continued usage, the agent requests a checkout page link and delegates credit purchase to a human operator.

Using Claude or another MCP-compatible agent? Connect via the MCP Integration guide instead. The MCP server exposes all onboarding and evaluation steps as structured tools. No HTTP calls required.

1. Discovery

Agents discover the platform by fetching the public manifest:

curl https://api.tutorflow.io/v1/platform/.well-known/agent.json

The response includes the registration endpoint, auth requirements, available services, and documentation URL:

{
  "schema": "https://tutorflow.io/agent-manifest/v1",
  "name": "TutorFlow Agent Platform",
  "baseUrl": "https://api.tutorflow.io/v1/platform",
  "auth": { "type": "bearer", "prefix": "tf_platform_" },
  "registration": {
    "endpoint": "/v1/platform/agent/register",
    "method": "POST",
    "requiredFields": ["name", "slug", "email"],
    "optionalFields": ["agentIdentity"]
  },
  "services": ["evaluation"],
  "pricing": { "endpoint": "/v1/platform/pricing-catalog", "currency": "USD" },
  "docs": "https://tutorflow.io/agent-platform/docs"
}

2. Registration

Field	Type	Required	Description
`name`	`string`	Yes	Workspace display name
`slug`	`string`	Yes	Unique URL-safe identifier. Lowercase letters, numbers, and hyphens only. Cannot start or end with a hyphen.
`email`	`string`	No	Contact email for the workspace
`agentIdentity`	`string`	No	Agent identity string (e.g. "claude-3-5-sonnet via LangChain")

curl -X POST https://api.tutorflow.io/v1/platform/agent/register \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My AI Tutor",
    "slug": "my-ai-tutor",
    "email": "agent@example.com",
    "agentIdentity": "claude-3-5-sonnet via LangChain"
  }'

The response contains the API key (shown only once):

{
  "workspaceId": "uuid",
  "apiKey": "tf_platform_...",
  "keyPrefix": "tf_platform_abcd",
  "message": "Store your API key securely. It will not be shown again."
}

Rate limit: 5 registrations per IP per hour.

3. Verify Email

After registration, the workspace must verify its email address before making API calls. A verification email is sent automatically at registration. The recipient clicks the link in the email, which calls:

GET https://api.tutorflow.io/v1/platform/agent/verify-email?token=VERIFICATION_TOKEN

If the email did not arrive, the agent can request a new one:

curl -X POST https://api.tutorflow.io/v1/platform/agent/verify-email/resend \
  -H "Authorization: Bearer tf_platform_..."

Until the email is verified, API calls return a 403 error with code email_verification_required.

4. Billing Setup

After email verification, the agent can purchase credits and start making API calls. The agent requests a checkout page URL and forwards it to a human operator to choose an amount and complete payment.

4.1 Request a Billing Session

curl -X POST https://api.tutorflow.io/v1/platform/agent/billing/session \
  -H "Authorization: Bearer tf_platform_..."

Response:

{
  "url": "https://tutorflow.io/agent-platform/checkout?token=xxx",
  "sessionId": "cs_..."
}

The agent forwards the url to a human (e.g., via Slack, email, or chat). The human opens the TutorFlow-hosted checkout page in a browser, chooses how much to add ($5 minimum, $5,000 maximum), and is then redirected to Stripe to complete payment. No card data passes through the agent or TutorFlow servers.

4.2 Check Billing Status

After the human completes checkout, the agent can verify:

curl https://api.tutorflow.io/v1/platform/agent/billing/status \
  -H "Authorization: Bearer tf_platform_..."

{
  "hasPaymentMethod": true,
  "cardBrand": "visa",
  "cardLast4": "4242",
  "creditBalance": 100,
  "billingMode": "internal_invoice"
}

5. Start Making API Calls

With the API key from registration, the agent can immediately call the evaluation endpoint:

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
  }'

6. Check Account Info

curl https://api.tutorflow.io/v1/platform/agent/account \
  -H "Authorization: Bearer tf_platform_..."

{
  "workspaceId": "uuid",
  "name": "My AI Tutor",
  "slug": "my-ai-tutor",
  "status": "ACTIVE",
  "creditBalance": 93,
  "rateLimitPerMinute": 1000,
  "createdAt": "2026-03-22T00:00:00.000Z"
}

Endpoint Summary

Method	Endpoint	Auth	Description
`GET`	`/.well-known/agent.json`	None	Service discovery manifest
`POST`	`/agent/register`	None (IP throttled)	Self-registration
`GET`	`/agent/verify-email?token=`	None	Verify email address
`POST`	`/agent/verify-email/resend`	API Key	Resend verification email
`POST`	`/agent/billing/session`	API Key	Get checkout page URL for credit purchase
`GET`	`/agent/billing/status`	API Key	Billing status
`GET`	`/agent/account`	API Key	Account info