Enqueue project

Important

A project queued for transcription needs to have a media file uploaded to it. See Upload media file for details on how to achieve this.

GET /XAPI/v2/Projects/{ProjectId}/Enqueue

Enqueue project

Adds the project to a transcription queue. It will get picked up by the server and transcribed as specified by the provided transcription options.

Parameters:

• ProjectId (integer)

Query Parameters:

• StartTranscriptionAt (number)

• TranscriptionDuration (number)

• Lang (string) – default cs-CZ

• WithPPC (boolean) – default true

• WithVAD (boolean) – default true

• WithPunctuation (boolean) – default true

• SaveTrsx (boolean) – default true

• TranscriptionProfile (string)

• WithSpeakerId (boolean) – default false

• WithDiarization (boolean) – default true

• DiarizationProfile (string)

• WithUserLex (boolean) – default true

• StartTranscriptionAtSeconds (number) – Start partial transcription of recording from given time in seconds (or from recording start if not set) Transcription can start few seconds earlier (depending on format)

• TranscriptionDurationInSeconds (number) – (maximum) Duration of transcription to transcribe in seconds (or to recording end if not set) Transcription can be few seconds longer depending on format

Status Codes:

• 200 OK – Project

• 403 Forbidden – Forbidden

• 412 Precondition Failed – Precondition failed

• 422 Unprocessable Entity – Invalid incoming data

Response JSON Object:

• Data.AccessToken (integer) – (required)

• Data.Created (string)

• Data.CreatorId (integer)

• Data.DeleteAt (string)

• Data.Description.Author (string)

• Data.Description.Name (string)

• Data.Description.Notes (string)

• Data.Description.Start (string)

• Data.ExpirationDate (string)

• Data.Id (integer) – (required)

• Data.IsReadOnly (boolean) – (required)

• Data.KeywordsHighlight.TextList[][].Category (string) – (required)

• Data.KeywordsHighlight.TextList[][].Highlight (string)

• Data.KeywordsHighlight.TextList[][].Text (string) – (required)

• Data.KeywordsHighlight.TextList[][].TimestampMs (integer)

• Data.Length (string) – (required)

• Data.MediaInfo.HasVideo (boolean) – (required)

• Data.MediaInfo.IsPackaged (boolean) – (required)

• Data.ProcessingState (string) – (required)

• Data.ShareCount (integer) – (required)

• Data.Tags[] (string)

• Data.TranscriptionConfig (any)

• Data.Updated (string)