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

curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/meta-prompting/v1/prompts/meta/tones

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Request

curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/meta-prompting/v1/prompts/meta/languages

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Request

Path
prompt_idany(Prompt Id)required
Query
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/v2/prompts/{prompt_id}'

Responses

Successful Response

Bodyapplication/json
promptobject(PromptAndVersionModel)required
prompt.​prompt_idany(Prompt Id)required
prompt.​tenant_idany(Tenant Id)required
prompt.​titleany(Title)required
prompt.​descriptionany(Description)required
prompt.​typeany(Type)required
prompt.​categoryany(Category)required
prompt.​domainany(Domain)required
prompt.​statusany(Status)required
prompt.​versionobject(PromptVersionModel)required
prompt.​version.​version_idVersion Id (any)(Version Id)
Any of:
any(Version Id)
prompt.​version.​prompt_idany(Prompt Id)required
prompt.​version.​tenant_idany(Tenant Id)required
prompt.​version.​version_numberVersion Number (any)(Version Number)
Any of:
any(Version Number)
prompt.​version.​contentany(Content)required
prompt.​version.​generation_paramsobject(Generation Params)required
prompt.​version.​generation_params.​property name*anyadditional property
prompt.​version.​version_hashany(Version Hash)required
prompt.​version.​statusany(Status)required
prompt.​version.​insert_byany(Insert By)required
prompt.​version.​insert_timeInsert Time (any)(Insert Time)
Any of:
any(date-time)(Insert Time)
prompt.​version.​sourceSource (any)(Source)
Any of:
any(Source)
prompt.​insert_byany(Insert By)required
prompt.​insert_timeInsert Time (any)(Insert Time)
Any of:
any(date-time)(Insert Time)
prompt.​update_byUpdate By (any)(Update By)
Any of:
any(Update By)
prompt.​update_timeUpdate Time (any)(Update Time)
Any of:
any(date-time)(Update Time)
metadataobject(PromptResponseMetadata)required
metadata.​latest_version_numberany(Latest Version Number)required
Response
application/json
{ "prompt": { "prompt_id": null, "tenant_id": null, "title": null, "description": null, "type": null, "category": null, "domain": null, "status": null, "version": { … }, "insert_by": null, "insert_time": {}, "update_by": {}, "update_time": {} }, "metadata": { "latest_version_number": 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