Skip to content
API Reference
/
/
Post Chart

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

Post Question

Request

Request a question.

Query
tenant_idTenant Id (any)(Tenant Id)
Any of:
any(uuid)(Tenant Id)
user_idUser Id (any)(User Id)
Any of:
any(uuid)(User Id)
Headers
authorizationAuthorization (any)(Authorization)
Any of:
any(Authorization)
Bodyapplication/jsonrequired
queryQuery (any) or Array of Query (objects)(Query)required
Any of:
any(Query)
use_kgany(Use Kg)
Default false
evalany(Eval)
Default false
doc_storeobject(DocStoreOptions)required
doc_store.​idany(Id)
Default ""
doc_store.​typeany(Type)
Default "astradb"
doc_store.​dataobject(Data)required
doc_store.​data.​property name*anyadditional property
kg_doc_storeKGDocStoreOptions (object) or any
Any of:
kg_embedderKGEmbedderOptions (object) or any
Any of:
rag_typeany(RagType)
Enum"document""table"
knowledge_baseobject(KnowledgeBaseOptions)
embedderobject(EmbedderOptions)
retrieverobject(RetrieverOptions)
rankerobject(RankerOptions)
generatorobject(GeneratorOptions)
tagobject(TagOptions)
setupSetup (any)(Setup)
Any of:
any(Setup)
rag_promptRag Prompt (any)(Rag Prompt)
Any of:
any(Rag Prompt)
tag_promptTag Prompt (any)(Tag Prompt)
Any of:
any(Tag Prompt)
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/question-answer/v1/question/ \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "query": {},
    "use_kg": false,
    "eval": false,
    "doc_store": {
      "id": "",
      "type": "astradb",
      "data": {
        "property1": null,
        "property2": null
      }
    },
    "kg_doc_store": {
      "id": "",
      "type": "astradb",
      "data": {
        "property1": null,
        "property2": null
      }
    },
    "kg_embedder": {
      "model": "Snowflake/snowflake-arctic-embed-l-v2.0",
      "api_base_url": "http://pegasus-inference-api.dev.uniphorecloud.com/openai/v1/",
      "api_key": "",
      "max_retries": 3
    },
    "rag_type": "document",
    "knowledge_base": {
      "id": ""
    },
    "embedder": {
      "model": "Snowflake/snowflake-arctic-embed-l-v2.0",
      "api_base_url": "http://pegasus-inference-api.dev.uniphorecloud.com/openai/v1/"
    },
    "retriever": {
      "top_k": 80
    },
    "ranker": {
      "top_k": 15,
      "scale_score": true,
      "calibration_factor": 1,
      "score_threshold": 0
    },
    "generator": {
      "model": "meta-llama/Llama-3.1-70B-Instruct",
      "temperature": 0.3,
      "max_tokens": 32000,
      "api_base_url": "http://pegasus-inference-api.dev.uniphorecloud.com/openai/v1",
      "top_p": 0.9
    },
    "tag": {
      "execute_query": false,
      "validate_query": false
    },
    "setup": {},
    "rag_prompt": {},
    "tag_prompt": {}
  }'

Responses

Successful Response

Bodyapplication/json
idId (any)(Id)
Any of:
any(Id)
dataany(Data)required
queryany(Query)required
documentsArray of objects(Documents)
referenced_docsArray of objects(Referenced Docs)
chartableChartable (any)(Chartable)
Any of:
any(Chartable)
follow_up_questionsArray of Follow Up Questions (objects) or Follow Up Questions (any)(Follow Up Questions)
Any of:
metaobject(Meta)
configConfig (object) or Config (any)(Config)
Any of:
guardrail_violationsArray of objects(Guardrail Violations)
tag_resultobject(TagResult)
Response
application/json
{
  "id": {},
  "data": null,
  "query": null,
  "documents": [
    { … }
  ],
  "referenced_docs": [
    null
  ],
  "chartable": {},
  "follow_up_questions": [
    null
  ],
  "meta": {
    "property1": null,
    "property2": null
  },
  "config": {
    "property1": null,
    "property2": null
  },
  "guardrail_violations": [
    null
  ],
  "tag_result": {
    "description": {},
    "sql_query": {},
    "follow_up_questions": [ … ],
    "is_valid_sql": {},
    "reasoning": {},
    "query_execution_result": [ … ],
    "final_answer": {}
  }
}

Batch Question

Request

Request multiple answers in batch mode.

