This checklist is for the TutorFlow customer onboarding team and the customer's project lead. Developers building the integration do not need it; the technical checks are in Testing an Integration.
Scope to confirm
| Topic | What the API does | Confirm with the customer |
|---|---|---|
| Input | Expansion accepts the customer's own JSON, one level per job. See Source JSON Format. | A current sample of one level, and which source object maps to one job. |
| Outputs | interactive_module, summary_video, and expanded_quiz, created as editable drafts. | Which outputs the pilot needs, and who reviews them before learners see them. |
| Resources | Direct control of modules, courses, videos, slides, tests, games, and simulations. | Which resources are synced first, and in which direction. |
| Generation | Priced game and simulation builds and video renders, if needed. | Whether the integration builds content or only manages what educators build. |
| Keys | Scoped, classroom-limited, expiring keys, managed in Settings > Content API. | Key owner, scopes, classrooms, rotation policy, and separate test and production keys. |
| Volume | A per-key rate limit of 1 to 600 requests per minute. | Expected pilot and production volume per minute. |
| Webhooks | Signed events for jobs, resource changes, builds, and renders. | The https receiver URL and the events needed. |
| Credits | See Pricing. | Expected monthly spend, and who approves it. |
| Content rights | TutorFlow stores the submitted payload with the job. | That the customer owns the content or may process it through TutorFlow. |
Pilot acceptance
- The customer's JSON is accepted without conversion.
- A job moves through
queued,processing, andcompleted, and the result has one entry per requested output. - The created module, video plan, and quiz are reviewed in TutorFlow and meet the customer's review criteria.
- The customer's system stores TutorFlow ids, job ids, and manifests next to its own ids.
- The customer understands which calls cost AI Credits (builds and renders; expansions are free) and can read
availableCreditbefore a batch.
Readiness questions
- Which output, if it fails, blocks pilot approval?
- Should the customer's system store every output, or only approved ones?
- Who reviews generated modules, video plans, and quiz items, and where?
- What retention period applies to source payloads and manifests on the customer's side?
Production handoff
| Item | Owner | Pilot | Production |
|---|---|---|---|
| Test key | Customer admin | Required | |
| Production key | Customer admin | Required | |
| One source JSON sample | Customer | Required | Required |
Source version or hash in the Idempotency-Key | Customer | Required | Required |
| Storage for job ids and manifests | Customer | Required | Required |
| Webhook receiver URL | Customer | Recommended | |
| Credit budget approver | Customer | Required | Required |
| Content rights confirmation | Customer | Required | Required |