Skip to content
API Reference
/
/
Lists all the sources for...

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

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

Creates an experiment workflow for a document type

Request

Query
documentTypeanyrequired
tenantIdany
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/workflows/experiment

Responses

OK

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

Lists all the sources for a tenantId.

Request

Query
tenant_idanyrequired
offsetany(int32)
Default 0
limitany(int32)
Default 10
name_containsany
source_typeany
typeany
updated_afterany(date-time)
updated_beforeany(date-time)
created_afterany(date-time)
created_beforeany(date-time)
sort_byany
Enum"NAME""CREATED_AT""UPDATED_AT"
sort_orderany
Enum"ASC""DESC"
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/sources?offset=0&limit=10&sort_by=NAME&sort_order=ASC'

Responses

OK

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

Create a new source connector.

Request

Bodyapplication/jsonrequired
tenantIdany

Tenant ID of the user

Example: "tenant-123"
userIdany

User ID of the requester

Example: "user-456"
descriptionany

Description of the connector

Example: "This is a sample connector"
typestringnon-empty

Type of the connector

Example: "s3"
nameany

Name of the connector

Example: "My S3 Source"
configany(PlatformConfig.JsonNode)
sourceTypestringnon-empty

Source type

Example: "RELATIONAL DB"
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/platform-config/v1/sources \
  -H 'Content-Type: application/json' \
  -d '{
    "tenantId": "tenant-123",
    "userId": "user-456",
    "description": "This is a sample connector",
    "type": "s3",
    "name": "My S3 Source",
    "config": null,
    "sourceType": "RELATIONAL DB"
  }'

Responses

OK

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

Question & Answer

APIs for Question & Answering

Operations

Tag

APIs for Tag.

Operations

User Management

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

Operations