Skip to content
API Reference
/
/
Save Integration

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

List All Integrations

Request

Retrieve a list of integrations.

Parameters:

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

Returns:

  • A list of integrations matching the criteria.
Query
category_idCategory Id (any)(Category Id)

Category Id

Any of:

Category Id

any(Category Id)

Category Id

integration_nameIntegration Name (any)(Integration Name)

Integration Name

Any of:

Integration Name

any(Integration Name)

Integration Name

integration_idIntegration Id (any)(Integration Id)

Integration Id

Any of:

Integration Id

any(Integration Id)

Integration Id

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

Responses

Successful Response

Bodyapplication/jsonArray [
idId (any)(Id)
Any of:
any(Id)
nameName (any)(Name)
Any of:
any(Name)
workato_nameWorkato Name (any)(Workato Name)
Any of:
any(Workato 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)
service_providerservice provider (any)(service provider)
Any of:
any(service provider)
created_timestampCreated Timestamp (any)(Created Timestamp)
Any of:
any(Created Timestamp)
category_nameCategory Name (any)(Category Name)
Any of:
any(Category Name)
action_countAction Count (any)(Action Count)
Any of:
any(Action Count)
access_levelaccess_level (tenant, user) (any)(access_level (tenant, user))
Any of:
any(access_level (tenant, user))
resource_requiredResource Required (any)(Resource Required)
Any of:
any(Resource Required)
resource_typeResource Type (any)(Resource Type)
Any of:
any(Resource Type)
upload_resourceUpload Resource (any)(Upload Resource)
Any of:
any(Upload Resource)
authentication_requiredAuthentication Required (any)(Authentication Required)
Any of:
any(Authentication Required)
]
Response
application/json
[
  {
    "id": {},
    "name": {},
    "workato_name": {},
    "description": {},
    "is_active": {},
    "provider": {},
    "service_provider": {},
    "created_timestamp": {},
    "category_name": {},
    "action_count": {},
    "access_level": {},
    "resource_required": {},
    "resource_type": {},
    "upload_resource": {},
    "authentication_required": {}
  }
]

Save Integration

Request

save integration

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
nameany(Name)
descriptionDescription (any)(Description)
Any of:
any(Description)
providerany(Provider)
access_levelany(access_level (tenant, user))
authentication_requiredany(authentication_required)
Default false
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/integrations?tenant_id=test' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "name": null,
    "description": {},
    "provider": null,
    "access_level": null,
    "authentication_required": false
  }'

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": {}
}

Delete Integration

Request

Delete Integration

Parameters:

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

Returns:

  • status:
Path
integration_idany(Integration Id)required

Integration Id

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 DELETE \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/action-orchestrator/v1/integrations/{integration_id}?tenant_id=test' \
  -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