• Documentation
  • Introduction
    • The member journey
  • Training
    • Create a program
    • Courses and sections
    • Lessons, media and publication
    • Milestones and paths
    • Tasks and deliverables
    • Cohorts and groups
  • Student & Community
    • Joining a school
    • Learning and resuming
    • Submitting and revising work
    • Calendar and lives
    • Spaces and questions
    • Reading progress
  • Coaching
    • Roles and assignments
    • Member context and work queue
    • Reviews and feedback
    • Sessions and interventions
    • Cohort cockpit and live operations
  • Leads & Qualification
    • People, leads and applications
    • Contacts and import
    • Qualification forms
    • Application triage
  • Setting & Booking
    • Setter scope
    • Sales availability
    • Share a booking link
    • Prospect booking
    • Agenda and booking management
    • Prepare a call and share its meeting link
  • Closing, Offers & Payments
    • Closer scope
    • Compose an offer
    • Share a nominal payment link
    • Buyer checkout and access
    • Instalments
    • Offline payment
    • Track payment and access failures
    • Stripe school account
  • Administration & Integrations
    • Organization roles and domains
    • API keys and tenant binding
    • Webhooks
    • Payment setup
  • API quickstart
  • API reference
    • Connect with MCP
    • Enrollments
      • GETGet the enrollment timeline
      • GETGet the coaching briefing
      • POSTPause an enrollment
      • POSTResume an enrollment
      • POSTExtend a deadline
      • POSTTransfer an enrollment
      • POSTClose an enrollment
      • POSTSubmit an outcome measure
      • GETList outcome measures
      • GETList deadline extensions
      • DELETECancel a deadline extension
      • GETList enrollments
      • POSTEnroll a person
    • Cohorts
      • GETGet the cohort cockpit
      • GETList the enrollments behind a cockpit signal
      • PATCHConfigure a cohort
      • POSTMove a cohort to another phase
      • POSTCreate a cohort
      • POSTChange a cohort's status
    • Coaching sessions
      • GETList coaching sessions
      • GETGet a coaching session
      • POSTRecord a coaching session
      • POSTAppend coaching session entries
    • Interventions
      • GETList interventions
      • POSTPlan an intervention
      • POSTClose an intervention
    • Live sessions
      • PATCHRecord live attendance
      • GETList live attendance
      • GETRead one enrollment's attendance
      • GETList live sessions
      • POSTSchedule a live session
      • PATCHUpdate a live session
      • POSTCancel a live session
      • GETGet live session
    • Programs
      • GETList programs
      • POSTCreate a program
      • GETRead a program
      • PATCHUpdate a program
      • POSTArchive a program
      • POSTRestore a program
    • Courses
      • GETList the courses of a program
      • POSTCreate a course
      • PATCHUpdate a course
      • POSTRename a course
      • POSTArchive a course
      • POSTReorder the courses of a program
      • POSTUpload a course cover
    • Sections
      • GETList the sections of a course
      • POSTCreate a section
      • POSTRename a section
      • POSTDissolve a section
      • POSTReorder the sections of a course
      • POSTMove a lesson into a section
      • DELETETake a lesson out of its section
    • Lessons
      • GETList the lessons of a program
      • POSTCreate a lesson
      • GETRead a lesson
      • PATCHUpdate a lesson
      • POSTPublish a lesson
      • POSTArchive a lesson
      • POSTMove a lesson to another course
      • POSTReorder the lessons of a program
      • POSTAttach a resource
      • DELETEDetach a resource
      • POSTReorder the resources of a lesson
      • POSTUpload a lesson resource
      • POSTUpload a lesson video
      • GETRead a lesson by its identifier
      • PATCHUpdate a lesson by its identifier
      • GETRead the discussion of a lesson
      • POSTComment on a lesson
    • Milestones
      • GETList the milestones of a program
      • POSTCreate a milestone
      • PATCHUpdate a milestone
      • POSTArchive a milestone
      • POSTReorder the milestones of a program
      • GETList the contributions of a milestone
      • POSTAttach a contribution
      • DELETEDetach a contribution
    • People
      • POSTImport people
      • POSTLink a duplicate person
      • DELETEUnlink a duplicate person
    • Delivery analytics
      • GETGet delivery analytics
    • Sales availability
      • GETRead sales availability
      • GETPreview sales slots
      • PUTReplace sales availability
      • GETList eligible sales closers
    • Community
      • POSTUpload an attachment
      • POSTAttach to a thread
      • POSTCreate a space
      • POSTPost a thread
      • POSTReply to a thread
      • POSTLink a thread
      • GETList spaces
      • GETRead a thread
      • GETSearch the community
    • Offer payments
      • POSTPause automatic charging
      • DELETEResume automatic charging
      • POSTCharge an instalment now
      • GETGet collections dashboard
    • Member tasks
      • POSTCreate a member task
      • GETList the tasks of a milestone
      • PUTUpdate a member task
      • POSTArchive a member task
      • POSTReorder the tasks of a milestone
      • GETRead a task
      • GETList program tasks
    • Deliverables
      • POSTCreate a deliverable
      • GETList the deliverables of a task
      • GETGet a deliverable
      • PUTUpdate a deliverable
      • POSTArchive a deliverable
    • Groups
      • GETList groups
      • POSTCreate a group
      • GETGet a group
      • PATCHUpdate a group
      • POSTAdd a Group membership
      • DELETERemove a Group membership
    • Paths
      • GETList program paths
      • POSTCreate a path
      • GETGet a path
      • PATCHVersion or promote a path
    • Webhooks
      • GETList webhook subscriptions
      • POSTCreate a webhook subscription
      • GETGet a webhook subscription
      • PATCHUpdate a webhook subscription
      • DELETEDelete a webhook subscription
      • POSTVerify a webhook subscription
      • POSTRotate a webhook secret
      • POSTPause or reactivate a webhook subscription
      • GETList webhook deliveries
      • GETGet a webhook delivery
      • POSTReplay a webhook delivery
    • Media
      • GETList media
      • POSTUpload a media
      • PATCHRename a media
      • DELETEDelete a media
    • Bookings
      • GETList the open slots of a booking link
      • POSTSave a booking lead
      • POSTBook a call for a prospect
      • GETGet booking details
      • GETList bookings
      • GETGet booking
      • PATCHUpdate booking details
      • GETGet booking agenda
      • GETGet closer meeting link
      • GETList person bookings
      • PUTSet closer meeting link
      • GETList booking links
      • POSTSend a booking email
      • GETRead booking follow-up
      • POSTCreate booking link
      • GETGet booking link
      • PUTRecord booking attendance
      • GETRead booking reminder settings
      • PATCHUpdate booking link
      • POSTReschedule booking
      • PUTSet booking reminder settings
      • POSTCancel booking
      • GETList booking reassignment candidates
      • POSTReassign booking
      • GETList booking reschedule slots
      • GETList booking reassignment slots
    • My learning
      • GETList my enrollments
      • GETGet my learning context
      • GETList my lessons
      • GETGet one of my lessons
      • GETList my agenda
      • GETGet my lesson note
      • PUTSave my lesson note
      • DELETEDelete my lesson note
      • GETList my lesson notes
      • GETGet my lesson's agent section
      • GETList my tasks
      • GETRead my submission
      • POSTOpen my submission draft
      • PUTSave my submission draft
      • POSTSubmit my work
      • POSTResubmit my work
    • Forms
      • GETList forms
      • POSTCreate a form
      • GETGet a form
      • PATCHUpdate form identity
      • DELETEDelete a form
      • PUTSave form definition
      • PUTSet form theme
      • PUTSet form qualification
      • PUTSet submission mode
      • PUTOpen or close a form
      • POSTPublish a form
      • POSTUnpublish a form
      • GETList form responses
      • GETGet a form response
      • GETRead form statistics
      • POSTRetry response qualification
      • GETRead form definition
      • GETRead form theme
      • GETRead form qualification
      • GETRead form submission-settings
      • GETRead form identity fields
      • PUTSet form identity fields
    • Calendar connections
      • GETList calendar connections
      • GETRead a calendar connection
      • POSTRequest calendar consent
      • GETList writable calendars
      • PUTSelect a calendar
      • DELETEDisconnect a calendar
    • Offers
      • GETList offers
      • POSTCreate an offer
      • GETGet an offer
      • PATCHUpdate an offer
      • GETGet composer options
    • Responsibilities
      • GETList responsibilities
      • POSTAssign a responsibility
      • DELETERemove a responsibility
    • Submission reviews
      • GETList submission reviews
      • GETRead a submission review
      • POSTTake a submission in review
      • POSTDecide a submission review
    • Closers
      • GETList closer invitations
      • POSTInvite a closer
      • POSTResend a closer invitation
      • DELETECancel a closer invitation
      • GETRead commercial responsibility
      • PUTAssign commercial responsibility
      • GETRead my sales availability
      • PUTUpdate my sales availability
      • GETRead my closer setup
    • Personal preparation
      • GETRead my work profile
      • PATCHUpdate my work profile
      • GETRead my preparation
    • Video library
      • GETList video resources
      • GETGet a video resource
      • POSTPublish a video resource
      • PATCHUpdate a video resource
      • POSTUnpublish a video resource
      • POSTRepublish a video resource
    • Video questions
      • POSTAsk a question
      • GETList my questions
      • GETGet my question
      • GETList received questions
      • PATCHAssign a question
      • POSTAnswer a question
      • POSTCancel a question
  1. Documentation
  2. API reference
  3. Lessons
  4. Upload a lesson video
