Skip to content
API Reference
/
/
Delete Agents

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

Update Agents

Request

Path
agent_idany(Agent Id)required
Headers
X-Tenant-Idany(X-Tenant-Id)required
X-User-Idany(X-User-Id)required
Bodyapplication/jsonrequired
nameany(Name)required

Unique name of the agent.

roleany(Role)required

Title or function of the agent within the Crew.

goalany(Goal)required

Primary objective or responsibility of the agent.

backstoryBackstory (any)(Backstory)

Optional narrative to give context and personality to the agent.

Default ""
Any of:

Optional narrative to give context and personality to the agent.

any(Backstory)

Optional narrative to give context and personality to the agent.

Default ""
toolsToolConfig (object) or Tools (any)(Tools)

List of tools this agent is allowed to use.

Any of:

List of tools this agent is allowed to use.

llmLLMConfig (object) or LLM (any)(LLM)

The language model used to power the agent.

Any of:

Configuration for defining a LLM that can be bound to agents.

max_iterany(Max Iterations)

Maximum number of reasoning iterations allowed during task execution.

Default 25
reasoningReasoning (any)(Reasoning)

If true, the agent will perform reasoning steps before executing tasks.

Default false
Any of:

If true, the agent will perform reasoning steps before executing tasks.

any(Reasoning)

If true, the agent will perform reasoning steps before executing tasks.

Default false
max_reasoning_stepsMax Reasoning Steps (any)(Max Reasoning Steps)

Maximum number of reasoning steps the agent can take before executing a task.

Default 5
Any of:

Maximum number of reasoning steps the agent can take before executing a task.

any(Max Reasoning Steps)

Maximum number of reasoning steps the agent can take before executing a task.

Default 5
allow_code_executionAllow Code Execution (any)(Allow Code Execution)

If true, the agent can execute code as part of its reasoning process.

Default false
Any of:

If true, the agent can execute code as part of its reasoning process.

any(Allow Code Execution)

If true, the agent can execute code as part of its reasoning process.

Default false
code_execution_modeCode Execution Mode (any)(Code Execution Mode)

Determines when the agent can execute code: 'safe' (default), or 'unsafe'.

Default "safe"
Any of:

Determines when the agent can execute code: 'safe' (default), or 'unsafe'.

any(Code Execution Mode)

Determines when the agent can execute code: 'safe' (default), or 'unsafe'.

Default "safe"
Enum"safe""unsafe"
max_retry_limitMax Retry Limit (any)(Max Retry Limit)

Maximum number of retries allowed for task execution in case of failures.

Default 5
Any of:

Maximum number of retries allowed for task execution in case of failures.

any(Max Retry Limit)

Maximum number of retries allowed for task execution in case of failures.

Default 5
knowledge_basesArray of Knowledge Bases (objects) or Knowledge Bases (any)(Knowledge Bases)

List of knowledge bases that the agent can access.

Any of:

List of knowledge bases that the agent can access.

tasksArray of Tasks (objects) or Tasks (any)(Tasks)

List of task definitions to be executed by the agents.

Any of:

List of task definitions to be executed by the agents.

planningPlanning (any)(Planning)

If true, the agent can perform planning tasks.

Default true
Any of:

If true, the agent can perform planning tasks.

any(Planning)

If true, the agent can perform planning tasks.

Default true
curl -i -X PUT \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/crewai-agents/api/v1/agents/{agent_id}' \
  -H 'Content-Type: application/json' \
  -H 'X-Tenant-Id: ' \
  -H 'X-User-Id: ' \
  -d '{
    "name": null,
    "role": null,
    "goal": null,
    "backstory": "",
    "tools": {
      "tool_ids": [
        null
      ],
      "tool_definitions": [
        {
          "name": null,
          "integration_name": null,
          "description": null,
          "result_as_answer": false
        }
      ]
    },
    "llm": {
      "provider": null,
      "llm": null,
      "top_p": null,
      "temperature": null,
      "output_token_limit": null
    },
    "max_iter": 25,
    "reasoning": false,
    "max_reasoning_steps": 5,
    "allow_code_execution": false,
    "code_execution_mode": "safe",
    "max_retry_limit": 5,
    "knowledge_bases": [
      {
        "id": null,
        "name": null
      }
    ],
    "tasks": [
      {
        "name": null,
        "description": null,
        "agent": null,
        "expected_output": {},
        "async_execution": false,
        "tools": {
          "tool_ids": [
            null
          ],
          "tool_definitions": [
            {
              "name": null,
              "integration_name": null,
              "description": null,
              "result_as_answer": false
            }
          ]
        },
        "context": [
          null
        ],
        "human_input": false,
        "markdown": false,
        "output_format": "markdown",
        "output_json_structure": {
          "property1": null,
          "property2": null
        },
        "output_json_schema": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "planning": true
  }'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Delete Agents

Request

Path
agent_idany(Agent Id)required
Headers
X-Tenant-Idany(X-Tenant-Id)required
X-User-Idany(X-User-Id)required
curl -i -X DELETE \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/crewai-agents/api/v1/agents/{agent_id}' \
  -H 'X-Tenant-Id: ' \
  -H 'X-User-Id: '

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

Agent Execution

Request

Query
timezoneany(Timezone)required

Timezone of user

execution_idany(Execution Id)required

Execution ID

Headers
X-Tenant-Idany(X-Tenant-Id)required
X-User-Idany(X-User-Id)required
Bodyapplication/jsonrequired
idany(Id)required
nameName (any)(Name)
Any of:
any(Name)
messageany(Message)required
inputsInputs (object) or Inputs (any)(Inputs)
Default {}
Any of:
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/crewai-agents/api/v1/agents/execute \
  -H 'Content-Type: application/json' \
  -H 'X-Tenant-Id: ' \
  -H 'X-User-Id: ' \
  -d '{
    "id": null,
    "name": {},
    "message": null,
    "inputs": {}
  }'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
null

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

User Management

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

Operations