Studio API Documentation

Auth

As a requirement, users must obtain a unique token and include it in the body for all API calls. Tokens expire every 15 minutes.

Method: Get Token

DetailsValue
API URLhttps://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/auth/get-token/
HTTP MethodPOST
MethodGet Token
Authentication MethodDigest
Username (Email)youraccount@email.com
Password (Secret Key)9711f25f4f46bc88
Digest Auth DetailsValue
RealmPlease enter your email and secret_key.
Nonce1
AlgorithmMD5
qopauth
Nonce count1
Client Nonce12345
OpaqueLeave blank

Parameters

KeyRequired?Value
apikeyREQUIREDExample: 122d5c44649cce93e24be0990c039c8b
formatOPTIONALIf you do not specify a format in your request, then you receive a JSON payload. To receive a response in JSON format, set json in the value.
Example Value:
* XML
* JSON

Response - Success

Response Code
CodeDescription
200The Token will be returned. The Token is required for all other api requests.

Example Value: b4b25010795cf8507543f739739678bdd54c6262

Note: the token will be expired after 15 minutes

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_API_KEY
* INVALID_FORMAT
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Script

Method: List All

DetailsValue
API URLhttps://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/script/list-all/
HTTP MethodPOST
Parameters
KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
formatOPTIONALjson or xml
typeOPTIONALIVRSMSWORKFLOWALL

Default type is IVR

If you do not specify a format in your request, then you receive a JSON payload. To receive a response in JSON format, set format=json in the parameter body.

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Method: List One

DetailsValue
API URLhttps://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/script/list-one/
HTTP MethodPOST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_SCRIPT_ID
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Prompt

Method: List All

DetailsValue
API URLhttps://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/prompt/list-all/
HTTP MethodPOST
KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_SCRIPT_ID
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Method: List One

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/prompt/list-one/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
prompt_idOPTIONALPrompt ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_SCRIPT_ID
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Method: Update TTS

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/prompt/update-tts/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
prompt_idREQUIREDPrompt ID
tts_voice_idREQUIREDTTS Voice ID
prompt_ttsREQUIREDPROMPT TTS Value
formatOPTIONALjson or xml

Default format is json

Example Value:

*XML
* JSON

Response - Success

CodeDescription
200OK
Response - Error
CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_SCRIPT_ID
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

*NOT_AVAILABLE

Method: Update Audio

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/prompt/update-audio/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
prompt_idREQUIREDPrompt ID
tts_voice_idREQUIREDTTS Voice ID
audio_fileREQUIREDthe audio file to be uploaded
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_SCRIPT_ID
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Method: Get Audio File

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/prompt/get-audio-file/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
audio_fileREQUIREDthe audio file to be uploaded
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Variable

Method: List All

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/variable/list-all/

HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_SCRIPT_ID
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Method: List One

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/variable/list-one/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
variable_idREQUIREDvariable ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_SCRIPT_ID
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Method: Update Value

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/variable/update-value/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
variable_idREQUIREDVariable ID
valueREQUIREDValue
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_SCRIPT_ID
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Snapshot

Method: List All

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/snapshot/list-all/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Method: List One

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/snapshot/list-one/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
snapshot_idREQUIREDsnapshot ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Method: Export Image

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/snapshot/export-image/
HTTP Method: POST
Parameters
KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
snapshot_idREQUIREDsnapshot ID
script_idREQUIREDscript ID
widthOPTIONALwidth of image
heightOPTIONALheight of image
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_SCRIPT_ID
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Call Log

Method: List All

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/log/list-all/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_SCRIPT_ID
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Datastore

Before interacting with a Datastore via API, please ensure that your datastore is web configurable in Studio. Interacting with Datastores via API that are not set to Web Configurable will return 400 errors.

This can be done under Studio Home > Settings > Web Configurator :

  • Select any task by clicking the 'Select' button which wil take you to the Configuration Dashboard
  • From there, under the Datastores banner, click on View Details and set your datastore to Configurable = Yes as required

Method: List All

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/list-all/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* NVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 400

Error Code

* NO_DATA

Method: List One

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/list-one/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 400

Error Code

* NO_DATA

Method: List All Rows

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/list-all-rows/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 400

Error Code

* NO_DATA

Method: List One Row

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/list-one-row/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
datatstore_idREQUIREDdatastore ID
data_idREQUIREDdata ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 400

Error Code

* NO_DATA

Method: List Date Range

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/list-date-range/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
start_dateREQUIREDStart date in the format of "yyyy-mm-dd H:m:s"
end_dateREQUIREDEnd date in the format of "yyyy-mm-dd H:m:s"
formatOPTIONALjson or xml

Default format is json

Example Value:

*XML
*JSON

Response - Success

CodeDescription
200OK
Response - Error
CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 400

Error Code

* NO_DATA

Method: Add Row

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/add-row/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
dataREQUIREDData, Array of data to be inserted, e.g. data[column_name]="value", data[audio_column_name]="value"
formatOPTIONALjson or xml

If you do not specify a format in your request, then you receive a JSON payload. To receive a response in JSON format, use the JSON in the value.

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 400

Error Code

* NO_DATA

Method: Delete Row

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/delete-row/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDData ID
formatOPTIONALjson or xml

If you do not specify a format in your request, then you receive a JSON payload. To receive a response in JSON format, use the JSON in the value.

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 400

Error Code

NO_DATA

Method: Delete Row Range

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/delete-row-range/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idsREQUIREDData ids, Array of data to be inserted, e.g. data_ids[data_id]. Please note this is limited to 100 rows
formatOPTIONALjson or xml

If you do not specify a format in your request, then you receive a JSON payload. To receive a response in JSON format, use the JSON in the value.

Example Value:

*XML
*JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
CodeDescription

| 401 | UNAUTHORIZED| Error Code

* UNAUTHORIZED
Response Code 400

Error Code

* NO_DATA

Method: Update Value

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/update-value/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDData ID
column_nameREQUIREDColumn Name
column_valueREQUIREDColumn Value
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 400

Error Code

* NO_DATA

Method: Get Value

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/get-value/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDData ID
column_nameREQUIREDColumn Name
column_valueREQUIREDColumn Value
formatOPTIONALjson or xml

Default format is json

Example Value:

XML
JSON
Response - Success
CodeDescription
200OK
Response - Error
CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 400

Error Code

* NO_DATA

Method: Upload Audio

##### API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/upload-audio/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDData ID
column_nameREQUIREDColumn Name
audio_fileREQUIREDthe audio file to be uploaded
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 400

Error Code

* NO_DATA

Method: Delete Audio

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/delete-audio/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDData ID
column_nameREQUIREDColumn Name
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK
Response - Error
CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 400

Error Code

* NO_DATA

Method: Get Audio File

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/datastore/get-audio-file/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDData ID
column_nameREQUIREDColumn Name
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 400

Error Code

* NO_DATA

Workflow

Method: Run

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/workflow/run/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
workflow_idREQUIREDworkflow ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON
passed_parameters OPTIONAL These are the variables created in the workflow script as Passed ### Parameters. All passed ### Parameters are to be listed separately as key value pairs.

Example Value:

* customer_name=John
* employee_number=1234

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_SCRIPT_ID
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 503

Error Code

* NOT_AVAILABLE

Method: Update Workflow

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/workflow/update/
HTTP Method POST
Description You can either do a full or partial update by sending the below ### Parameters as needed.

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
workflow_idREQUIREDWorkflow ID
nameOPTIONALName of workflow
statusOPTIONALThe status of the workflow
formatOPTIONALjson or xml

Supported values:

* active
* inactive
format OPTIONAL Default format isjson``

Example Value:

* XML
* JSON

Response - Success

Response Code Content 200

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_SCRIPT_ID
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 503

Error Code

* NOT_AVAILABLE

Formtype

Method: List All

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/formtype/list-all/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 503

Error Code

* NOT_AVAILABLE

Method: List One

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/formtype/list-one/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
formtype_idREQUIREDformtype ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 503

Error Code

* NOT_AVAILABLE

Method: List All Rows

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/formtype/list-all-rows/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
formtype_idREQUIREDformtype ID
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
Response Code 503

Error Code

* NOT_AVAILABLE

Method: List One Row

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/formtype/list-one-row/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
formtype_idREQUIREDformtype ID
dtmfREQUIREDDTMF Value
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

* NOT_AVAILABLE

Method: Update Value

API URL https://usstudio.inferencecommunications.com/studio_instance/studio-api/v1/formtype/update-row/
HTTP Method POST

Parameters

KeyRequired?Value
TokenREQUIREDUse API auth/get-token to get the token
formtype_idREQUIREDformtype ID
dtmfREQUIREDDTMF Value
column_nameREQUIREDColumn Name
column_valueREQUIREDColumn Value
formatOPTIONALjson or xml

Default format is json

Example Value:

* XML
* JSON

Response - Success

CodeDescription
200OK

Response - Error

CodeDescription
400ERROR

Error Code

* INVALID_HTTP_METHOD
* INVALID_FORMAT
* INVALID_TOKEN
* INVALID_VALUE
CodeDescription
401UNAUTHORIZED

Error Code

* UNAUTHORIZED
CodeDescription
503NOT_AVAILABLE

Error Code

*NOT_AVAILABLE