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

Get mcp server registry

Parameters:

  • tenant_id: Identifier for the tenant.

Returns:

  • status.
Query
integration_nameany(Integration Name)required

Integration Name

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/mcp/servers/registry?tenant_id=test' \
  -H 'authorization: '

Responses

Successful Response

Bodyapplication/json
integration_nameIntegration Name (any)(Integration Name)
Any of:
any(Integration Name)
descriptionDescription (any)(Description)
Any of:
any(Description)
qualified_nameQualified Name (any)(Qualified Name)
Any of:
any(Qualified Name)
propertiesArray of Properties (objects) or Properties (any)(Properties)
Any of:
json_contentJson (any)(Json)
Any of:
any(Json)
Response
application/json
{ "integration_name": {}, "description": {}, "qualified_name": {}, "properties": [ { … } ], "json_content": {} }

Request

Registry mcp server

Parameters:

  • tenant_id: Identifier for the tenant.

Returns:

  • status.
Query
registry_providerany(Registry Provider)required

Accepted values for registry_provider are: smithery, custom

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
integration_nameIntegration Name (any)(Integration Name)
Any of:
any(Integration Name)
descriptionDescription (any)(Description)
Any of:
any(Description)
access_levelaccess_level (tenant, user) (any)(access_level (tenant, user))
Any of:
any(access_level (tenant, user))
qualified_nameQualified Name (any)(Qualified Name)
Any of:
any(Qualified Name)
propertiesArray of Properties (objects) or Properties (any)(Properties)
Any of:
json_contentJson (any)(Json)
Any of:
any(Json)
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/actions/mcp/servers/registry?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "integration_name": {},
    "description": {},
    "access_level": {},
    "qualified_name": {},
    "properties": [
      {
        "name": {},
        "value": {}
      }
    ],
    "json_content": {}
  }'

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

test mcp server connection

Parameters:

  • tenant_id: Identifier for the tenant.

Returns:

  • connection status.
Query
registry_providerany(Registry Provider)required

Accepted values for registry_provider are: smithery, custom

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
integration_nameIntegration Name (any)(Integration Name)
Any of:
any(Integration Name)
descriptionDescription (any)(Description)
Any of:
any(Description)
access_levelaccess_level (tenant, user) (any)(access_level (tenant, user))
Any of:
any(access_level (tenant, user))
qualified_nameQualified Name (any)(Qualified Name)
Any of:
any(Qualified Name)
propertiesArray of Properties (objects) or Properties (any)(Properties)
Any of:
json_contentJson (any)(Json)
Any of:
any(Json)
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/actions/mcp/servers/connection-test?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "integration_name": {},
    "description": {},
    "access_level": {},
    "qualified_name": {},
    "properties": [
      {
        "name": {},
        "value": {}
      }
    ],
    "json_content": {}
  }'

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": {} }
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