Apprentice

for builders

Scout workspace API

Scout is the AI agent. This API is the student workspace Scout already uses, opened for Muse and other agents after the student consents.

Scout

Scout is the AI agent from Apprentice Platforms. A student talks to Scout in the app. Scout listens, finds colleges and programs that fit, and keeps applications, deadlines, writing, and a resume moving — without writing the student’s essays.

This API is not Scout’s voice. It is the workspace Scout already works in. Muse and other agents may use that workspace after the student signs in and says yes. They do not become Scout, and they do not get Scout’s chat.

Who this is for

This documentation is for teams connecting another agent — today, Muse — to a student’s Scout workspace. It is not a license to scrape the site, automate sign-up, or operate on behalf of a student who has not consented.

Chat with Scout, family billing, and the Company’s internal tools are not part of this API. If a capability is not listed here, it is not offered.

Principles

The student is the principal

Every token belongs to one student who signed in and said yes. An integration never sees another student’s workspace.

No shared secret for the classroom

There is no app-wide API key. Muse is an OAuth client. Access is granted per student, and it can be revoked.

The student still writes

Scout will not ghostwrite essays. Connected apps should help a student plan, organize, and revise — not submit work in their name.

The same workspace Scout already uses

Creates and edits land where Scout already works — profile, applications, tasks, writing, and the rest — not a shadow copy.

Connecting Muse

  1. Register Muse as an OAuth application with Apprentice Platforms. You receive a client id and client secret — those identify Muse, not a student.
  2. Point Muse at the discovery document and the OpenAPI description. Ask for the workspace scope.
  3. When a student taps Connect, they sign in and see a short consent summary — not a wall of technical scopes.
  4. Muse stores that student’s access and refresh tokens and calls the API with Authorization: Bearer. One token sees one student.
  5. The student can revoke the connection later from Settings → Connections.

OAuth

Authorization is OAuth 2.0 authorization code. Confidential clients send a client secret. PKCE (S256) is required for every client. Refresh tokens rotate and reuse of an old refresh token revokes that connection. There is no password grant and no shared classroom token.

Discovery

https://apprentice-app.com/.well-known/oauth-authorization-server

Authorize

https://apprentice-app.com/oauth/authorize

Token

POST https://apprentice-app.com/oauth/token

Revoke

POST https://apprentice-app.com/oauth/revoke

OpenAPI

https://apprentice-app.com/api/v1/openapi.json

Scopes

Ask Muse for workspace. That is full access to the student workspace listed below. The consent screen shows one sentence. Tokens still carry the underlying *.read and *.write resource scopes so a narrower client can request less later.

offline_access is accepted so a refresh token can be issued. It does not appear on the consent list.

Workspace

Base URL is the issuer. Send a student access token on every call. Writes may include an optional Idempotency-Key. Deletes archive or remove a single item the student owns — they do not wipe a collection.

Profile

profile.read · profile.write

Who the student is: interests, skills, goals, activities, experiences, and projects.

  • GET /api/v1/profile
  • PATCH /api/v1/profile
  • POST /api/v1/profile/{collection}

Colleges

colleges.read · colleges.write

Search the catalog and keep a short list of schools the student is actually considering.

  • GET /api/v1/colleges
  • GET /api/v1/colleges/saves
  • POST /api/v1/colleges/saves

Applications

applications.read · applications.write

Track college applications: create one, update status, deadline, or notes.

  • GET /api/v1/applications
  • POST /api/v1/applications
  • PATCH /api/v1/applications/{id}

Tasks

tasks.read · tasks.write

The student’s to-dos — create, update, complete, or remove a single task.

  • GET /api/v1/tasks
  • POST /api/v1/tasks
  • PATCH /api/v1/tasks/{id}
  • DELETE /api/v1/tasks/{id}

Calendar

calendar.read · calendar.write

Deadlines and events on the student’s calendar. Archive an event instead of wiping the book.

  • GET /api/v1/calendar/events
  • POST /api/v1/calendar/events
  • PATCH /api/v1/calendar/events/{id}
  • DELETE /api/v1/calendar/events/{id}

Opportunities

opportunities.read · opportunities.write

Internships, summer programs, and other listings the student has saved.

  • GET /api/v1/opportunities/saves
  • POST /api/v1/opportunities/saves

Awards Locker

awards.read · awards.write

Honors and awards the student wants on the record. Archive an item; do not empty the locker.

  • GET /api/v1/awards
  • POST /api/v1/awards
  • PATCH /api/v1/awards/{id}
  • DELETE /api/v1/awards/{id}

Stories & memory

memory.read · memory.write

Memory Box stories and notes the student wants Scout to remember. Propose memory; the student still owns it.

  • GET /api/v1/stories
  • POST /api/v1/stories
  • GET /api/v1/memory
  • POST /api/v1/memory

Resumes

resumes.read · resumes.write

Resume versions: create, sync from the profile, set a primary, tailor, or link to an application.

  • GET /api/v1/resumes
  • POST /api/v1/resumes
  • POST /api/v1/resumes/{id}/{action}

Writing Studio

writing.read · writing.write

Projects, requirements, documents, outlines, and briefs. Help the student structure work they still write.

  • GET /api/v1/writing/projects
  • POST /api/v1/writing/projects
  • GET /api/v1/writing/documents

Roadmap

roadmap.read · roadmap.write

The multi-year plan and its milestones — start a roadmap, add a step, mark one complete.

  • GET /api/v1/roadmap
  • POST /api/v1/roadmap
  • POST /api/v1/roadmap/milestones

Safety

  • A token is useless without the student’s prior consent, and it dies when they revoke it.
  • Do not request more than the student needs. Prefer workspace for Muse; do not invent scopes.
  • Do not use this API to generate or submit application essays as if they were the student’s.
  • Do not retain student content longer than your product requires. The Company does not sell it.
  • Production hosts must be public HTTPS. Localhost is for your own development only.

Versioning

The current public surface is /api/v1. Additive fields may appear without notice. Removing or renaming a published route is a new version. The OpenAPI document is the machine-readable contract.

Support

Partnership and API questions: apprentice@apprentice-app.com. Scout is the AI agent of Apprentice Platforms, a Delaware corporation. See About, Terms, and Privacy.