DEVNAGRI

# Devnagri Platform APIs

# API JSON Order: Create

# Request

curl --location --request POST 'https://app.devnagri.com/api/order/json' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "api_key": "recgdgstaDKtVpMIJQ",
    "project_name": "Sample Project Name",
    "industry": "sports",
    "source_language": "en",
    "target_language": [
        "hi",
        "bn",
        "gu"
    ],
     "segmentation": true,
        "data": [
        {
            "test-123": "Hello World",
            "test-456": "How are you?"
        }
    ]
}'

# Response

SUCCESS

status code: 200

{
    "status": "success",
    "code": 200,
    "message": "Order placed successfully.",
    "order_id": "DEV00420"
}
NOTES
  1. This API is responsible to create order without platform interface using a secret API key.
  2. After getting success response from the API, the user can then login to the platform (opens new window), and see the order.
  3. In the JSON data (key-value pairs), the keys will be ignored and not be processed for the translation. JSON_Req

# Request Parameters

Key Value Description
api_key SECRET_API_KEY_XXXXX The key will be provided by the Devnagri and can be found at Usage Details (opens new window)
project_name My Sample Order Name of the order
industry sports Type of industry/domain the order belongs to. Use "Industry Name" from here.
source_language en Language of the order which needs to be translated from. This will be a single value. Ref.
target_language [hi, bn] Language of the order which needs to be translated to. This will be inside an array, can contain more than one language. Ref.
segmentation true It's an optional field if user feel their sentences are too long, they can opt for this
data Your JSON data A valid JSON object

# API JSON Order: Fetch

# Request

curl --location --request POST 'https://app.devnagri.com/api/order/json-response' \
--header 'Content-Type: application/json' \
--data-raw '{
    "api_key": "recgdgstaDKtVpMIJQ",
    "order_id": "DEV04200"
}'

# Response

SUCCESS

status code: 200

{
    "status": "success",
    "code": 200,
    "data": [
        {
            "id": "Thank you. Hi. I'd like to go to the Adelphi Hotel.",
            "hi": "धन्यवाद। हाय। मैं एडलफी होटल में जाना चाहता हूं।"
        },
        {
            "id": "Excuse me. - I'm sorry. This is my cab.",
            "hi": "माफ कीजिएगा। -मैं माफी चाहता हूं। यह मेरी कैब है।"
        }
    ]
}

# Response (When translation is not completed)

SUCCESS

status code: 200

{
    "status": "success",
    "code": 200,
    "data": [],
    "message": "Translation not completed."
}

# Request Parameters

Key Value Description
api_key SECRET_API_KEY_XXXXX The key will be provided by the Devnagri and can be found at Usage Details (opens new window)
order_id DEV04200 Unique Order Code

# Request (V2)

curl --request POST \
  --url https://app.devnagri.com/api/order/json-response \
  --header 'Content-Type: application/json' \
  --data '{
    "api_key": "recgdgstaDKtVpMIJQ",
    "order_id": "D15303",
    "version": "v2"
}'

# Response

SUCCESS

status code: 200

{
   "status": "success",
    "code": 200,
    "data": {
        "hi": [
            {
                "test-123": "हैलो वर्ल्ड",
                "test-456": "कैसे हैं आप?"
            }
        ],
        "bn": [
            {
                "test-123": "হ্যালো ওয়ার্ল্ড",                
                "test-456": "কেমন আছ?"
            }
        ],
        "gu": [
            {
                "test-123": "હેલો વર્લ્ડ",
                "test-456": "તમે કેવી રીતે છો?"
            }
        ],
        "en": [
            {
                "test-123": "Hello World",
                "test-456": "How are you?"
            }
        ]
    }
}

# Response (When translation is not completed)

SUCCESS

status code: 200

{
    "status": "success",
    "code": 200,
    "data": [],
    "message": "Translation not completed."
}

# Request Parameters

Key Value Description
api_key SECRET_API_KEY_XXXXX The key will be provided by the Devnagri and can be found at Usage Details (opens new window)
order_id DEV04200 Unique Order Code
version v2

# API JSON Order: Reject

This API is responsible to reject the translation for the given sentences in an ongoing order.

# Request

curl --location 'https://app.devnagri.com/api/order/json/reject' \
--header 'Content-Type: application/json' \
--data '{
  "api_key": "fhdjsjfjfjdjdl",
  "order_code": "D18046",
  "data": {
      "hi": [
        "Hello World",
        "How are you?"
      ],
      "bn": [
        "Hello World"
      ],
      "gu":[
        "Hello World"
      ]
  },
  "comment": "Please transliterate. Do not translate."
}'

Note: The comment will apply to these sentences only. Please make sure to choose correct translation.

# Response

SUCCESS

status code: 200

{
    "status": "success",
    "code": 200,
    "message": "Order DEV04200 has been sent back for review."
}

