Applications

Get App

GET	{{baseUrl}}/orchestrator/api/apps/<app_id>/	Returns the App by `app_id`.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The application id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 200 OK

Returns the App.

Example

JSON

{
    "name": "my_app",
    "canvas_id": "8101c262-be18-40c7-a85a-78b47dcdf80d"
}

Response (Failed)

JSON

HTTP/1.1 404 NOT_FOUND

Get App Status

GET	{{baseUrl}}/orchestrator/api/apps/<app_id>/status/	Gets the status of the App.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 200 OK

Example

JSON

{
    "status": "started/stopped/not-deployed"
}

Parameter	Type	Description
`status`	string	The application status.

Response (Failed)

JSON

HTTP/1.1 404 NOT_FOUND

Get App MiniApps

GET	{{baseUrl}}/orchestrator/api/apps/<app_id>/miniapps/?detail=&type=	Get the list of miniApps used by this application, including all of its flows.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Query Parameters

Name	Type	Description	Example
`detail`	boolean	Applicable if extra details about the miniApps should be included. False by default.	true
`type`	string	miniApp type used as filter.	"Banking", "Numeric", "Intent"

Response (Success)

JSON

HTTP/1.1 200 OK

Returns a list of miniApp ids by default. More details can be returned with the detail query parameter.

Example 1

{{baseUrl}}/orchestrator/api/apps/<app_id>/miniapps/

JSON

[
    "b759a24f-6afa-4bcf-b213-257ee6037175.ia_orc_intent.Banking.MiniApps.orc",
    "b759a24f-6afa-4bcf-b213-257ee6037175.ia_orc_announcement_2.Announcement.MiniApps.orc",
    "4d5195f9-ce70-488c-bb3c-f67bc567521f.dt_orc_ann_info_yes.Announcement.MiniApps.orc"
]

Example 2

{{baseUrl}}/orchestrator/api/apps/<app_id>/miniapps/?detail=true

JSON

[
    {
      "id": "b759a24f-6afa-4bcf-b213-257ee6037175.ia_orc_intent.Banking.MiniApps.orc",
      "name": "ia_orc_intent",
      "type": "Banking"
    },
    {
      "id": "b759a24f-6afa-4bcf-b213-257ee6037175.ia_orc_announcement_2.Announcement.MiniApps.orc",
      "name": "ia_orc_intent",
      "type": "Announcement"
    }
]

Get App Flows

GET	{{baseUrl}}/orchestrator/api/apps/<app_id>/flows/	Get the list of Flows used by this app.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 200 OK

Returns the list of Flows.

Example

JSON

[
    {
        "id": "660f41a1-75e2-4c29-bdde-a90ab529b30d",
        "version": "0.0.2",
        "component_id": "88ed36b3-4e0c-4b5b-b9be-c733b3c5f21f.orc_export_test_flow.Flows.orc.ktselepakis",
        "created_at": "2022-02-17T15:02:01.509054Z",
        "updated_at": "2022-04-15T09:31:47.631558Z",
        "production_flowapp_id": "88ed36b3-4e0c-4b5b-b9be-c733b3c5f21f.PRD_orc_export_test_flow.Flow.ktselepakis@PRD_orc_export_test_flow.ktselepakis",
        "sandbox_flowapp_id": "88ed36b3-4e0c-4b5b-b9be-c733b3c5f21f.SND_orc_export_test_flow.Flow.ktselepakis@SND_orc_export_test_flow.ktselepakis",
        "user_id": "88ed36b3-4e0c-4b5b-b9be-c733b3c5f21f",
        "group": "ktselepakis",
        "name": "orc_export_test_flow",
        "input_fields": [
            "foo"
        ],
        "output_fields": [
            "bar"
        ],
        "canvas": "a8a9791f-205c-4995-bf20-1be2e860dc4a"
    }
]

Response (Failed)

JSON

HTTP/1.1 404 NOT_FOUND

Create App

POST	{{baseUrl}}/orchestrator/api/apps/	Creates an App.

Click to see the details

Name	Type	Description	Example
`name`	string	-	The application name

Example

JSON

{
    "name": "my_app"
}

Response (Success)

JSON

HTTP/1.1 201 CREATED

The created App.

Example

JSON

{
    "name": "my_app",
    "canvas_id": "8101c262-be18-40c7-a85a-78b47dcdf80d"
}

Response (Failed)

JSON

HTTP/1.1 404 NOT_FOUND

Response (Failed)

JSON

HTTP/1.1 400 BAD_REQUEST

The failed status 400 BAD_REQUEST can be returned if the app name contains invalid characters (acceptable app name characters are only alphanumeric [a-Z0-9] and the underscore character '_').

Example

JSON

{
    "name": [
        "Invalid app name. App name must contain only alphanumeric characters and the underscore character."
    ]
}

Delete App

DELETE	{{baseUrl}}/orchestrator/api/apps/<app_id>/	Deletes the app by its `app_id`.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 204 NO_CONTENT

Response (Failed)

JSON

HTTP/1.1 404 NOT_FOUND

Deploy App (Changes Only / All)

