Skip to content
/Darwin

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

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_nameIntegration Name (any)(Integration Name)

Integration Name

Any of:

Integration Name

any(Integration Name)

Integration Name

action_nameAction Name (any)(Action Name)

Action Name

Any of:

Action Name

any(Action Name)

Action Name

user_idUser Id (any)(User Id)

user_id

Any of:

user_id

any(User Id)

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/darwin/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)
is_activeIs Active (any)(Is Active)
Any of:
any(Is Active)
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)
created_timestampCreated Timestamp (any)(Created Timestamp)
Any of:
any(Created Timestamp)
]
Response
application/json
[
  {
    "id": {},
    "name": {},
    "description": {},
    "is_active": {},
    "provider": {},
    "integration_name": {},
    "connected": {},
    "created_timestamp": {}
  }
]

Save Action

Request

save action

Parameters:

  • tenant_id: Identifier for the tenant.

Returns:

  • status.
Query
user_idUser Id (any)(User Id)

user_id

Any of:

user_id

any(User Id)

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)
providerProvider (any)(Provider)
Any of:
any(Provider)
integration_nameIntegration Name (any)(Integration Name)
Any of:
any(Integration Name)
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/darwin/v1/actions?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "name": {},
    "description": {},
    "provider": {},
    "integration_name": {}
  }'

Responses

Successful Response

Bodyapplication/json
statusStatus (any)(Status)
Any of:
any(Status)
idid (any)(id)
Any of:
any(id)
Response
application/json
{
  "status": {},
  "id": {}
}

Delete Integration

Request

Delete Actions

Parameters:

  • tenant_id: Identifier for the tenant.

Returns:

  • status:
Query
integration_nameIntegration Name (any)(Integration Name)

Integration Name

Any of:

Integration Name

any(Integration Name)

Integration Name

user_idUser Id (any)(User Id)

user_id

Any of:

user_id

any(User Id)

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 DELETE \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/darwin/v1/actions?tenant_id=test' \
  -H 'authorization: '

Responses

Successful Response

Bodyapplication/json
statusStatus (any)(Status)
Any of:
any(Status)
idid (any)(id)
Any of:
any(id)
Response
application/json
{
  "status": {},
  "id": {}
}

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