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
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

Request

Bodyapplication/jsonrequired
tenantIdany

Tenant ID of the user

Example: "tenant-123"
userIdany

User ID of the requester

Example: "user-456"
descriptionany

Description of the connector

Example: "This is a sample connector"
typestringnon-empty

Type of the connector

Example: "s3"
nameany

Name of the connector

Example: "My S3 Source"
configany(PlatformConfig.JsonNode)
sourceTypestringnon-empty

Source type

Example: "RELATIONAL DB"
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/sources \
  -H 'Content-Type: application/json' \
  -d '{
    "tenantId": "tenant-123",
    "userId": "user-456",
    "description": "This is a sample connector",
    "type": "s3",
    "name": "My S3 Source",
    "config": null,
    "sourceType": "RELATIONAL DB"
  }'

Responses

OK

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

SLM pairing with given knowledgebase id.

Request

Path
knowledge_base_idanyrequired
Query
tenant_idanyrequired
Bodyapplication/jsonrequired
slmMasterIdanyrequired

slm base/master model id

Example: "c72ab301-4658-4252-9f5f-aeb742bd38d9"
slmNameanyrequired

Updated name of the slm

Example: "MySlm"
slmDescriptionanyrequired

Updated description of the slm

Example: "My Updated description"
rolesArray of objectsrequired

Updated roles of the knowledgebase

Example: ["CEO"]
slmConfigany(PlatformConfig.JsonNode)required
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/slm_to_knowledgebase/{knowledge_base_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "slmMasterId": "c72ab301-4658-4252-9f5f-aeb742bd38d9",
    "slmName": "MySlm",
    "slmDescription": "My Updated description",
    "roles": [
      "CEO"
    ],
    "slmConfig": null
  }'

Responses

OK

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

Request

Query
tenant_idanyrequired
user_idanyrequired
knowledge_base_idanyrequired
offsetany(int32)
Default 0
limitany(int32)
Default 10
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/questions?offset=0&limit=10'

Responses

OK

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

Question & Answer

APIs for Question & Answering

Operations
Operations

User Management

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

Operations