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

save action

Parameters:

  • tenant_id: Identifier for the tenant.

Returns:

  • status.
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
nameName (any)(Name)
Any of:
any(Name)
descriptionDescription (any)(Description)
Any of:
any(Description)
integration_idIntegration Id (any)(Integration Id)
Any of:
any(Integration Id)
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/actions?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "name": {},
    "description": {},
    "integration_id": {}
  }'

Responses

Successful Response

Bodyapplication/json
statusStatus (any)(Status)
Any of:
any(Status)
idId (any)(Id)
Any of:
any(Id)
messageMessage (any)(Message)
Any of:
any(Message)
connectedConnected (any)(Connected)
Any of:
any(Connected)
Response
application/json
{ "status": {}, "id": {}, "message": {}, "connected": {} }

Request

Retrieve a Actions count.

Parameters:

  • tenant_id: Identifier for the tenant.

Returns:

  • A Actions count matching the criteria.
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)
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/actions/count?tenant_id=test' \
  -H 'authorization: '

Responses

Successful Response

Bodyapplication/json
countany(Count)required
Response
application/json
{ "count": null }

Request

Test Mcp Registry Connection

Parameters:

  • tenant_id: Identifier for the tenant.

Returns:

  • status.
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
registry_urlRegistry Url (any)(Registry Url)
Any of:
any(Registry Url)
api_keyApi Key (any)(Api Key)
Any of:
any(Api Key)
connectedConnected (any)(Connected)
Any of:
any(Connected)
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/actions/mcp/servers/registry/connection-test?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "registry_url": {},
    "api_key": {},
    "connected": {}
  }'

Responses

Successful Response

Bodyapplication/json
registry_urlRegistry Url (any)(Registry Url)
Any of:
any(Registry Url)
api_keyApi Key (any)(Api Key)
Any of:
any(Api Key)
connectedConnected (any)(Connected)
Any of:
any(Connected)
Response
application/json
{ "registry_url": {}, "api_key": {}, "connected": {} }
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