Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 4.16 KB

README.md

File metadata and controls

51 lines (40 loc) · 4.16 KB

Documentation for Cielo24

Documentation for API Endpoints

All URIs are relative to https://api.cielo24.com/api

Class Method HTTP request Description
AccountApi getSettings GET /account/get_settings Get Account Settings
AccountApi login POST /account/login Login to the cielo24 API to obtain an API access token for use when calling other methods. Optional arguments may be passed either as HTTP headers or query string parameters. Required arguments must be passed as query string parameters.
AccountApi logout POST /account/logout Logout of the current session, invalidating the API token.
AccountApi verifyKey GET /account/verify_key Test Auth
JobApi addMediaFile POST /job/add_media Add a piece of media to an existing job using a local file. No content-type should be included in the HTTP header. The media should be uploaded as raw binary, no encoding (base64, hex, etc) is required. Chunk-transfer encoding is NOT supported. File size is limited to 10 gb
JobApi addMediaUrl GET /job/add_media Add a piece of media to an existing job using a public media url. A job may only have a single piece of media associated with it, attempting to add additional media will return an error code.
JobApi authorizeJob POST /job/authorize Authorize an existing job. If your account has the "customer authorization" feature enabled (it is not enabled by default) jobs you create will be held in the "Authorizing" state until you call this method. Calling this method on a job that is not the "Authorizing" state has no effect and will return success. Please contact [email protected] to enable the "customer authorization" feature.
JobApi getCaption GET /job/get_caption Get the caption file for a job. The job must have completed transcription before a caption can be downloaded.
JobApi jobInfo GET /job/info
JobApi newJob POST /job/new Create a new job. A job is a container into which you can upload media and request that transcription be performed. Creating a job is prerequisite for virtually all other methods.
JobApi performTranscription POST /job/perform_transcription Request that transcription be performed on the specified job. A callback URL, if specified, will be called when the transcription is complete. See callback documentation for details.
JobApi performTranslation POST /job/perform_translation Request that orders a new Translation language for a video that has been previously Transcribed and/or Translated. The New Job ID and job target language will be returned upon completion.

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: api_token
  • Location: URL query string