POST	{{baseUrl}}/orchestrator/api/apps/<app_id>/deploy/?all=true	Deploys the app (changes only/all).

This request compiles the Orchestrator App, creates a relative DiaManT App (if there is none), uploads a DiaManT App configuration, makes the deployment and starts the application.

Any moved node on canvas is considered a change.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Query Parameters

Name	Type	Description	Example
`all`	boolean	If this parameter set to true, then the application is re-deployed.	true

Response (Success)

JSON

HTTP/1.1 200 OK

The deployment results.

Example 1

{{baseUrl}}/orchestrator/api/apps/<app_id>/deploy/?all=true

JSON

{
    "detail": "The application has been deployed and start and running successfully."
}

Example 2

{{baseUrl}}/orchestrator/api/apps/<app_id>/deploy/

JSON

{
    "detail": "The application has been deployed and start and running successfully."
}

Response (Failed)

JSON

HTTP/1.1 400 BAD_REQUEST

The failed status 400 BAD_REQUEST can be returned if something went wrong with the app deployment. Usually, there was a canvas warning.

Example

JSON

{
    "detail": "Your App can not be deployed because it contains problems: Multiple roots found on the graph.",
    "errors": [
        {
            "canvas_id": "1ebbcc51-19a2-47cb-bba9-0bc6164a94cb",
            "node_errors": [
                {
                    "node_id": "1",
                    "errors": [
                        {
                            "type": "WARNING",
                            "code": "MULTIPLE_ROOTS_FOUND",
                            "message": "Multiple roots found on the graph.",
                        }
                    ]
                },
                {
                    "node_id": "2",
                    "errors": [
                        {
                            "type": "WARNING",
                            "code": "MULTIPLE_ROOTS_FOUND",
                            "message": "Multiple roots found on the graph.",
                        }
                    ]
                }
            ]
        }
    ]
}

Get Web Chat Info

Help start a chat simulation with an App by providing useful web chat related info.

GET	{{baseUrl}}/orchestrator/api/apps/<app_id>/web_chat/	Helps start a chat simulation with an app by providing useful web chat related info.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 200 OK

Returns web-chat related info.

Parameter	Type	Description
`chat_url`	string	The URL linked to the chat connector web socket.
`deployed_token`	string	The access token for the deployed application.
`live_token`	string	The access token for the simulator application.

Example

JSON

{
    "chat_url": "wss://lab.miniapps.ocp.ai/chat/ws/dialogs",
    "deployed_token": "435f6ea2f72df13732c29414a0446a9e11d7fd46412bfe1c3fc1961736d8ff71467623cb64532352",
    "live_token": "1c58b47ae31fb9e8a8b89b4e201f821d3ac5983492619fe8f740dd2404010c6134673c6869fe64ae"
}

Get App's Attached Data

GET	{{baseUrl}}/orchestrator/api/apps/<app_id>/attached_data/	Gets the application's attached data.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 200 OK

Returns the app's attached data (key/value pairs).

Example

JSON

{
    "ad_key_1": "ad_value_1",
    "ad_key_2": "ad_value_2",
    "ad_key_3": "ad_value_3"
}

Update App's Attached Data

PUT	{{baseUrl}}/orchestrator/api/apps/<app_id>/attached_data/	Updates the application's attached data.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 200 OK

Returns the updated app's attached data (key/value pairs).

Example

JSON

{
    "ad_key_1": "ad_value_1",
    "ad_key_2": "ad_value_2",
    "ad_key_3": "ad_value_3"
}

Get App's Fail Sources

GET	{{baseUrl}}/orchestrator/api/apps/<app_id>/fail_sources/	Returns the App's list of Fail Sources that can be used as fail sources for Error Handlers.

Click to see the details

Fail Sources contain a display_name and a fail_source_path:

display_name is more user-friendly and is meant for users to read;
fail_source_path is the actual value that needs to be used when setting an ErrorSource for an Error.

URL Parameters

Name	Type	Description	Example
app_id	uuid	the app's id	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 200 OK

Returns the list of App's fail sources.

Parameter	Type	Description	Example
`display_name`	string	Fail source's name to display.	"ia_iandronis_intent_1"
`fail_source_path`	string	Fail source's path.	"0e694182-1cec-406d-83ce-46cdf9d56b1c.ia_iandronis_intent_1.Banking.MiniApps.iandronis"

Example

JSON

[
  {
    "display_name": "ia_iandronis_intent_1",
    "fail_source_path": "0e694182-1cec-406d-83ce-46cdf9d56b1c.ia_iandronis_intent_1.Banking.MiniApps.iandronis"
  },
  {
    "display_name": "ia_iandronis_announcement_1",
    "fail_source_path": "0e694182-1cec-406d-83ce-46cdf9d56b1c.ia_iandronis_announcement_1.Announcement.MiniApps.iandronis"
  },
  {
    "display_name": "ia_local_lab_flow_1.ia_iandronis_intent_1",
    "fail_source_path": "0e694182-1cec-406d-83ce-46cdf9d56b1c.ia_local_lab_flow_1.Flows.orc.iandronis::0e694182-1cec-406d-83ce-46cdf9d56b1c.ia_iandronis_intent_1.Banking.MiniApps.iandronis"
  },
  {
    "display_name": "ia_local_lab_flow_1.ia_iandronis_announcement_2",
    "fail_source_path": "0e694182-1cec-406d-83ce-46cdf9d56b1c.ia_local_lab_flow_1.Flows.orc.iandronis::0e694182-1cec-406d-83ce-46cdf9d56b1c.ia_iandronis_announcement_2.Announcement.MiniApps.iandronis"
  }
]