HomeBlogDocumentationPricingContact

Upload a lesson video

PreviousUpload a lesson resourceNextRead a lesson by its identifier
On this page
AuthorizationPath parametersRequest headersRequest bodyExampleResponseResponse fieldsExample responseAgent recipeNotesRelated

POST /api/v1/lessons/{lessonId}/video-upload

Prepares a hosted video for one lesson, in one call: the video is created on Bunny Stream, it enters the media library as processing, and its player address is set as the lesson's video right away. You then send the file yourself, straight to the video host, with the signed credentials of the response — the file never goes through Cohorte.

Authorization

Role in the organizationThis endpoint
OWNERAllowed
ADMINAllowed
MEMBERRefused — 403
RequirementRule for this endpoint
Business roleNone — the permission is that of the lesson
Resource scopeThe lesson belongs to the key's organization
ParticipationNone
Resource stateThe lesson's program and course are not archived

Path parameters

ParameterTypeRequiredDescription
lessonIdUUIDyesLesson of the key's organization

Request headers

HeaderRequiredDescription
x-api-keyyesAPI key created for this organization
Idempotency-KeynoAccepted, but there is no replay: every call opens a new video
X-Correlation-IdnoCaller correlation id, returned or generated

Request body

FieldTypeRequiredNullableDescription
titlestringnonoTitle in the media library. Defaults to the lesson title
mimeTypestringnonoFor example video/mp4, recorded in the library
sizeBytesintegernonoFile size, recorded in the library

