Skip to content
/Inferencing

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

List Models

Request

Lists the currently available models, and provides basic information about each one.

curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/inferencing/openai/v1/models

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Chat Completions

Request

Creates a model response for the given chat conversation.

Headers
setupSetup (any)(Setup)
Any of:
any(Setup)
Bodyapplication/jsonrequired
modelany(Model)required
messagesArray of objects(Messages)required
messages[].​roleany(Role)required
Enum"system""user""assistant"
messages[].​contentContent (any) or (Array of Content (ChatMessageContentText (object) or ChatMessageContentImage (object)))(Content)required
Any of:
any(Content)
messages[].​nameName (any)(Name)
Any of:
any(Name)
temperatureTemperature (any)(Temperature)
Default 1
Any of:
any(Temperature)
Default 1
top_pTop P (any)(Top P)
Default 1
Any of:
any(Top P)
Default 1
nN (any)(N)
Default 1
Any of:
any(N)
Default 1
streamStream (any)(Stream)
Default false
Any of:
any(Stream)
Default false
stopStop (any) or Array of Stop (objects)(Stop)
Any of:
any(Stop)
max_tokensMax Tokens (any)(Max Tokens)
Any of:
any(Max Tokens)
presence_penaltyPresence Penalty (any)(Presence Penalty)
Default 0
Any of:
any(Presence Penalty)
Default 0
frequency_penaltyFrequency Penalty (any)(Frequency Penalty)
Default 0
Any of:
any(Frequency Penalty)
Default 0
logit_biasLogit Bias (object) or Logit Bias (any)(Logit Bias)
Any of:
userUser (any)(User)
Any of:
any(User)
toolsArray of Tools (objects) or Tools (any)(Tools)
Any of:
tool_choiceTool Choice (any)(Tool Choice)
Any of:
any(Tool Choice)
response_formatResponseFormatText (object) or ResponseFormatJSONObject (object) or ResponseFormatJSONSchema (object) or Response Format (any)(Response Format)
Any of:
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/inferencing/openai/v1/chat/completions \
  -H 'Content-Type: application/json' \
  -H 'setup: ' \
  -d '{
    "model": null,
    "messages": [
      {
        "role": "system",
        "content": {},
        "name": {}
      }
    ],
    "temperature": 1,
    "top_p": 1,
    "n": 1,
    "stream": false,
    "stop": {},
    "max_tokens": {},
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "logit_bias": {
      "property1": null,
      "property2": null
    },
    "user": {},
    "tools": [
      null
    ],
    "tool_choice": {},
    "response_format": {
      "type": null
    }
  }'

Responses

Successful Response

Bodyapplication/json
idany(Id)
objectany(Object)
Default "chat.completion"
createdany(Created)
modelany(Model)required
choicesArray of objects(Choices)required
choices[].​indexany(Index)required
choices[].​messageobject(ChatCompletionMessage)required
choices[].​message.​roleany(Role)required
Enum"system""user""assistant"
choices[].​message.​contentContent (any)(Content)
Any of:
any(Content)
choices[].​message.​tool_callsArray of Tool Calls (objects) or Tool Calls (any)(Tool Calls)
Any of:
choices[].​logprobsLogprobs (any)(Logprobs)
Any of:
any(Logprobs)
choices[].​finish_reasonFinish Reason (any)(Finish Reason)
Any of:
any(Finish Reason)
choices[].​stop_reasonStop Reason (any)(Stop Reason)
Any of:
any(Stop Reason)
usageChatCompletionUsage (object) or any
Any of:
prompt_logprobsPrompt Logprobs (any)(Prompt Logprobs)
Any of:
any(Prompt Logprobs)
Response
application/json
{
  "id": null,
  "object": "chat.completion",
  "created": null,
  "model": null,
  "choices": [
    { … }
  ],
  "usage": {
    "prompt_tokens": null,
    "completion_tokens": null,
    "total_tokens": null
  },
  "prompt_logprobs": {}
}

Create Embeddings

Request

Creates an embedding vector representing the input text.

