Skip to content
/Tag

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

Question & Answer

APIs for Question & Answering

Operations

Tag

APIs for Tag.

Operations

Fetch Metadata

Request

Bodyapplication/jsonrequired
source_idany(Source Id)required

Source ID

knowledge_base_idKnowledge Base Id (any)(Knowledge Base Id)

knowledge base ID coming from X Forge

Any of:

knowledge base ID coming from X Forge

any(Knowledge Base Id)

knowledge base ID coming from X Forge

connection_idConnection Id (any)(Connection Id)
Any of:
any(Connection Id)
auto_generate_dictionaryany(Auto Generate Dictionary)
Default false
typeany(Type)
Default "postgresql"
descriptionDescription (any)(Description)
Any of:
any(Description)
source_schemaSource Schema (any)(Source Schema)
Default "public"
Any of:
any(Source Schema)
Default "public"
source_databaseSource Database (any)(Source Database)
Any of:
any(Source Database)
profiling_enabledany(Profiling Enabled)
Default false
generate_dictionary_promptGenerate Dictionary Prompt (any)(Generate Dictionary Prompt)
Any of:
any(Generate Dictionary Prompt)
recrawl_schemaany(Recrawl Schema)
Default false
table_namesArray of Table Names (objects) or Table Names (any)(Table Names)
Any of:
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/tagging/api/v1/tag/fetch_metadata \
  -H 'Content-Type: application/json' \
  -d '{
    "source_id": null,
    "knowledge_base_id": {},
    "connection_id": {},
    "auto_generate_dictionary": false,
    "type": "postgresql",
    "description": {},
    "source_schema": "public",
    "source_database": {},
    "profiling_enabled": false,
    "generate_dictionary_prompt": {},
    "recrawl_schema": false,
    "table_names": [
      null
    ]
  }'

Responses

Successful Response

Bodyapplication/json
successany(Success)required
messageany(Message)required
resultResult (any)(Result)
Any of:
any(Result)
Response
application/json
{
  "success": null,
  "message": null,
  "result": {}
}

Get Table Relationships

Request

Bodyapplication/jsonrequired
connection_idConnection Id (any)(Connection Id)
Any of:
any(Connection Id)
knowledge_base_idKnowledge Base Id (any)(Knowledge Base Id)
Any of:
any(Knowledge Base Id)
clientClient (any)(Client)
Any of:
any(Client)
modelModel (any)(Model)
Any of:
any(Model)
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/tagging/api/v1/tag/get_table_relationships \
  -H 'Content-Type: application/json' \
  -d '{
    "connection_id": {},
    "knowledge_base_id": {},
    "client": {},
    "model": {}
  }'

Responses

Successful Response

Bodyapplication/json
successany(Success)required
messageany(Message)required
resultResult (any)(Result)
Any of:
any(Result)
Response
application/json
{
  "success": null,
  "message": null,
  "result": {}
}

Update Table Relationships

Request

Bodyapplication/jsonrequired
connection_idConnection Id (any)(Connection Id)
Any of:
any(Connection Id)
knowledge_base_idKnowledge Base Id (any)(Knowledge Base Id)
Any of:
any(Knowledge Base Id)
table_relationshipsobject(TableRelationshipsParameterModel)required
table_relationships.​relationshipsArray of objects(Relationships)required

List of table relationships

table_relationships.​relationships[].​from_tableany(From Table)required

Source table name

table_relationships.​relationships[].​from_columnany(From Column)required

Column in the source table

table_relationships.​relationships[].​to_tableany(To Table)required

Target/related table name

table_relationships.​relationships[].​to_columnany(To Column)required

Column in the target table

table_relationships.​relationships[].​relationship_typeRelationship Type (any)(Relationship Type)

Type of relationship (foreign_key | inferred | business_logic)

Any of:

Type of relationship (foreign_key | inferred | business_logic)

any(Relationship Type)

Type of relationship (foreign_key | inferred | business_logic)

table_relationships.​relationships[].​descriptionDescription (any)(Description)

Brief human-readable description

Any of:

Brief human-readable description

any(Description)

Brief human-readable description

curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/tagging/api/v1/tag/update_table_relationships \
  -H 'Content-Type: application/json' \
  -d '{
    "connection_id": {},
    "knowledge_base_id": {},
    "table_relationships": {
      "relationships": [
        {
          "from_table": null,
          "from_column": null,
          "to_table": null,
          "to_column": null,
          "relationship_type": {},
          "description": {}
        }
      ]
    }
  }'

Responses

Successful Response

Bodyapplication/json
successany(Success)required
messageany(Message)required
resultResult (any)(Result)
Any of:
any(Result)
Response
application/json
{
  "success": null,
  "message": null,
  "result": {}
}

Get Table Description

Request