Example

bash
# 1. Open the upload — the lesson now points at the new video.
curl -X POST "$COHORTE_API_BASE_URL/api/v1/lessons/$LESSON_ID/video-upload" \
  -H "x-api-key: $COHORTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Welcome", "mimeType": "video/mp4"}'

# 2. Send the file with any TUS client, using the four signed headers.
#    Metadata values are base64-encoded, as the TUS protocol requires.
curl -X POST "$UPLOAD_ENDPOINT" \
  -H "Tus-Resumable: 1.0.0" \
  -H "Upload-Length: $(wc -c < welcome.mp4 | tr -d ' ')" \
  -H "Upload-Metadata: filetype $(printf video/mp4 | base64),title $(printf Welcome | base64)" \
  -H "AuthorizationSignature: $SIGNATURE" \
  -H "AuthorizationExpire: $EXPIRES" \
  -H "VideoId: $VIDEO_ID" \
  -H "LibraryId: $LIBRARY_ID" \
  -i
# then PATCH the returned Location with the file bytes (Upload-Offset: 0).

Response

  • 201 Created — the upload is open and the lesson points at the video.
  • 400 Bad Request — invalid JSON, or video hosting is not configured for this platform.
  • 401 Unauthorized — missing, unknown or expired key.
  • 403 Forbidden — the bearer is not OWNER or ADMIN, or the lesson's program or course is archived.
  • 404 Not Found — the lesson is unknown or belongs to another school. No video is created.

Response fields

FieldTypeDescription
data.mediaIdUUIDThe video in the media library
data.lessonIdUUIDThe lesson it is attached to
data.embedUrlstringPlayer address, now the lesson's video
data.upload.endpointstringTUS endpoint to send the file to
data.upload.libraryIdstringValue of the LibraryId header
data.upload.videoIdstringValue of the VideoId header
data.upload.expiresintegerValue of the AuthorizationExpire header — Unix seconds, one hour ahead
data.upload.signaturestringValue of the AuthorizationSignature header

Example response

json
{
  "success": true,
  "data": {
    "mediaId": "8c9d0e1f-2a3b-4c4d-8e5f-6a7b8c9d0e1f",
    "lessonId": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
    "upload": {
      "endpoint": "https://video.bunnycdn.com/tusupload",
      "libraryId": "123456",
      "videoId": "0f1e2d3c-4b5a-6978-8a9b-0c1d2e3f4a5b",
      "expires": 1759312800,
      "signature": "5e3b…"
    },
    "embedUrl": "https://iframe.mediadelivery.net/embed/123456/0f1e2d3c-4b5a-6978-8a9b-0c1d2e3f4a5b"
  },
  "correlationId": "c0ffee00-1111-4222-8333-444455556666"
}

Agent recipe

  1. POST /api/v1/lessons/{lessonId}/video-upload — keep upload and mediaId.
  2. Send the file to upload.endpoint with a TUS client and the four signed headers, before upload.expires.
  3. Poll List media with ?kind=video until the media with mediaId is ready.
  4. Publish the lesson only then.

Notes

  • The lesson shows the video's encoding state until it is ready. On a published lesson, members see that state — upload before publishing.
  • A failed or abandoned upload leaves the lesson on an empty video until you change it with Update a lesson.
  • Calling twice opens two videos: the lesson points at the second, the first stays in the library, unused, and can be deleted.
  • Images and documents do not go through here: use Upload a media.

Related

  • Update a lesson
  • List media
  • Upload a lesson resource