Skip to content
API Reference
/
/
Slack Callback

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

Execute Actions

Request

Execute an Action.

Request Body:

  • tenant_id: Identifier for the tenant.
  • configuration_service: Service to fetch actions.
  • action_id: Identifier for the Action.
  • action_name: Name of the Action.
  • user_id: Identifier of the User.
  • action_params: Parameters of the Action.
  • message: Message/Command for the Action.

Returns:

  • An Action Execution response.
Bodyapplication/jsonrequired
action_idany(Action Id)required
action_nameany(Action Name)required
integration_nameany(Integration Name)required
user_idany(User Id)required
action_paramsobject(Action Params)required
action_params.​property name*anyadditional property
messageany(Message)required
encode_credentialsEncode Credentials (any)(Encode Credentials)
Any of:
any(Encode Credentials)
tenant_idTenant Id (any)(Tenant Id)
Any of:
any(Tenant Id)
timezoneTimezone (any)(Timezone)
Any of:
any(Timezone)
execution_idExecution Id (any)(Execution Id)
Any of:
any(Execution Id)
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/darwin/v1/actions/custom/execute \
  -H 'Content-Type: application/json' \
  -d '{
    "action_id": null,
    "action_name": null,
    "integration_name": null,
    "user_id": null,
    "action_params": {
      "property1": null,
      "property2": null
    },
    "message": null,
    "encode_credentials": {},
    "tenant_id": {},
    "timezone": {},
    "execution_id": {}
  }'

Responses

Successful Response

Bodyapplication/json
integration_nameany(Integration Name)required
action_nameany(Action Name)required
dataData (object) or any
Any of:
errorError (object) or any
Any of:
Response
application/json
{
  "integration_name": null,
  "action_name": null,
  "data": {
    "type": null,
    "value": {}
  },
  "error": {
    "code": null,
    "type": null,
    "value": {}
  }
}

Slack Callback

Request

curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/darwin/auth/slack/callback

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Get Auth Url Generate

Request

Query
user_idany(User Id)required

User ID

integration_nameany(Integration Name)required

Integration Name

integration_idany(Integration Id)required

Integration 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/auth/generate-url?tenant_id=test' \
  -H 'authorization: '

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
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