Skip to content
API Reference
/
/
Gets destination connecto...

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
api.json
api.yaml
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

Agents

APIs for Agents.

Operations

Darwin

APIs for Darwin.

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

Updates knowledgebase name and description

Request

Path
knowledge_base_idanyrequired
Query
tenant_idanyrequired
Bodyapplication/jsonrequired
nameany

Updated name of the knowledgeBase

Example: "MySlm"
descriptionany

Updated description of the knowledgeBase

Example: "My Updated description"
rolesArray of objects

Updated roles

Example: "[CEO]"
ragPromptany

Document RAG propmpt

Example: "you are an intelligent assistant..."
curl -i -X PUT \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/knowledge_bases/{knowledge_base_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "MySlm",
    "description": "My Updated description",
    "roles": "[CEO]",
    "ragPrompt": "you are an intelligent assistant..."
  }'

Responses

OK

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

Gets destination connector for a tenantId by id.

Request

Path
destinationIdanyrequired
Query
tenant_idanyrequired
include_secretsany
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/destinations/{destinationId}'

Responses

OK

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

Updates the destination connector for the given id.

Request

Path
destinationIdanyrequired
Bodyapplication/jsonrequired
connectorIdstringnon-empty

Connector ID to update

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
tenantIdstringnon-empty

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 an updated sample connector"
nameany

Updated name of the connector

Example: "Updated S3 Source"
typeany

Updated type of the connector

Example: "s3"
configany(PlatformConfig.JsonNode)
curl -i -X PUT \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/destinations/{destinationId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "connectorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantId": "tenant-123",
    "userId": "user-456",
    "description": "This is an updated sample connector",
    "name": "Updated S3 Source",
    "type": "s3",
    "config": null
  }'

Responses

OK

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

Question & Answer

APIs for Question & Answering

Operations

Tag

APIs for Tag.

Operations

User Management

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

Operations