The Basics

Getting Started

  1. Send an email to support@cielo24.com requesting a sandbox API login.

  2. Download our API libraries: Python, Ruby, Java, PHP, .NET.

    1. Each project includes a core library and a command line application you can use to experiment with the API without writing any code of your own.

  3. Use the sandbox credentials you received from support and the libraries to connect to our API.

Sandbox API

For testing, a sandbox API is provided at https://sandbox.cielo24.com. The sandbox provides a testing platform for development, where no real processing is performed. Transcript/caption requests made to the sandbox will return a pre-prepared sample, the data will not match the content or length of media you submitted. However, the transcript/caption will be formatted as you request in your get_transcript / get_caption call. The sandbox API will make URL callbacks, if requested, a few seconds after the call to perform_transcription is made.

In order to use the sandbox API, create an account in the environment is a prerequisite. See here sandbox_access for additional details.

The sandbox API follows the same steps as the production API for job creation:

  1. A job must be created (new)

  2. A media must be added to the job (add_media)

  3. Finally, the Perform transcription must be called (perform_transcription)

After all the steps are done, basic information on the job can be requested (info).

Notes:

  1. The sandbox API will also change the state of the job to Complete after some time in the processing state.

  2. The Sandbox API returns a pre-prepared sample of the production API, the data will not match the content or length of media you submitted

  3. Some endpoints aren’t implemented on the Sandbox:

    1. List Related

    2. Add Custom Guideline To Job

    3. Get Transcoded Media

    4. Order Translation

    5. Request Pre-signed Upload URL

    6. Uplevel Job

Production API

The production API can be accessed from the following location: https://api.cielo24.com.

Account Management

Account management is largely performed outside of the API. To set up a new production account please register for an account at http://www.cielo24.com. To request a sandbox account, email to support@cielo24.com.

Sub-Accounts

Upon request, multiple accounts may be created for you to control access or simplify billing. These accounts will be related to one another by parent-child relationships. An unlimited number of relationship levels may be created, i.e. parent, child, grandchild.

Each sub-account is a normal account with its own list of jobs and media. Access is restricted to the jobs in an account and that account’s descendants. For example, the credentials for a child account may be used to create and/or access jobs in a grandchild account, but not in a parent or sibling accounts.

For the most part, the access to the jobs of sub-accounts is transparent, as most API calls operate using a job ID. Simply login as a parent, and access jobs of the sub-account as if they belonged to the parent. However, for some API calls, such as Create Job and List Jobs, you will need to pass an additional parameter to specify the sub account you want to use.

If you are interested in using sub-accounts, please contact support@cielo24.com for more information.

Callbacks

Processing requests such as transcription are not completed immediately. As such, the interface supports the use of a callback URL that is provided by the application developer. Once the job has completed, the API calls this callback URL to inform the application that the specific job has been completed. We make a GET request to the callback URL. HTTPS and embedded basic HTTP auth URLs are supported. We will retry callbacks three times over a 30 minute period if the remote server doesn’t return a HTTP success code (200 OK.) You may wish to include a unique identifier in the URL so you can tell which request has completed, or you can request that we send additional data with the callback. See the callback_url parameter of each method for a list of the data that can be sent.

For example: http://www.yourdomain.com/cielo24/request_complete?job_id=1234

Polling

If a callback URL is not practical, the application can poll the interface by requesting the status of a given task that is associated with a given job. The task status will indicate COMPLETE when the task is done.

Languages

All non-English to non-English translation jobs have an intermediate step of English. The English transcript will be returned as well. Please contact support with any questions.

Transcription and translation are supported in the following languages for HIGH (PROFESSIONAL), STANDARD and MECHANICAL fidelity jobs (volume may vary contact support for more information):

High

Language

IETF Language Code

Supported as source

Supported as target

Arabic

ar

Chinese Mandarin (Simplified)

zh-cmn

Chinese Mandarin (Traditional)

zh-tw

Czech

cz

Danish

dk

Dutch

nl

English

en

French

fr

German

de

Greek

gr

Hebrew

he

Hindi

hi

Indonesian

id

Italian

it

Japanese

ja

Korean

ko

Malay

ms

Norwegian

no

Polish

pl

Portuguese

pt

Portuguese (Portugal)

pt-pt

Russian

ru

Spanish

es

Spanish (Spain)

es-es

Swedish

se

Turkish

tr

Ukrainian

uk

Vietnamese

vn

Standard

Language

IETF Language Code

Supported as source

Supported as target

English

en

French

fr

German

de

Spanish

es

Mechanical

Language

IETF Language Code

Supported as source

Supported as target

Afrikaans

af

Albanian

sq

Amharic

am

Arabic

ar

Armenian

hy

Azerbaijani

az

Basque

eu

Bengali

bn

Bosnian

bs

Bulgarian

bg

Burmese

my

Catalan

ca

Chinese Cantonese (Traditional)

zh-yue

Chinese Mandarin (Simplified)

zh-cmn

Chinese Mandarin (Traditional)

zh-tw

Croatian

hr

Czech

cz

Danish

dk

Dutch

nl

English

en

Estonian

et

Filipino (Tagalog)

fil

Finnish

fi

French

fr

French (Canadien)

fr-ca

Galician

gl

Georgian

ka

German

de

Greek

gr

Gujarati

gu

Hebrew

he

Hindi

hi

Hungarian

hu

Icelandic

is

Indonesian

id

Italian

it

Japanese

ja

Javanese

jv

Kannada

kn

Kazakh

kk

Khmer

km

Korean

ko

Lao

lo

Latvian

lv

Lithuanian

lt

Macedonian

mk

Malay

ms

Malayalam

ml

Marathi

mr

Mongolian

mn

Nepali

ne

Norwegian

no

Persian

fa

Polish

pl

Portuguese

pt

Portuguese (Portugal)

pt-pt

Punjabi

pa

Romanian

ro

Russian

ru

Serbian

sr

Sinhala (Sinhalese)

si

Slovak

sk

Slovenian

sl

Spanish

es

Spanish (Spain)

es-es

Sundanese

su

Swahili

sw

Swedish

se

Tagalog (Filipino)

tl

Tamil

ta

Telugu

te

Thai

th

Turkish

tr

Ukrainian

uk

Urdu

ur

Uzbek

uz

Vietnamese

vn

Xhosa

xh

Zulu

zu