# Request parameters

Key Sample value Description
api_key recgdgstaDKtVpMIJQ Unique key assigned to user for the API usage
order_code DEV04200 Order Code
data {"lang_1": ["sentence_1", "sentence_2"], "lang_2": [...], ...} A single sentence or an array of sentences inside language code as key
comment {Your comment for rejection} This is an optional field

# Translation API

This API is responsible for returning translation for the input sentence.

POST: https://app.devnagri.com/api/translate-sentence-api

# Request

curl --location --request POST 'https://app.devnagri.com/api/translate-sentence-api' \
--form 'key="recgdgstaDKtVpMIJQ"' \
--form 'sentence="Hello Devnagri"' \
--form 'src_lang="en"'
--form 'dest_lang="hi"' \

# Response

SUCCESS

status code: 200

{
    "translated_text": "हैलो देवनागरी"
}

# Request parameters

The request requires input in the form data

Key Sample value Description
key recgdgstaDKtVpMIJQ Unique key assigned to user for the API usage
sentence Hello Devnagri Input text to be translated
src_lang en Source language code. Ref.
dest_lang hi Destination language code. Ref.

# Invalid API Key

SUCCESS

status code: 203
error code: 203

{
    "code": 203,
    "msg": {
        "key": [
            "Invalid key"
        ]
    }
}

# Request validation

SUCCESS

status code: 203
error code: 203

{
    "code": 203,
    "msg": {
        "dest_lang": [
            "The dest lang and src lang must be different."
        ]
    }
}

# Transaction limits reached

SUCCESS

status code: 206
error code: 206

{
    "code": 206,
    "msg": {
        "key": [
            "Your transaction limit has been exceeded. Please contact devnagri support."
        ]
    }
}

# Transliteration API

This API is responsible for returning transliteration for the input sentence.

POST: https://app.devnagri.com/api/transliterate

# Request

curl --location --request POST 'https://app.devnagri.com/api/transliterate' \
--form 'input_text="namaste"' \
--form 'src_lang="en"' \
--form 'dest_lang="ml"' \
--form 'key="recgdgstaDKtVpMIJQ"'

# Response

SUCCESS

status code: 200

{
    "code": 200,
    "result": "നാമസ്റ് റ്"
}

# Request parameters

The request requires input in the form data

Key Sample value Description
input_text namaste Input text
src_lang en language code. Ref.
dest_lang bn language code. Ref.
key recgdgstaDKtVpMIJQ Unique key assigned to user for the API usage

# Invalid API Key

SUCCESS

status code: 203
error code: 203

{
    "code": 203,
    "msg": {
        "key": [
            "Invalid key"
        ]
    }
}

# Request validation

SUCCESS

status code: 203
error code: 203

{
    "code": 203,
    "msg": {
        "dest_lang": [
            "The dest lang and src lang must be different."
        ]
    }
}

# Transaction limits reached

SUCCESS

status code: 206
error code: 206

{
    "code": 206,
    "msg": {
        "key": [
            "Your transaction limit has been exceeded. Please contact devnagri support."
        ]
    }
}

# Transliteration API: Custom

This API is responsible for returning custom transliteration for the input file. Text between square brackets[] will only be transliterated and rest of them will be ignored.

POST: https://app.devnagri.com/api/transliterate-custom

# Request

curl --location --request POST 'https://app.devnagri.com/api/transliterate-custom' \
--form 'file=@"/C:/Users/kumar/SampleLyrics.en.txt"' \
--form 'src_lang="auto"' \
--form 'dest_lang="hi"' \
--form 'key="recgdgstaDKtVpMIJQ"'

# Source file content

Exclusive Upload for StarManch
Aake Teri Baahon Mein
Lyrics: Sameer

[00:04.67]Song: Aake Teri Baahon Mein [End]
[start][undefined][undefined]
[00:07.18]Lyrics: Sameer [End]
[start][undefined][undefined]
[00:09.68]Music: Anand Milind [End]

# Response

SUCCESS

status code: 200

Exclusive Upload for StarManch
Aake Teri Baahon Mein
Lyrics: Sameer

[00:04.67] সং: আঁকে টেরি বাহন মেইন [End]
[start][undefined][undefined]
[00:07.18] লিরিক্স: সমীর [End]
[start][undefined][undefined]
[00:09.68] মিউজিক: আনন্দ মিলিন্দ [End]

# Request parameters

The request requires input in the form data

Key Sample value Description
file "/C:/Users/kumar/SampleLyrics.en.txt" Ref Source File
src_lang auto This is an optional field, and can be set to "auto". This will detect the language of the input_text. language code. Ref.
dest_lang ml language code. Ref.
key recgdgstaDKtVpMIJQ Unique key assigned to user for the API usage

← Voice Translation APIs →