Headers
setupSetup (any)(Setup)
Any of:
any(Setup)
Bodyapplication/jsonrequired
modelany(Model)required
inputInput (any) or Array of Input (objects)(Input)required
Any of:
any(Input)
userUser (any)(User)
Any of:
any(User)
encoding_formatEncoding Format (any)(Encoding Format)
Default "float"
Any of:
any(Encoding Format)
Default "float"
Enum"float""base64"
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/inferencing/openai/v1/embeddings \
  -H 'Content-Type: application/json' \
  -H 'setup: ' \
  -d '{
    "model": null,
    "input": {},
    "user": {},
    "encoding_format": "float"
  }'

Responses

Successful Response

Bodyapplication/json
objectany(Object)
Default "list"
dataArray of objects(Data)required
data[].​objectany(Object)
Default "embedding"
data[].​indexany(Index)required
data[].​embeddingArray of Embedding (objects) or Embedding (any)(Embedding)required
Any of:
object
modelany(Model)required
usageobject(UsageObject)required
usage.​prompt_tokensany(Prompt Tokens)required
usage.​total_tokensany(Total Tokens)required
Response
application/json
{
  "object": "list",
  "data": [
    { … }
  ],
  "model": null,
  "usage": {
    "prompt_tokens": null,
    "total_tokens": null
  }
}

Show available models

Request

List all available models in the Pegasus Inference API.

curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/inferencing/uniphore/v1/models

Responses

Successful Response

Bodyapplication/json
objectany(Object)
Default "list"
dataArray of objects(Data)
Response
application/json
{
  "object": "list",
  "data": [
    { … }
  ]
}

Show available setups

Request

Query
model_nameany(Model Name)required

Name of the model to list setups for

curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/inferencing/uniphore/v1/setups

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Show available LLMs

Request

List all available LLMs in the Pegasus Inference API.

curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/inferencing/uniphore/v1/models/llms

Responses

Successful Response

Bodyapplication/json
objectany(Object)
Default "list"
dataArray of objects(Data)
Response
application/json
{
  "object": "list",
  "data": [
    { … }
  ]
}

Show available VLMs

Request

List all available VLMs in the Pegasus Inference API.

curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/inferencing/uniphore/v1/models/vlms

Responses

Successful Response

Bodyapplication/json
objectany(Object)
Default "list"
dataArray of objects(Data)
Response
application/json
{
  "object": "list",
  "data": [
    { … }
  ]
}

Show available embedders

Request

List all available embedders in the Pegasus Inference API.

curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/inferencing/uniphore/v1/models/embedders

Responses

Successful Response

Bodyapplication/json
objectany(Object)
Default "list"
dataArray of objects(Data)
Response
application/json
{
  "object": "list",
  "data": [
    { … }
  ]
}

Show available rankers

Request

List all available rankers in the Pegasus Inference API.

curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/inferencing/uniphore/v1/models/rankers

Responses

Successful Response

Bodyapplication/json
objectany(Object)
Default "list"
dataArray of objects(Data)
Response
application/json
{
  "object": "list",
  "data": [
    { … }
  ]
}

Show available guardrails

Request

List all available guardrails in the Pegasus Inference API.

curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/inferencing/uniphore/v1/models/guardrails

Responses

Successful Response

Bodyapplication/json
objectany(Object)
Default "list"
dataArray of objects(Data)
Response
application/json
{
  "object": "list",
  "data": [
    { … }
  ]
}

Nemoguard Jailbreak Detect

Request

Inference to Nemoguard Jailbreak Detect model.

Bodyapplication/jsonrequired
inputany(Input)required
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/inferencing/uniphore/v1/nemoguard-jailbreak-detect \
  -H 'Content-Type: application/json' \
  -d '{
    "input": null
  }'

Responses

Successful Response

Bodyapplication/json
jailbreakany(Jailbreak)required
scoreany(Score)required
Response
application/json
{
  "jailbreak": null,
  "score": null
}

Ranker

Request

Inference to Ranker models.

Bodyapplication/jsonrequired
modelany(Model)required
candidatesArray of objects(Candidates)required
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/inferencing/uniphore/v1/ranker \
  -H 'Content-Type: application/json' \
  -d '{
    "model": null,
    "candidates": [
      []
    ]
  }'

Responses

Successful Response

Bodyapplication/json
scoresArray of objects(Scores)required
Response
application/json
{
  "scores": [
    null
  ]
}

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