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

Request

save connection_mapper

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
connection_idany(Connection Id)
integration_nameany(Integration Name)
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/darwin/v1/integrations/workato/connection_mapper?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "connection_id": null,
    "integration_name": null
  }'

Responses

Successful Response

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

Request

get_access_params

Parameters:

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

Returns:

  • status:
Path
integration_nameany(Integration Name)required

Integration Name

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)
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/darwin/v1/integrations/{integration_name}/access_params?tenant_id=test' \
  -H 'authorization: '

Responses

Successful Response

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

Request

save_access_params

Parameters:

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

Returns:

  • status:
Path
integration_nameany(Integration Name)required

Integration Name

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
property name*anyadditional property
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/darwin/v1/integrations/{integration_name}/access_params?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "property1": null,
    "property2": null
  }'

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
Operations

User Management

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

Operations