Response (Failed)

JSON

HTTP/1.1 400 BAD_REQUEST

The failed status 400 BAD_REQUEST can be returned if there was a cycle reference inside the app (probably by some flows).

Example

JSON

{
  "detail": "Found cycle use of a Flow in the application (use trace: ['test_user_id.my_app.Flows.orc.group', 'test_user_id.my_flow_lvl_1.Flows.orc.group', 'test_user_id.my_flow_lvl_2.Flows.orc.group'] -> test_user_id.my_flow_lvl_1.Flows.orc.group)."
}

Get App's Export

GET	{{baseUrl}}/orchestrator/api/apps/<app_id>/export/	Exports the application and all the related flows in a ZIP file.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 200 OK

Returns the app's export file.

Response (Failed)

JSON

HTTP/1.1 404 NOT_FOUND

Get Available Voice Biometric (VB) Profiles

GET	{{baseUrl}}/orchestrator/api/voice-biometric/profiles/	Gets the available Voice Biometric (VB) Profiles.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 200 OK

Returns the list of Voice Biometric Profiles.

Example

JSON

[
    {
        "profile_id": "DEF",
        "name": "Default",
        "bio_keys": [
            {
                "id": 1,
                "key": "userID",
                "display_name": "userID"
            },
            {
                "id": 168,
                "key": "Ani",
                "display_name": "Ani"
            }
        ]
    },
    {
        "profile_id": "XLh0g6d0",
        "name": "test",
        "bio_keys": [
            {
                "id": 276,
                "key": "user_id",
                "display_name": "user_id"
            },
            {
                "id": 277,
                "key": "Ani",
                "display_name": "Ani"
            }
        ]
    }
]

Get App's Voice Biometric Profile

GET	{{baseUrl}}/orchestrator/api/apps/<app_id>/voice-biometric/	Gets the App's Voice Biometric Profile.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Response (Success)

JSON

HTTP/1.1 200 OK

Returns the App Biometric Profile.

Example

JSON

{
    "profile_id": "DEF",
    "field_mappings": [
        {
          "bio_key": "Ani",
          "orc_field": "Ani"
        },
        {
          "bio_key": "userID",
          "orc_field": "Dnis"
        }
    ]
}

Update App's Voice Biometric Profile

PUT	{{baseUrl}}/orchestrator/api/apps/<app_id>/voice-biometric/	Updates the App's Voice Biometric Profile.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Request payload

The App Voice Biometric Profile variables.

Response (Success)

JSON

HTTP/1.1 200 OK

Returns the updated App Voice Biometric Profile.

Example

JSON

{
    "profile_id": "DEF",
    "field_mappings": [
        {
          "bio_key": "Ani",
          "orc_field": "Ani"
        },
        {
          "bio_key": "userID",
          "orc_field": "Dnis"
        }
    ]
}

Unset App's Voice Biometric Profile

PUT	{{baseUrl}}/orchestrator/api/apps/<app_id>/voice-biometric/	Sends update request with empty `profile_id` value to remove the connection between VB profile keys and Orchestrator fields.

Click to see the details

URL Parameters

Name	Type	Description	Example
`app_id`	uuid	The app's id.	"9b399774-3a0a-40c1-8a1c-4a124170b6f3"

Request payload

The app Voice Biometric Profile variables.

Response (Success)

JSON

HTTP/1.1 200 OK

The updated App Voice Biometric Profile.

Example

JSON

{
    "profile_id": "",
    "field_mappings": []
}

Models

Voice Biometric Profile

Click to see the details

Name	Type	Description
`profile_id`	string	The profile's id.
`name`	string	The profile's name.
`bio_keys`	array[dict]	The profile's bio keys.

Example

JSON

{
    "profile_id": "DEF",
    "name": "Default",
    "bio_keys": [
        {
            "id": 1,
            "key": "userID",
            "display_name": "userID"
        },
        {
            "id": 168,
            "key": "Ani",
            "display_name": "Ani"
        }
    ]
}

App Voice Biometric Profile

Click to see the details

Name	Type	Description
`profile_id`	string	The Voice Biometrics profile's id.
`field_mappings`	array[dict]	Mapping of Orchestrator Application field (key) to Voice Biometrics bio_key id (value).

Example

JSON

{
    "profile_id": "DEF",
    "field_mappings": [
        {
          "bio_key": "Ani",
          "orc_field": "Ani"
        },
        {
          "bio_key": "userID",
          "orc_field": "Dnis"
        }
    ]
}