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

Hard delete a prompt and all its versions.

Path
prompt_idany(Prompt Id)required
Query
tenant_idTenant Id (any)(Tenant Id)
Any of:
any(Tenant Id)
user_idUser Id (any)(User Id)
Any of:
any(User Id)
curl -i -X DELETE \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/meta-prompting/v1/prompts/{prompt_id}'

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)
user_idUser Id (any)(User Id)
Any of:
any(User Id)
Bodyapplication/jsonrequired
descriptionany(Description)required
instructionany(Instruction)required
contentany(Content)required
prompt_type_paramsobject(Prompt Type Params)required
prompt_type_params.​property name*anyadditional property
prompt_lengthany(Prompt Length)required
languageany(Language)required
curl -i -X PATCH \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/meta-prompting/v1/prompts/{prompt_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": null,
    "instruction": null,
    "content": null,
    "prompt_type_params": {
      "property1": null,
      "property2": null
    },
    "prompt_length": null,
    "language": null
  }'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Request

Path
prompt_idany(Prompt Id)required
version_idany(Version Id)required
Query
tenant_idTenant Id (any)(Tenant Id)
Any of:
any(Tenant Id)
user_idUser Id (any)(User Id)
Any of:
any(User Id)
curl -i -X PATCH \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/meta-prompting/v1/prompts/{prompt_id}/versions/{version_id}/activate'

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