Query
tenant_idTenant Id (any)(Tenant Id)
Any of:
any(uuid)(Tenant Id)
user_idUser Id (any)(User Id)
Any of:
any(uuid)(User Id)
Headers
authorizationAuthorization (any)(Authorization)
Any of:
any(Authorization)
Bodyapplication/jsonrequired
queryQuery (any) or Array of Query (objects)(Query)required
Any of:
any(Query)
use_kgany(Use Kg)
Default false
evalany(Eval)
Default false
doc_storeobject(DocStoreOptions)required
doc_store.​idany(Id)
Default ""
doc_store.​typeany(Type)
Default "astradb"
doc_store.​dataobject(Data)required
doc_store.​data.​property name*anyadditional property
kg_doc_storeKGDocStoreOptions (object) or any
Any of:
kg_embedderKGEmbedderOptions (object) or any
Any of:
rag_typeany(RagType)
Enum"document""table"
knowledge_baseobject(KnowledgeBaseOptions)
embedderobject(EmbedderOptions)
retrieverobject(RetrieverOptions)
rankerobject(RankerOptions)
generatorobject(GeneratorOptions)
tagobject(TagOptions)
setupSetup (any)(Setup)
Any of:
any(Setup)
rag_promptRag Prompt (any)(Rag Prompt)
Any of:
any(Rag Prompt)
tag_promptTag Prompt (any)(Tag Prompt)
Any of:
any(Tag Prompt)
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/question-answer/v1/question/batch \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "query": {},
    "use_kg": false,
    "eval": false,
    "doc_store": {
      "id": "",
      "type": "astradb",
      "data": {
        "property1": null,
        "property2": null
      }
    },
    "kg_doc_store": {
      "id": "",
      "type": "astradb",
      "data": {
        "property1": null,
        "property2": null
      }
    },
    "kg_embedder": {
      "model": "Snowflake/snowflake-arctic-embed-l-v2.0",
      "api_base_url": "http://pegasus-inference-api.dev.uniphorecloud.com/openai/v1/",
      "api_key": "",
      "max_retries": 3
    },
    "rag_type": "document",
    "knowledge_base": {
      "id": ""
    },
    "embedder": {
      "model": "Snowflake/snowflake-arctic-embed-l-v2.0",
      "api_base_url": "http://pegasus-inference-api.dev.uniphorecloud.com/openai/v1/"
    },
    "retriever": {
      "top_k": 80
    },
    "ranker": {
      "top_k": 15,
      "scale_score": true,
      "calibration_factor": 1,
      "score_threshold": 0
    },
    "generator": {
      "model": "meta-llama/Llama-3.1-70B-Instruct",
      "temperature": 0.3,
      "max_tokens": 32000,
      "api_base_url": "http://pegasus-inference-api.dev.uniphorecloud.com/openai/v1",
      "top_p": 0.9
    },
    "tag": {
      "execute_query": false,
      "validate_query": false
    },
    "setup": {},
    "rag_prompt": {},
    "tag_prompt": {}
  }'

Responses

Successful Response

Bodyapplication/json
responsesArray of objects(Responses)required
responses[].​idId (any)(Id)
Any of:
any(Id)
responses[].​dataany(Data)required
responses[].​queryany(Query)required
responses[].​documentsArray of objects(Documents)
responses[].​referenced_docsArray of objects(Referenced Docs)
responses[].​chartableChartable (any)(Chartable)
Any of:
any(Chartable)
responses[].​follow_up_questionsArray of Follow Up Questions (objects) or Follow Up Questions (any)(Follow Up Questions)
Any of:
responses[].​metaobject(Meta)
responses[].​configConfig (object) or Config (any)(Config)
Any of:
responses[].​guardrail_violationsArray of objects(Guardrail Violations)
responses[].​tag_resultobject(TagResult)
Response
application/json
{
  "responses": [
    { … }
  ]
}

Feedback Question

Request

Providing feedback to a question.

Path
question_idany(uuid)(Question Id)required
Query
user_idUser Id (any)(User Id)
Any of:
any(uuid)(User Id)
Headers
authorizationAuthorization (any)(Authorization)
Any of:
any(Authorization)
Bodyapplication/jsonrequired
feedbackany(Feedback)required
reasonReason (any)(Reason)
Any of:
any(Reason)
commentsComments (any)(Comments)
Any of:
any(Comments)
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/question-answer/v1/question/{question_id}/feedback' \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "feedback": null,
    "reason": {},
    "comments": {},
    "knowledge_base_id": {}
  }'

Responses

Successful Response

Response
No content

List Question

Request

List questions.

