Skip to content
API Reference
/
/
questions

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

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
}

questions

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
}

Ask a Question

Request

Bodyapplication/jsonrequired
tenantIdstringnon-empty

Tenant ID of the user

Example: "tenant-123"
userIdstringnon-empty

User ID of the requester

Example: "user-456"
questionstringnon-empty

User query to be answered

Example: "How do I reset my password?"
knowledgeBaseIdstringnon-empty

KnowledgeBase Identifier

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

Document RAG system prompy

Example: "you are intelliget system prompt...."
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/questions \
  -H 'Content-Type: application/json' \
  -d '{
    "tenantId": "tenant-123",
    "userId": "user-456",
    "question": "How do I reset my password?",
    "knowledgeBaseId": "c72ab301-4658-4252-9f5f-aeb742bd38d9",
    "ragPrompt": "you are intelliget system prompt...."
  }'

Responses

OK

Bodyapplication/json
questionIdany

Unique identifier for the question

Example: "4d649cd3-54b8-4295-8dd7-23da0f913de4"
answerany

Generated answer from the RAG system

Example: "To reset your password, go to Settings > Security > Reset Password."
chartableany

whether genearatred answer has chart available or not

Example: true
chartany

chart data

Example: "iVBORw0KGgoAAAANSUhEUgAAC7gAAAcICAYAAACsf4x4AAAAOnRFWHRTb2Z0d2FyZQBNYXRwbG90bGliIHZlcnNpb24zLjEwLjMsIGh0dHBzOi8vbWF0cGxvdGxpYi5vcmcvZiW"
contextArray of objects(PlatformConfig.DocumentContext)

List of document chunks that formed the context for the answer

followUpQuestionsArray of objects

List of follow-up questions that can be asked post QnA

Example: ["What is the next step?","Can you elaborate on that?"]
tag_resultobject(PlatformConfig.TagGetQueryResponse)

Detailed result object from tag query execution

Response
application/json
{
  "questionId": "4d649cd3-54b8-4295-8dd7-23da0f913de4",
  "answer": "To reset your password, go to Settings > Security > Reset Password.",
  "chartable": true,
  "chart": "iVBORw0KGgoAAAANSUhEUgAAC7gAAAcICAYAAACsf4x4AAAAOnRFWHRTb2Z0d2FyZQBNYXRwbG90bGliIHZlcnNpb24zLjEwLjMsIGh0dHBzOi8vbWF0cGxvdGxpYi5vcmcvZiW",
  "context": [
    { … }
  ],
  "followUpQuestions": [
    "What is the next step?",
    "Can you elaborate on that?"
  ],
  "tag_result": {
    "sql_query": "SELECT * FROM \"xf_destination_param\";",
    "description": null,
    "follow_up_questions": [ … ],
    "is_valid_sql": "True",
    "reasoning": "SQL is syntactically correct.",
    "query_execution_result": [ … ],
    "final_answer": null
  }
}

Question & Answer

APIs for Question & Answering

Operations

Tag

APIs for Tag.

Operations

User Management

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

Operations