Skip to content
API Reference
/
/
Executes provided workflo...

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

Creates a workflow

Request

Bodyapplication/jsonrequired
workflowNamestringnon-empty
descriptionanyrequired
workflowTypeanyrequired
Enum"DOCUMENT""RELATIONAL_DB""CONVERSATION""ENTERPRISE_APPLICATION"
workflowTemplateany
sourceIdany
destinationIdany
nodesArray of objects(PlatformConfig.Node)required
nodes[].​titlestringnon-empty
nodes[].​operationstringnon-empty
nodes[].​nodeTypestringnon-empty
nodes[].​orderany(int32)
nodes[].​configobject(PlatformConfig.Config)
nodes[].​dependenciesArray of objects
scheduleany
Enum"EVERY_15_MINUTES""EVERY_HOUR""EVERY_2_HOURS""EVERY_4_HOURS""EVERY_6_HOURS""EVERY_8_HOURS""EVERY_10_HOURS""EVERY_12_HOURS""DAILY""WEEKLY"
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/workflows \
  -H 'Content-Type: application/json' \
  -d '{
    "workflowName": "string",
    "description": null,
    "workflowType": "DOCUMENT",
    "workflowTemplate": null,
    "sourceId": null,
    "destinationId": null,
    "nodes": [
      {
        "title": "string",
        "operation": "string",
        "nodeType": "string",
        "order": null,
        "config": {
          "settings": {
            "property1": null,
            "property2": null
          }
        },
        "dependencies": [
          null
        ]
      }
    ],
    "schedule": "EVERY_15_MINUTES"
  }'

Responses

OK

Bodyapplication/json
property name*anyadditional property
Response
application/json
{
  "property1": null,
  "property2": null
}

Executes provided workflow

Request

Path
idanyrequired
Bodyapplication/json
input_filesArray of objects(binary)
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/workflows/{id}/run' \
  -H 'Content-Type: application/json' \
  -d '{
    "input_files": [
      null
    ]
  }'

Responses

OK

Bodyapplication/json
property name*anyadditional property
Response
application/json
{
  "property1": null,
  "property2": null
}

Validate a workflow

Request

Bodyapplication/jsonrequired
nameany

Name of the workflow

Example: "Test Wf"
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/workflows/validate \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Test Wf"
  }'

Responses

OK

Question & Answer

APIs for Question & Answering

Operations

Tag

APIs for Tag.

Operations

User Management

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

Operations