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

Request

Query
tenantIdstring(Tenantid)[ 3 .. 50 ] charactersrequired
userIdstring(Userid)[ 3 .. 50 ] charactersrequired
Bodymultipart/form-datarequired
fileany(binary)(File)required
knowledgeBaseIdstring(Knowledgebaseid)[ 1 .. 100 ] charactersrequired
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/evaluation/upload-ground-truth?tenantId=string&userId=string' \
  -H 'Content-Type: multipart/form-data' \
  -F file=null \
  -F knowledgeBaseId=string

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Request

Query
tenantIdstring(Tenantid)[ 3 .. 50 ] charactersrequired
userIdstring(Userid)[ 3 .. 50 ] charactersrequired
Bodymultipart/form-datarequired
fileany(binary)(File)required
knowledgeBaseIdstring(Knowledgebaseid)[ 1 .. 100 ] charactersrequired
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/evaluation/upload-ground-truth-csv?tenantId=string&userId=string' \
  -H 'Content-Type: multipart/form-data' \
  -F file=null \
  -F knowledgeBaseId=string

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Request

Query
knowledgeBaseIdstring(Knowledgebaseid)[ 3 .. 50 ] characters
tenantIdstring(Tenantid)[ 3 .. 50 ] characters
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/evaluation/download-ground-truth?knowledgeBaseId=string&tenantId=string'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Request

Query
tenantIdstring(Tenantid)[ 3 .. 50 ] characters
userIdstring(Userid)[ 3 .. 50 ] characters
knowledgeBaseIdstring(Knowledgebaseid)[ 3 .. 50 ] characters
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/evaluation/job?tenantId=string&userId=string&knowledgeBaseId=string'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Request

Path
idstring(Id)non-emptyrequired
Query
tenantIdstring(Tenantid)[ 3 .. 50 ] characters
userIdstring(Userid)[ 3 .. 50 ] characters
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/evaluation/job/{id}?tenantId=string&userId=string'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Request

Query
tenantIdstring(Tenantid)[ 3 .. 50 ] characters
userIdstring(Userid)[ 3 .. 50 ] characters
Bodyapplication/jsonrequired
nameany(Name)required
jobConfigJobconfig (object) or Jobconfig (any)(Jobconfig)
Any of:
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/evaluation/batch/evaluate?tenantId=string&userId=string' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": null,
    "jobConfig": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Request

Path
job_idstring(Job Id)non-emptyrequired
Query
tenantIdstring(Tenantid)[ 3 .. 50 ] characters
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/evaluation/metrics/download/{job_id}?tenantId=string'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Request

Query
tenantIdstring(Tenantid)[ 3 .. 50 ] characters
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/evaluation/metrics?tenantId=string'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Request

Path
job_idstring(Job Id)non-emptyrequired
Query
tenantIdstring(Tenantid)[ 3 .. 50 ] characters
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/evaluation/metrics/{job_id}?tenantId=string'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

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