Skip to content

Uniphore Business AI Cloud (1.0.0)

APIs for Uniphore Business AI platform spanning data, knowledge, models, and agents.

Metadata

KeyValue
ownerUniphore Technologies Pvt Ltd
teamBusiness AI
departmentEngineering
statusBeta
Download OpenAPI description
Languages
Servers
Demo Instance for Uniphore Business AI Cloud

https://forge-api-gateway-x-forge.dev.uniphorecloud.com/

Action Orchestrator

APIs for Actions Orchestration.

Operations

Request

Path
action_nameany(Action Name)required
Query
customer_idany(Customer Id)required

Customer Id

user_idany(User Id)required

User Id

tenant_idTenant Id (any)(Tenant Id)
Default "test"
Any of:
any(Tenant Id)
Default "test"
Headers
authorizationAuthorization (any)(Authorization)
Any of:
any(Authorization)
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/workato-actions/{action_name}?tenant_id=test' \
  -H 'authorization: '

Responses

Successful Response

Bodyapplication/json
property name*anyadditional property
Response
application/json
{ "property1": null, "property2": null }

Request

Query
user_idany(User Id)required

User Id

action_nameAction Name (any)(Action Name)

Action Name

Any of:

Action Name

any(Action Name)

Action Name

tenant_idTenant Id (any)(Tenant Id)
Default "test"
Any of:
any(Tenant Id)
Default "test"
Headers
authorizationAuthorization (any)(Authorization)
Any of:
any(Authorization)
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/actions/functions?tenant_id=test' \
  -H 'authorization: '

Responses

Successful Response

Bodyapplication/jsonArray [
property name*anyadditional property
]
Response
application/json
[ { "property1": null, "property2": null } ]

Request

Query
user_idany(User Id)required

User Id

tenant_idTenant Id (any)(Tenant Id)
Default "test"
Any of:
any(Tenant Id)
Default "test"
Headers
authorizationAuthorization (any)(Authorization)
Any of:
any(Authorization)
Bodyapplication/jsonrequired
integrationsobject(Integrations)required
integrations.​property name*Array of objectsadditional property
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/actions/functions?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "integrations": {
      "property1": [
        null
      ],
      "property2": [
        null
      ]
    }
  }'

Responses

Successful Response

Bodyapplication/jsonArray [
property name*anyadditional property
]
Response
application/json
[ { "property1": null, "property2": null } ]
Operations
Operations

Evaluation

APIs for Evaluation of models

Operations

Inferencing

Pegasus APIs for Inferencing.

Operations

Meta Prompting

APIs for Meta Prompting & Prompt Management.

Operations

Platform Config

APIs for Platform Setup - Workflows, Sources, Destinations, Knowledge Bases etc.

Operations

Question & Answer

APIs for Question & Answering

Operations
Operations

User Management

APIs for User Management - Users, Roles, Permissions etc.

Operations