Skip to content
API Reference
/
/
Delete 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

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

Get Access Params

Request

get_access_params

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

Responses

Successful Response

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

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