Skip to content
API Reference
/
/
Execute Action

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

Action Code Snippet

Request

Action Code Snippet

Query
user_idany(User Id)required

User Id

tenant_idTenant Id (any)(Tenant Id)
Default "test"
Any of:
any(Tenant Id)
Default "test"
Headers
authorizationAuthorization (any)(Authorization)
Any of:
any(Authorization)
Bodyapplication/jsonrequired
action_nameAction Name (any)(Action Name)
Any of:
any(Action Name)
integration_nameIntegration name (any)(Integration name)
Any of:
any(Integration name)
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/actions/code-snippets?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "action_name": {},
    "integration_name": {}
  }'

Responses

Successful Response

Bodyapplication/json
code_snippetsArray of Code Snippets (objects) or Code Snippets (any)(Code Snippets)
Any of:
parametersArray of Parameters (objects) or Parameters (any)(Parameters)
Any of:
responsesArray of Responses (objects) or Responses (any)(Responses)
Any of:
Response
application/json
{
  "code_snippets": [
    { … }
  ],
  "parameters": [
    { … }
  ],
  "responses": [
    { … }
  ]
}

Execute Action

Request

Execute Action.

Query
user_idany(User Id)required

User Id

timezoneTimezone (any)(Timezone)

Timezone

Default "IST"
Any of:

Timezone

any(Timezone)

Timezone

Default "IST"
tenant_idTenant Id (any)(Tenant Id)
Default "test"
Any of:
any(Tenant Id)
Default "test"
Headers
authorizationAuthorization (any)(Authorization)
Any of:
any(Authorization)
Bodyapplication/jsonrequired
execution_idExecutionId (any)(ExecutionId)
Any of:
any(ExecutionId)
context_idContextId (any)(ContextId)
Any of:
any(ContextId)
action_nameAction Name (any)(Action Name)
Any of:
any(Action Name)
integration_nameIntegration name (any)(Integration name)
Any of:
any(Integration name)
messageMessage (any)(Message)
Any of:
any(Message)
disable_llm_parseDisable llm Parse (any)(Disable llm Parse)
Default false
Any of:
any(Disable llm Parse)
Default false
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/actions/execute?timezone=IST&tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "execution_id": {},
    "context_id": {},
    "action_name": {},
    "integration_name": {},
    "message": {},
    "disable_llm_parse": false
  }'

Responses

Successful Response

Bodyapplication/json
actionany(Action)required
statusany(Status)required
responseResponseValue (object) or any
Any of:
Response
application/json
{
  "action": null,
  "status": null,
  "response": {
    "string_response": {},
    "int_response": {},
    "float_response": {},
    "bool_response": {},
    "object_response": { … },
    "list_response": [ … ],
    "response_type": {}
  }
}

Upload The File Resource

Request

file upload.

Query
execution_idExecution Id (any)(Execution Id)

execution_id

Any of:

execution_id

any(Execution Id)

execution_id

integration_nameIntegration Name (any)(Integration Name)

Integration Name

Any of:

Integration Name

any(Integration Name)

Integration Name

user_idany(User Id)required

user_id

tenant_idTenant Id (any)(Tenant Id)
Default "test"
Any of:
any(Tenant Id)
Default "test"
Headers
authorizationAuthorization (any)(Authorization)
Any of:
any(Authorization)
Bodymultipart/form-datarequired
fileany(binary)(File)required

Upload the File

curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/actions/resource-upload?tenant_id=test' \
  -H 'Content-Type: multipart/form-data' \
  -H 'authorization: '

Responses

Successful Response

Bodyapplication/json
statusStatus (any)(Status)
Any of:
any(Status)
idId (any)(Id)
Any of:
any(Id)
messageMessage (any)(Message)
Any of:
any(Message)
connectedConnected (any)(Connected)
Any of:
any(Connected)
Response
application/json
{
  "status": {},
  "id": {},
  "message": {},
  "connected": {}
}

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

Question & Answer

APIs for Question & Answering

Operations

Tag

APIs for Tag.

Operations

User Management

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

Operations