Skip to content
API Reference
/
/
Upload Openapi Spec File

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

Fetch Action Parameters

Request

Retrieve a Fetch Action parameters.

Parameters:

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

Returns:

  • A actions details matching the criteria.
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
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/darwin/v1/action-parameters?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "action_name": {},
    "integration_name": {}
  }'

Responses

Successful Response

Bodyapplication/json
endpointEndpoint (any)(Endpoint)
Any of:
any(Endpoint)
methodMethod (any)(Method)
Any of:
any(Method)
descriptionDescription (any)(Description)
Any of:
any(Description)
parametersArray of Parameters (objects) or Parameters (any)(Parameters)
Any of:
input_json_propertiesArray of Input Json Properties (objects) or Input Json Properties (any)(Input Json Properties)
Any of:
output_json_responsesArray of Output Json Responses (objects) or Output Json Responses (any)(Output Json Responses)
Any of:
Response
application/json
{
  "endpoint": {},
  "method": {},
  "description": {},
  "parameters": [
    { … }
  ],
  "input_json_properties": [
    { … }
  ],
  "output_json_responses": [
    { … }
  ]
}

Upload Openapi Spec File

Request

Openapi file upload.

Query
request_dataany(Request Data)required

Required params along with integration_name,description make it json and converted to base64 encoded string

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)
Bodymultipart/form-datarequired
fileany(binary)(File)required

A openApi file as UploadFile

curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/darwin/v1/actions/openapi-file-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)
Response
application/json
{
  "status": {},
  "id": {}
}

Get Workato User Mapper

Request

Retrieve a workato connection_mapper.

Parameters:

  • tenant_id: Identifier for the tenant.
Query
user_idUser Id (any)(User Id)

user_id

Any of:

user_id

any(User Id)

user_id

integration_nameany(Integration Name)

integration_name

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/workato/connection_mapper?tenant_id=test' \
  -H 'authorization: '

Responses

Successful Response

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

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