Skip to content
API Reference
/
/
List All Actions

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

Get Integration Resources

Request

Save integration

Parameters:

  • tenant_id: Identifier for the tenant.
  • request: List of integration strings.
  • user_id: ID of the user making the request.

Returns:

  • CommonResponse with status.
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
integrationsArray of objects(integrations Name)
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/integrations/resources?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "integrations": [
      null
    ]
  }'

Responses

Successful Response

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

List All Actions

Request

Retrieve a list of actions.

Parameters:

  • tenant_id: Identifier for the tenant.
  • configuration_service: Service to fetch actions.

Returns:

  • A list of actions matching the criteria.
Query
integration_idIntegration Id (any)(Integration Id)

Integration Id

Any of:

Integration Id

any(Integration Id)

Integration Id

action_nameAction Name (any)(Action Name)

Action Name

Any of:

Action Name

any(Action Name)

Action Name

providerProvider (any)(Provider)

Accepted values for provider are: darwin, mcp, open_api_spec

Any of:

Accepted values for provider are: darwin, mcp, open_api_spec

any(Provider)

Accepted values for provider are: darwin, mcp, open_api_spec

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)
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/actions?tenant_id=test' \
  -H 'authorization: '

Responses

Successful Response

Bodyapplication/jsonArray [
idId (any)(Id)
Any of:
any(Id)
nameName (any)(Name)
Any of:
any(Name)
descriptionDescription (any)(Description)
Any of:
any(Description)
providerProvider (any)(Provider)
Any of:
any(Provider)
integration_nameIntegration Name (any)(Integration Name)
Any of:
any(Integration Name)
connectedConnected (any)(Connected)
Any of:
any(Connected)
registry_providerRegistry Provider (any)(Registry Provider)
Any of:
any(Registry Provider)
created_timestampCreated Timestamp (any)(Created Timestamp)
Any of:
any(Created Timestamp)
]
Response
application/json
[
  {
    "id": {},
    "name": {},
    "description": {},
    "provider": {},
    "integration_name": {},
    "connected": {},
    "registry_provider": {},
    "created_timestamp": {}
  }
]

Save Action

Request

save action

Parameters:

  • tenant_id: Identifier for the tenant.

Returns:

  • status.
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
nameName (any)(Name)
Any of:
any(Name)
descriptionDescription (any)(Description)
Any of:
any(Description)
integration_idIntegration Id (any)(Integration Id)
Any of:
any(Integration Id)
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/actions?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "name": {},
    "description": {},
    "integration_id": {}
  }'

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