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

Request

Path
prompt_idany(Prompt Id)required
Query
limitany(Limit)
Default 100
offsetany(Offset)
Default 0
tenant_idTenant Id (any)(Tenant Id)
Any of:
any(Tenant Id)
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/meta-prompting/v1/prompts/{prompt_id}/history?limit=100&offset=0'

Responses

Successful Response

Bodyapplication/json
historyArray of objects(History)required
history[].​prompt_history_idPrompt History Id (any)(Prompt History Id)
Any of:
any(Prompt History Id)
history[].​tenant_idany(Tenant Id)required
history[].​prompt_idany(Prompt Id)required
history[].​prompt_titleany(Prompt Title)required
history[].​prompt_version_idany(Prompt Version Id)required
history[].​actionany(PromptHistoryActions)required
Enum"UNKNOWN""CREATE_PROMPT""UPDATE_DESCRIPTION""CREATE_VERSION""CREATE_VERSION_AND_UPDATE_DESCRIPTION""ACTIVATE_VERSION"
history[].​action_detailsobject(Action Details)required
history[].​action_details.​property name*anyadditional property
history[].​insert_byany(Insert By)required
history[].​insert_timeInsert Time (any)(Insert Time)
Any of:
any(date-time)(Insert Time)
total_countany(Total Count)required
Response
application/json
{ "history": [ { … } ], "total_count": null }

Request

Bodyapplication/jsonrequired
instructionany(Instruction)required
prompt_lengthany(Prompt Length)required
languageany(Language)required
domainany(Domain)required
num_of_promptany(Num Of Prompt)required
typeany(Type)required
prompt_type_paramsPrompt Type Params (object) or Prompt Type Params (any)(Prompt Type Params)
Any of:
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/meta-prompting/v1/prompts/generate \
  -H 'Content-Type: application/json' \
  -d '{
    "instruction": null,
    "prompt_length": null,
    "language": null,
    "domain": null,
    "num_of_prompt": null,
    "type": null,
    "prompt_type_params": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Request

Bodymultipart/form-datarequired
imageany(binary)(Image)required
promptany(Prompt)required
modelany(Model)required
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/meta-prompting/v1/prompts/image/try \
  -H 'Content-Type: multipart/form-data'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

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