apiv2

Use when building or operating a staff frontend to list, schedule, sync, or recover academy GitHub organization memberships; do NOT use for Copilot seats, provisioning bills, or staff/student invites unrelated to GitHub org membership.

Load first for academy-scoped BreatheCode API work (/academy/, Academy header, staff capabilities). Maps requests to domain skills. Do NOT use for pure learner self-service without staff context — use breathecode-student-api-index instead.

Use when academy staff need to list or view certificate specialties, create or update academy-owned specialties, link a syllabus to a specialty, or assign a specialty to a student by issuing a certificate; do NOT use for listing a student's own certificates (use certificate me endpoint).

Use when an authenticated student needs to check LLM budget entitlement, list LiteLLM API keys and per-key spend, create a new LLM API key, or delete an existing key; do NOT use for academy staff configuring LiteLLM vendors or teams, VPS provisioning, or granting LLM budget through plans.

Load first for authenticated learner BreatheCode API work (user-scoped /me and user/me routes, public join/catalog where applicable). Maps requests to domain skills. Do NOT use for academy admin tasks requiring /academy/ or the Academy header — use breathecode-staff-api-index instead.

Use when academy staff need to set main currency and create, list, update, or deprecate checkout payment methods; do NOT use for Stripe credential setup when is_credit_card is true (use bc-payments-configure-academy-stripe first), student card save, or subscription cancel/refund.

Use when academy staff need to list, create, update, or retire payment plans, configure resource sets, consumables, financing, country pricing, or plan upgrade offers; do NOT use for payment method setup, Stripe credentials, subscription cancel/refund, or marketing course creation.

Use when implementing self-serve cancellation or staff-driven cancellation with optional invoice refunds; do NOT use for consumption-session reversals, mentorship refund tasks, or payment-method setup.

Use when staff wrap up a finished academy workshop—confirm the event has ended, reconcile attendance (platform join, Luma off-platform guests, or bulk import), publish the recording URL (emails checkins with attended_at), and know what runs automatically (AI recap, NPS survey); do NOT use for creating events (bc-events-create-and-edit-event), operating while scheduled/live (bc-events-during-event), or initial Luma webhook setup (bc-events-configure-luma-webhooks).

Use when staff configure legacy event NPS, verify automatic post-workshop surveys, resend to non-responders, or review event answer scores; do NOT use for SurveyStudy campaigns (bc-feedback-create-manage-feedback-survey) or pre/during-event ops (bc-events-during-event).

Use when diagnosing FormEntry CRM sync failures, stuck storage_status, or ActiveCampaign double-sync issues; do NOT use for creating leads or routine list/update/delete operations.

Use when staff search, filter, update, delete, or re-process existing academy FormEntry leads; do NOT use for creating leads, debugging storage_status failures, or public capture flows.

Use when an authenticated student needs to list cohorts they joined as STUDENT and interpret progress, including self-paced never_ends cohorts and macro cohorts that contain micro cohorts (hide micro as duplicate when also enrolled in the parent macro); do NOT use for staff listing other users, academy /academy/ cohort admin, teacher assignment review queues, or enrollments where the user is only TEACHER/ASSISTANT.

Use when staff or teachers review **PROJECT** syllabus tasks via the API (discover queue, load asset `config` from the registry, submit `PUT` with `revision_status` and feedback). Do NOT use for `EXERCISE`, `LESSON`, or `QUIZ` tasks, for capstone `FinalProject` flows, for implementing assignment code, or for Rigobot CodeRevision-only workflows.

Use when implementing or troubleshooting staff authentication (login/token flows, academy context, capability lookup to decide access, integration token, staff-assisted password/GitHub reset, first-party app token exchange); do NOT use for student self-service auth, staff member/invite administration, or custom role management.

Use when inviting, listing, resending, accepting, updating, or removing academy staff members (non-student ProfileAcademy); do NOT use for student enrollment, staff login/capability checks, or custom role CRUD.

Use when implementing or troubleshooting student authentication (token login, hosted login redirect, academy-scoped capabilities via ProfileAcademy, academy-less permissions via Django groups, GitHub connect/reconnect); do NOT use for staff-only academy admin, member/invite CRUD, or custom role management.

Use when creating a new academy cohort (single certificate or macro with micro cohorts) via the API; do NOT use for listing/updating cohorts, enrolling students, or issuing certificates.