Bodyapplication/jsonrequired
connection_idConnection Id (any)(Connection Id)
Any of:
any(Connection Id)
knowledge_base_idKnowledge Base Id (any)(Knowledge Base Id)
Any of:
any(Knowledge Base Id)
table_namesArray of objects(Table Names)required
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/tagging/api/v1/tag/get_table_description \
  -H 'Content-Type: application/json' \
  -d '{
    "connection_id": {},
    "knowledge_base_id": {},
    "table_names": [
      null
    ]
  }'

Responses

Successful Response

Bodyapplication/json
successany(Success)required
messageany(Message)required
resultResult (any)(Result)
Any of:
any(Result)
Response
application/json
{
  "success": null,
  "message": null,
  "result": {}
}

Update Descriptions

Request

Bodyapplication/jsonrequired
connection_idConnection Id (any)(Connection Id)
Any of:
any(Connection Id)
knowledge_base_idKnowledge Base Id (any)(Knowledge Base Id)
Any of:
any(Knowledge Base Id)
table_nameany(Table Name)required
tag_knowledge_base_idTag Knowledge Base Id (any)(Tag Knowledge Base Id)
Any of:
any(Tag Knowledge Base Id)
columnsArray of Columns (objects) or Columns (any)(Columns)
Any of:
table_descriptionTable Description (any)(Table Description)
Any of:
any(Table Description)
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/tagging/api/v1/tag/update_descriptions \
  -H 'Content-Type: application/json' \
  -d '{
    "connection_id": {},
    "knowledge_base_id": {},
    "table_name": null,
    "tag_knowledge_base_id": {},
    "columns": [
      null
    ],
    "table_description": {}
  }'

Responses

Successful Response

Bodyapplication/json
successany(Success)required
messageany(Message)required
resultResult (any)(Result)
Any of:
any(Result)
Response
application/json
{
  "success": null,
  "message": null,
  "result": {}
}

Get Table List

Request

Query
connection_idConnection Id (any)(Connection Id)
Any of:
any(Connection Id)
knowledge_base_idKnowledge Base Id (any)(Knowledge Base Id)
Any of:
any(Knowledge Base Id)
column_detailsany(Column Details)
Default false
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/tagging/api/v1/tag/get_tables_list?column_details=false'

Responses

Successful Response

Bodyapplication/json
successany(Success)required
messageany(Message)required
resultResult (any)(Result)
Any of:
any(Result)
Response
application/json
{
  "success": null,
  "message": null,
  "result": {}
}

Get Connector Schemas

Request

Query
source_idSource Id (any)(Source Id)
Any of:
any(Source Id)
curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/tagging/api/v1/tag/get_source_connections

Responses

Successful Response

Bodyapplication/json
successany(Success)required
messageany(Message)required
resultResult (any)(Result)
Any of:
any(Result)
Response
application/json
{
  "success": null,
  "message": null,
  "result": {}
}

Get Latest Connection Job Status

Request

Query
connection_idConnection Id (any)(Connection Id)
Any of:
any(Connection Id)
knowledge_base_idKnowledge Base Id (any)(Knowledge Base Id)
Any of:
any(Knowledge Base Id)
curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/tagging/api/v1/tag/latest_job_status

Responses

Successful Response

Bodyapplication/json
successany(Success)required
messageany(Message)required
resultResult (any)(Result)
Any of:
any(Result)
Response
application/json
{
  "success": null,
  "message": null,
  "result": {}
}

Upload Csv

Request

Query
overwriteany(Overwrite)
Default false
Bodymultipart/form-datarequired
filesArray of objects(binary)(Files)required
connection_idConnection Id (any)(Connection Id)
Any of:
any(Connection Id)
knowledge_base_idKnowledge Base Id (any)(Knowledge Base Id)
Any of:
any(Knowledge Base Id)
curl -i -X POST \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/tagging/api/v1/tag/upload_csv?overwrite=false' \
  -H 'Content-Type: multipart/form-data' \
  -F 'files[0]=null'

Responses

Successful Response

Bodyapplication/json
successany(Success)required
messageany(Message)required
resultResult (any)(Result)
Any of:
any(Result)
Response
application/json
{
  "success": null,
  "message": null,
  "result": {}
}

Fetch Tables

Request

Bodyapplication/jsonrequired
source_idany(Source Id)required
source_databaseany(Source Database)
source_schemaany(Source Schema)
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/tagging/api/v1/tag/fetch_tables \
  -H 'Content-Type: application/json' \
  -d '{
    "source_id": null,
    "source_database": null,
    "source_schema": null
  }'

Responses

Successful Response

Bodyapplication/json
successany(Success)required
messageany(Message)required
resultResult (any)(Result)
Any of:
any(Result)
Response
application/json
{
  "success": null,
  "message": null,
  "result": {}
}

User Management

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

Operations