WEwearelearning
ScriptAssistant

POST /api/script-assistant/sessions/{sessionId}/files

Request

  • Base URL
    https://api.wearelearning.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Implicit: https://login.wearelearning.io/authorize?audience=https://api.wearelearning.io

Path parameters

sessionIdstring required

Request body multipart/form-data

filestring binary

Response

OK

fileIdstring required
fileNamestring required
status'Pending' | 'Converting' | 'Succeeded' | 'Failed' required
parsingSucceededboolean required

Derived from WeAreLearning.R2D2.Api.DTO.ScriptAssistant.FileUploadResultDto.Status for one release. The API and the client deploy separately, so removing this before the client stops reading it makes every upload look failed. Delete once the client is out — tracked as a follow-up.

parsingErrorCode'None' | 'Unknown' | 'UnsupportedFileType' | 'FileTooLarge' | 'EncryptedFile' | 'NoTextFound' | 'CorruptFile' | 'Timeout' | 'SuspectedZipBomb' | 'TooManySlides' | 'SourceExpired' | 'NotASlideDeck' required
skippedCountinteger required

Pages or slides that could not be read and were skipped. Greater than zero means the extraction succeeded but is incomplete, so clients can warn the user.

extractedTextPreviewstring nullable
isSlideDeckboolean required

Whether this upload classified as a slide deck.

slideCountinteger nullable

Nullable and advisory. Known for parse-backed OpenXML decks and a successfully-parsed .pdf; null — never zero — for conversion-backed formats and anything else not yet known, since nothing reads those before LibreOffice conversion runs. For a deck it counts the slides that will render, so hidden slides are excluded.

Changes

No recorded changes to this operation across all 1 revision of this API.