Use when staff bulk-import event attendees (RSVP and optional attended) for an existing academy event via async job; do NOT use for creating/editing events, Luma webhooks, or learner self-service check-in.

Use when staff need to connect a Luma calendar to BreatheCode for real-time guest registration and check-in via webhooks; do NOT use for Eventbrite sync, manual event check-in APIs only, or learner self-service join flows.

Use when staff need to create or set up academy events (event type, tags, optional workshop asset, host, and meeting setup); do NOT use for during-event operations (bc-events-during-event), post-event wrap-up (bc-events-post-event), bulk attendee import (bc-events-bulk-import-checkins), or learner join/check-in.

Use when staff operate on a scheduled or live academy workshop before it finishes—reschedule dates, suspend an upcoming event, export the guest list, import outside registrations, or create promo short links with UTM; do NOT use for initial event creation (bc-events-create-and-edit-event), post-event wrap-up (bc-events-post-event), or Luma webhook credential setup (bc-events-configure-luma-webhooks—load only when wiring Luma).

Use when academy staff need to configure Stripe API keys and webhook secret for their academy; do NOT use for payment method catalog CRUD, subscription cancel/refund, or student card onboarding.

Use when staff need to create and manage syllabus schedule templates, schedule timeslots, and sync them into cohort timeslots; do NOT use for syllabus JSON/version authoring or macro override content workflows.

Use when diagnosing assignment/package telemetry collection for an asset, user, or task and when interpreting telemetry stats usage patterns, and do NOT use for general assignment grading or non-telemetry workflows.

Use when staff need to create, run, and review SurveyStudy-based NPS or any other user satisfaction campaigns through the feedback API; do NOT use for legacy Survey/Answer cohort flows or notification-only tasks.

Use when creating FormEntry leads via public capture, partner app, staff POST, or CSV bulk upload, including CRM and webhook side effects; do NOT use for listing, editing, deleting, or analyzing existing leads.

Use when staff need to create a marketing course from scratch or by cloning another course via API; do NOT use for updating an existing course or editing course translations only.

Use when implementing or analyzing inbound signups, attribution, and acquisition across marketing FormEntry and auth UserInvite flows; do NOT use for creating leads, staff lead CRUD, CRM sync debugging, or generic student login troubleshooting.

Use when reading and interpreting the acquisition monitoring report via `/v1/monitoring/report/acquisition*`; do NOT use for report generation or acquisition report implementation changes.

Use when retrieving monitoring report data for dashboards or frontend report screens via `/v1/monitoring/report*`; do NOT use for creating new report generators or running `generate_report`.

Use when academy staff need to connect Slack, run manual syncs, and monitor Slack sync health for students/cohorts; do NOT use for generic notifications or non-Slack messaging workflows.

Use when a user, student or academy staff needs to request, list, view, or deprovision a VPS via the API (including staff requesting a VPS on behalf of a student); do NOT use for granting VPS credits via plans or payments.

Use when academy staff need to create or update provisioning profiles (academy–vendor link) or set credentials and settings for an academy; do NOT use for requesting or listing VPS (use bc-provisioning-manage-vps-server).

Use when academy staff need to manage registry asset comments (optional `academies=<id,id>` querystring on GET for multi-academy scope) and asset error issues end-to-end including deduping legacy duplicate error rows, and do NOT use for public asset browsing or non-registry workflows.

Guides coding agents through the BreatheCode talent development API (job families, roles, career paths and stages, skill domains, global skills, competencies, stage-anchored skills), including search and filter query parameters on list endpoints. Use when building or querying the school skills framework, linking skills to career stages while designing syllabi, or automating talent_development endpoints under /v1/talent/.

Use when adding a new monitoring report type end-to-end (generation + read API registry metadata); do NOT use for only reading report data or debugging existing report rows.

Documenta la validación del JSON de syllabus (root vs overrides *.vN o N:*.vN), placeholders permitidos en overrides (null/{} por índice), y el bloqueo de self-override. Usar cuando se editen/valide macrosyllabus, overrides, o aparezcan errores de test_syllabus en admissions.

Use when comparing two language codes or querying/filtering by language in the API. Ensures "us" and "en" are treated as the same language via shared helpers from breathecode.utils.validators.