Query
tenant_idTenant Id (any)(Tenant Id)
Any of:
any(uuid)(Tenant Id)
user_idUser Id (any)(User Id)
Any of:
any(uuid)(User Id)
Headers
authorizationAuthorization (any)(Authorization)
Any of:
any(Authorization)
Bodyapplication/jsonrequired
doc_store_idany(Doc Store Id)
Default ""
knowledge_base_idany(Knowledge Base Id)
Default ""
offsetany(Offset)
Default 0
limitany(Limit)
Default 50
scopeany(Scope)
Default "all"
Enum"all""team""user"
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/question-answer/v1/question/list \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "doc_store_id": "",
    "knowledge_base_id": "",
    "offset": 0,
    "limit": 50,
    "scope": "all"
  }'

Responses

Successful Response

Bodyapplication/json
itemsArray of objects(Items)required
items[].​idany(Id)required
items[].​queryany(Query)required
items[].​answerobject(QuestionAnswerResponse)required
items[].​answer.​idId (any)(Id)
Any of:
any(Id)
items[].​answer.​dataany(Data)required
items[].​answer.​queryany(Query)required
items[].​answer.​documentsArray of objects(Documents)
items[].​answer.​referenced_docsArray of objects(Referenced Docs)
items[].​answer.​chartableChartable (any)(Chartable)
Any of:
any(Chartable)
items[].​answer.​follow_up_questionsArray of Follow Up Questions (objects) or Follow Up Questions (any)(Follow Up Questions)
Any of:
items[].​answer.​metaobject(Meta)
items[].​answer.​configConfig (object) or Config (any)(Config)
Any of:
items[].​answer.​guardrail_violationsArray of objects(Guardrail Violations)
items[].​answer.​tag_resultobject(TagResult)
Response
application/json
{
  "items": [
    { … }
  ]
}

Post Chart

Request

Request a chart.

Query
question_idQuestion Id (any)(Question Id)

Optional question ID to reference

Any of:

Optional question ID to reference

any(uuid)(Question Id)

Optional question ID to reference

tenant_idTenant Id (any)(Tenant Id)
Any of:
any(uuid)(Tenant Id)
user_idUser Id (any)(User Id)
Any of:
any(uuid)(User Id)
Headers
authorizationAuthorization (any)(Authorization)
Any of:
any(Authorization)
Bodyapplication/jsonrequired
contextContext (any) or Context (object)(Context)
Any of:
any(Context)
chart_typeChart Type (any)(Chart Type)
Any of:
any(Chart Type)
generatorChartGeneratorConfig (object) or any
Any of:
chart_promptChart Prompt (any)(Chart Prompt)
Any of:
any(Chart Prompt)
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/question-answer/v1/chart \
  -H 'Content-Type: application/json' \
  -H 'authorization: ' \
  -d '{
    "context": {},
    "chart_type": {},
    "generator": {
      "api_base_url": "http://pegasus-inference-api.dev.uniphorecloud.com/openai/v1",
      "model": "meta-llama/Llama-3.1-70B-Instruct",
      "max_tokens": 32000,
      "temperature": 0.3,
      "top_p": 0.9,
      "frequency_penalty": 0.2,
      "presence_penalty": 0.2,
      "max_retries": 3,
      "response_format": {
        "type": "json_schema",
        "json_schema": {
          "description": "An answer to the question, plus references to the documents, suggested follow-up questions, chart data in json and recommended chart type",
          "name": "chart_structured_answer",
          "schema": {
            "additionalProperties": false,
            "properties": {
              "chart_json_data": {
                "additionalProperties": true,
                "default": {},
                "title": "Chart Json Data",
                "type": "object"
              },
              "chart_type": {
                "default": "bar",
                "title": "Chart Type",
                "type": "string"
              },
              "y_axis_unit": {
                "default": "Value",
                "title": "Y Axis Unit",
                "type": "string"
              }
            },
            "title": "ChartStructuredAnswer",
            "type": "object"
          },
          "strict": true
        }
      },
      "timeout": 30,
      "http_client_kwargs": {
        "property1": null,
        "property2": null
      }
    },
    "chart_prompt": {}
  }'

Responses

Successful Response

Bodyapplication/json
idId (any)(Id)
Any of:
any(Id)
dataobject(ChartStructuredAnswer)
chartChart (any)(Chart)
Any of:
any(Chart)
Response
application/json
{
  "id": {},
  "data": {
    "chart_json_data": {},
    "chart_type": "bar",
    "y_axis_unit": "Value"
  },
  "chart": {}
}

Tag

APIs for Tag.

Operations

User Management

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

Operations