# Uniphore Business AI Cloud

APIs for Uniphore Business AI platform spanning data, knowledge, models, and agents.

Version: 1.0.0
Metadata:
  - owner: Uniphore Technologies Pvt Ltd
  - team: Business AI
  - department: Engineering
  - status: Beta

## Servers

Demo Instance for Uniphore Business AI Cloud
```
https://forge-api-gateway-xforge.dev.uniphorecloud.com
```

## Security

### Darwin.bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

### Orchestrator.bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

### Agents.bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

### Inferencing.OAuth2PasswordBearer

Type: oauth2
Token URL: token
Scopes:

### Inferencing.APIKeyHeader

Type: apiKey
In: header
Name: x-api-key

## Download OpenAPI description

[Uniphore Business AI Cloud](https://docs.businessai.uniphorecloud.com/_bundle/API%20Reference/api.yaml)

## Action Orchestrator

APIs for Actions Orchestration.

### List All Categories

 - [GET /action-orchestrator/v1/categories](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_categories_v1_categories_get.md): Retrieve a list of categories.

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch categories.

Returns:
- A list of categories matching the criteria.

### List All Integrations

 - [GET /action-orchestrator/v1/integrations](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_integrations_v1_integrations_get.md): Retrieve a list of integrations.

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch integrations.

Returns:
- A list of integrations matching the criteria.

### Save Integration

 - [POST /action-orchestrator/v1/integrations](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/save_integration_v1_integrations_post.md): save integration

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- status.

### Delete Integration

 - [DELETE /action-orchestrator/v1/integrations/{integration_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/delete_integration_v1_integrations__integration_id__delete.md): Delete Integration

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch integrations.

Returns:
- status:

### Get Access Params

 - [GET /action-orchestrator/v1/integrations/{integration_id}/access_params](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_access_params_v1_integrations__integration_id__access_params_get.md): get_access_params

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch integrations.

Returns:
- status:

### Save Access Params

 - [POST /action-orchestrator/v1/integrations/{integration_id}/access_params](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/save_access_params_v1_integrations__integration_id__access_params_post.md): save_access_params

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch integrations.

Returns:
- status:

### Get Workato User Mapper

 - [GET /action-orchestrator/v1/integrations/workato/connection_mapper](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_workato_user_mapper_v1_integrations_workato_connection_mapper_get.md): Retrieve a workato user_mapper.

Parameters:
- tenant_id: Identifier for the tenant.

### Save User Mapper

 - [POST /action-orchestrator/v1/integrations/workato/connection_mapper](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/save_user_mapper_v1_integrations_workato_connection_mapper_post.md): save user_mapper
Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- status.

### Get Integration Resources

 - [POST /action-orchestrator/v1/integrations/resources](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_integration_resources_v1_integrations_resources_post.md): Save integration

Parameters:
- tenant_id: Identifier for the tenant.
- request: List of integration strings.
- user_id: ID of the user making the request.

Returns:
- CommonResponse with status.

### List All Actions

 - [GET /action-orchestrator/v1/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_actions_v1_actions_get.md): Retrieve a list of actions.

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch actions.

Returns:
- A list of actions matching the criteria.

### Save Action

 - [POST /action-orchestrator/v1/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/save_action_v1_actions_post.md): save action

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- status.

### List All Mcp Actions

 - [GET /action-orchestrator/v1/mcp/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_mcp_actions_v1_mcp_actions_get.md): Retrieve a list of all mcp actions.

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch actions.

Returns:
- A list of actions matching the criteria.

### List All Integrations Actions

 - [GET /action-orchestrator/v1/integrations/actions/count](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_integrations_actions_v1_integrations_actions_count_get.md): Retrieve a list of integrations grouped with their actions.

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch actions.

Returns:
- A list of integrations with their action names grouped together.

### List All Integrations Actions

 - [GET /action-orchestrator/v1/integrations/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_integrations_actions_v1_integrations_actions_get.md): Retrieve a list of integrations grouped with their actions.

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch actions.

Returns:
- A list of integrations with their action names grouped together.

### Actions Count

 - [GET /action-orchestrator/v1/actions/count](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/actions_count_v1_actions_count_get.md): Retrieve a Actions count.

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- A Actions count matching the criteria.

### Test Mcp Registry Connection

 - [POST /action-orchestrator/v1/actions/mcp/servers/registry/connection-test](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/test_mcp_registry_connection_v1_actions_mcp_servers_registry_connection_test_post.md): Test Mcp Registry Connection

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- status.

### Get Mcp Registry Connection

 - [GET /action-orchestrator/v1/actions/mcp/servers/registry/connection](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_mcp_registry_connection_v1_actions_mcp_servers_registry_connection_get.md): Get Mcp Registry Connection

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- Mcp Registry Connection Details.

### Mcp Registry Connection

 - [POST /action-orchestrator/v1/actions/mcp/servers/registry/connection](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/mcp_registry_connection_v1_actions_mcp_servers_registry_connection_post.md): Mcp Registry Connection

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- status.

### List Mcp Servers

 - [GET /action-orchestrator/v1/actions/mcp/servers](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_mcp_servers_v1_actions_mcp_servers_get.md): Get list mcp servers

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- list mcp servers matching the criteria.

### Count Mcp Servers

 - [GET /action-orchestrator/v1/actions/mcp/servers/count](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/count_mcp_servers_v1_actions_mcp_servers_count_get.md): mcp servers count

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- count mcp servers

### List All Mcp Servers

 - [GET /action-orchestrator/v1/actions/mcp/servers/search](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_mcp_servers_v1_actions_mcp_servers_search_get.md): Retrieve a List all mcp servers.

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- A list of mcp servers matching the criteria.

### Get Mcp Server Registry

 - [GET /action-orchestrator/v1/actions/mcp/servers/registry](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_mcp_server_registry_v1_actions_mcp_servers_registry_get.md): Get mcp server registry

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- status.

### Registry Mcp Server

 - [POST /action-orchestrator/v1/actions/mcp/servers/registry](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/registry_mcp_server_v1_actions_mcp_servers_registry_post.md): Registry mcp server

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- status.

### Test Mcp Server Connection

 - [POST /action-orchestrator/v1/actions/mcp/servers/connection-test](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/test_mcp_server_connection_v1_actions_mcp_servers_connection_test_post.md): test mcp server connection

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- connection status.

### Get Mcp Server Details

 - [GET /action-orchestrator/v1/actions/mcp/servers/{qualified_name}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_mcp_server_details_v1_actions_mcp_servers__qualified_name__get.md): Get mcp server details

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- mcp server details matching the criteria.

### Get Mcp Server Tools

 - [GET /action-orchestrator/v1/actions/mcp/server-tools](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_mcp_server_tools_v1_actions_mcp_server_tools_get.md): Get all tools for a specific MCP server from the Smithery registry.

Parameters:
- tenant_id: Identifier for the tenant.
- qualified_name: Qualified name of the MCP server (e.g., '@smithery-ai/github').
- user_id: User identifier.

Returns:
- Dictionary with integration_name, integration_desc, and actions list.

### Save Code

 - [POST /action-orchestrator/v1/actions/code_configuration](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/save_code_v1_actions_code_configuration_post.md): save code.

### Get Code Configurations

 - [GET /action-orchestrator/v1/actions/code_configuration/{integration_name}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_code_configurations_v1_actions_code_configuration__integration_name__get.md): save code.

### Generate Workflow

 - [POST /action-orchestrator/v1/generate-workflow](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/generate_workflow_v1_generate_workflow_post.md)

### Upload Openapi Spec File

 - [POST /action-orchestrator/v1/actions/openapi-file-upload](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/upload_openapi_spec_file_v1_actions_openapi_file_upload_post.md): Openapi file upload.

### List All Integrations

 - [GET /action-orchestrator/v1/workato-integrations](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_integrations_v1_workato_integrations_get.md)

### Get Integration

 - [GET /action-orchestrator/v1/workato-integrations/{workato_integration}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_integration_v1_workato_integrations__workato_integration__get.md)

### Get Workato Action

 - [GET /action-orchestrator/v1/workato-actions/{action_name}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_workato_action_v1_workato_actions__action_name__get.md)

### Get Actions As Functions

 - [GET /action-orchestrator/v1/actions/functions](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_actions_as_functions_v1_actions_functions_get.md)

### Fetch Actions As Functions

 - [POST /action-orchestrator/v1/actions/functions](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/fetch_actions_as_functions_v1_actions_functions_post.md)

### Action Code Snippet

 - [POST /action-orchestrator/v1/actions/code-snippets](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/action_code_snippet_v1_actions_code_snippets_post.md): Action Code Snippet

### Execute Action

 - [POST /action-orchestrator/v1/actions/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/execute_action_v1_actions_execute_post.md): Execute Action.

### Upload The File

 - [POST /action-orchestrator/v1/actions/file-upload](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/upload_the_file_v1_actions_file_upload_post.md): file upload.

### Upload The File Resource

 - [POST /action-orchestrator/v1/actions/resource-upload](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/upload_the_file_resource_v1_actions_resource_upload_post.md): file upload.

### Callback

 - [GET /action-orchestrator/auth/callback](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/callback_auth_callback_get.md)

### Get Auth Url Generate

 - [POST /action-orchestrator/auth/generate-url](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_auth_url_generate_auth_generate_url_post.md)

### Manual Callback

 - [POST /action-orchestrator/auth/manual-callback](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/manual_callback_auth_manual_callback_post.md)

### List Skill Packages

 - [GET /action-orchestrator/v1/packages](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_skill_packages_v1_packages_get.md): List all skill packages available for a tenant.

### Upload Skill Package

 - [POST /action-orchestrator/v1/packages](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/upload_skill_package_v1_packages_post.md): Upload a skill package ZIP file.

The package will be stored in S3 and package info will be saved to the database.
Returns the package info including a unique ID that can be used to
download the package later.

### Get Package Download Url

 - [GET /action-orchestrator/v1/packages/{id}/download-url](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_package_download_url_v1_packages__id__download_url_get.md): Get a presigned S3 download URL for a package.

The URL allows downloading the package ZIP file directly from S3.
URL expires after the specified duration (default: 1 hour).

### Delete Skill Package

 - [DELETE /action-orchestrator/v1/packages/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/delete_skill_package_v1_packages__id__delete.md): Delete a skill package.

The package will be removed from both storage and database.

### Upload Or Update Skill

 - [POST /action-orchestrator/v1/skills/upload](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/upload_or_update_skill_v1_skills_upload_post.md): Upload a skill ZIP package (create or update).

- If no skill with this name exists for the tenant → creates a new skill at version 1.
- If a skill with this name already exists → increments the version and updates it.

The skill name is read from SKILL.md frontmatter. Use the optional name form field
to override it.

Set system_skill=true to register a globally shared skill (tenant_id=NULL in DB,
stored under skills/system/...). Useful for seeding built-in skills that every tenant
can use without re-uploading.

### List Skills

 - [GET /action-orchestrator/v1/skills](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_skills_v1_skills_get.md): List available skills for the tenant. Returns metadata by default.

### Get Skill

 - [GET /action-orchestrator/v1/skills/{skill_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_skill_v1_skills__skill_id__get.md): Get skill details.

Set include_full_content=true to receive the full SKILL.md body (Level 2 load).

### Delete Skill

 - [DELETE /action-orchestrator/v1/skills/{skill_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/delete_skill_v1_skills__skill_id__delete.md): Soft-delete a skill (sets is_active=false). System skills cannot be deleted.

### Get Skill Scan Result

 - [GET /action-orchestrator/v1/skills/{skill_id}/scan-result](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_skill_scan_result_v1_skills__skill_id__scan_result_get.md): Return the stored security scan result for a skill.

### Get Latest Skill Version

 - [GET /action-orchestrator/v1/skills/{skill_id}/versions/latest](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_latest_skill_version_v1_skills__skill_id__versions_latest_get.md): Get the maximum version number available for a skill.

### Get Skill Version

 - [GET /action-orchestrator/v1/skills/{skill_id}/versions/{version}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_skill_version_v1_skills__skill_id__versions__version__get.md): Get a specific version of a skill by (skill_id, version).

### Get Skill Resource

 - [GET /action-orchestrator/v1/skills/{skill_id}/resources/{resource_name}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_skill_resource_v1_skills__skill_id__resources__resource_name__get.md): Download a single resource file from a skill (Level 3 load).

Called by crewai-agents SkillLoader to load resource files on demand.

### Execute Skill Script

 - [POST /action-orchestrator/v1/skills/{skill_id}/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/execute_skill_script_v1_skills__skill_id__execute_post.md): Execute a skill script via the Python Executor sandbox.

Called by crewai-agents SkillTools instead of running subprocess locally.

### Get Skill Download Url

 - [GET /action-orchestrator/v1/skills/{skill_id}/download-url](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_skill_download_url_v1_skills__skill_id__download_url_get.md): Get a presigned S3 download URL for a skill.

The URL allows downloading the skill ZIP file directly from S3.
URL expires after the specified duration (default: 1 hour).

### Scan A Mcp Server For Vulnarabilities

 - [POST /action-orchestrator/v1/mcp-scanner/scan](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/scan_a_mcp_server_for_vulnarabilities_v1_mcp_scanner_scan_post.md): Scan mcp server

### Scan Existing Mcp Server For Vulnarabilities

 - [POST /action-orchestrator/v1/mcp-scanner/scan/job](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/scan_existing_mcp_server_for_vulnarabilities_v1_mcp_scanner_scan_job_post.md): Scan all mcp server

## Agents

APIs for Agents.

### List All Agent Groups

 - [GET /forge-agents/api/v1/agents/by-all-groups](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/list_all_agent_groups_api_v1_agents_by_all_groups_get.md): Admin-only: return all groups and their agent mappings.

### Get Agent Groups

 - [GET /forge-agents/api/v1/agents/{agent_id}/groups](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_groups_api_v1_agents__agent_id__groups_get.md): Get all groups assigned to an agent.

### Assign Agent Groups

 - [POST /forge-agents/api/v1/agents/{agent_id}/groups](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/assign_agent_groups_api_v1_agents__agent_id__groups_post.md): Assign (and sync) groups to an agent.
If some existing groups are not included in the request, they are removed.
Admin-only endpoint.

### Check Agent Access

 - [GET /forge-agents/api/v1/agents/{agent_id}/access](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/check_agent_access_api_v1_agents__agent_id__access_get.md): Check if the current user has access to the specified agent.

### List Agents By Groups

 - [GET /forge-agents/api/v1/agents/by-groups](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/list_agents_by_groups_api_v1_agents_by_groups_get.md): Return agents grouped by user groups.

### List All Agent Models

 - [GET /forge-agents/api/v1/models](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/list_all_agent_models_api_v1_models_get.md): return all models.

### Get All Agents

 - [GET /forge-agents/api/v1/agents](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_all_agents_api_v1_agents_get.md)

### Create Crewai Agents

 - [POST /forge-agents/api/v1/agents](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/create_crewai_agents_api_v1_agents_post.md)

### Delete All Agents

 - [DELETE /forge-agents/api/v1/agents](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/delete_all_agents_api_v1_agents_delete.md)

### Get Available Planning Models

 - [GET /forge-agents/api/v1/agents/planning-models](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_available_planning_models_api_v1_agents_planning_models_get.md): Get list of available planning models for agent task planning.

Returns a list of supported planning models with metadata including:
- id: Model identifier used internally and stored in agent configuration
- display_name: Human-readable name for UI display
- description: Details about the model's capabilities
- provider: Model provider (e.g., Fireworks AI, OpenAI)
- recommended: Whether this model is recommended
- recommendation_reason: Why this model is recommended (if applicable)

The 'id' field should be used when creating/updating agents with a planning_model.

### Get Agents

 - [GET /forge-agents/api/v1/agents/{agent_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agents_api_v1_agents__agent_id__get.md)

### Update Agents

 - [PUT /forge-agents/api/v1/agents/{agent_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/update_agents_api_v1_agents__agent_id__put.md)

### Delete Agents

 - [DELETE /forge-agents/api/v1/agents/{agent_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/delete_agents_api_v1_agents__agent_id__delete.md): Delete an agent by ID.

Validates that the agent is not currently linked as a sub-agent to any supervisor agents
before deletion. If linked, returns 409 Conflict with details of supervisor agents.

Response on success (200 OK):
    {
        "agent_id": "...",
        "message": "...",  # For debugging/logging only - do NOT display to end users
        "sub_agents": [...]  # Only included if deleting a supervisor with sub-agents
    }

Response on conflict (409):
    {
        "error_code": 409,
        "error_message": "...",
        "data": {
            "agent_id": "...",
            "agent_name": "...",
            "linked_supervisors": [{"name": "...", "agent_id": "..."}]
        }
    }

IMPORTANT: The 'message' field in success responses is provided for debugging and
troubleshooting purposes only. Clients SHOULD NOT display these messages directly
to end users. Instead, implement i18n-compliant messaging on the frontend based on
the response data (agent_id, sub_agents, etc.).

### Update Agent Published Status

 - [PATCH /forge-agents/api/v1/agents/{agent_id}/published-status](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/update_agent_published_status_api_v1_agents__agent_id__published_status_patch.md)

### Generate Agent Output Schema

 - [POST /forge-agents/api/v1/agents/schema](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/generate_agent_output_schema_api_v1_agents_schema_post.md): Synchronously generate output_json_schema for agent tasks.

This endpoint requires an id and optionally accepts an agent_config.
- If agent_config is provided: uses it directly (does not fetch from DB)
- If agent_config is not provided: fetches the agent from DB using id

Returns the agent configuration with output_json_schema fields populated for tasks that need them.
This is a synchronous operation that may take 5-15 seconds per task.

Request Body Examples:
json
// Case 1: Fetch agent from DB using id
{
    "id": "123e4567-e89b-12d3-a456-426614174000"
}

// Case 2: Use provided agent_config directly
{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "agent_config": {
        "name": "Research Agent",
        "role": "Researcher",
        "goal": "Find information",
        "tasks": [...]
    }
}


Schema Generation Details:
- Uses LLM (gpt-4.1-mini) to analyze agent metadata and generate Pydantic models
- Inputs to LLM: agent name, role, goal, backstory, task name, description, expected_output
- Generates 5-12 field JSON schemas tailored to the agent's purpose
- Converts Pydantic models to JSON Schema Draft 7 format

Generation Conditions:
- Only generates if output_json_schema does NOT already exist
- Only generates if output_format is "json", "markdown", or None
- Skips tasks with output_format like "text" or other non-json formats
- Never overwrites existing schemas

NOTE: This does NOT save the agent to the database - it only returns the enriched config.

### Enrich Agent With Schema

 - [POST /forge-agents/api/v1/agents/{agent_id}/enrich-schema](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/enrich_agent_with_schema_api_v1_agents__agent_id__enrich_schema_post.md): Trigger output_json_schema enrichment for an existing agent.

This endpoint enriches the agent's tasks with auto-generated output_json_schema
and updates the agent configuration in the database.

Features:
- Fetches the latest agent configuration from database
- Generates output_json_schema for tasks that need them (typically 5-15 seconds per task)
- Updates the agent in database with enriched schemas
- Can run synchronously (blocks until complete) or as a background task

Query Parameters:
- background: If true, runs enrichment as background task and returns immediately.
             If false (default), runs synchronously and returns enriched schemas.

Use Cases:
- Re-generate schemas after agent updates
- Generate schemas for agents created without them
- Refresh schemas when requirements change

Returns:
- If background=false: Returns object with schemas, agent_id, and total count
                      Example: {
                          "schemas": {"task_name": {...json_schema...}, ...},
                          "agent_id": "...",
                          "total_schemas": 2
                      }
- If background=true: Returns status message with agent_id

### Get Agent Feedback

 - [GET /forge-agents/api/v1/agents/feedback](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_feedback_api_v1_agents_feedback_get.md): Get agent feedback with optional filters.

This endpoint retrieves feedback records with support for multiple filters
and pagination. All filters are optional and can be combined.

Query Parameters:
- agent_id: Filter by agent configuration (ca_configuration_id)
- user_id: Filter by feedback provider
- from_date: Start timestamp for filtering by creation date
- to_date: End timestamp for filtering by creation date
- upvote: Filter by upvote status (true for positive, false for negative)
- execution_id: Filter by specific execution
- session_id: Filter by session
- limit: Number of items per page (default: 10, max: 100)
- offset: Number of items to skip for pagination (default: 0)

Example:

GET /agents/feedback?agent_id=agent_conf_001&upvote=false&from_date=2026-01-01


Returns:
- 200 OK with paginated list of feedback records and total count

### Create Agent Feedback

 - [POST /forge-agents/api/v1/agents/feedback](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/create_agent_feedback_api_v1_agents_feedback_post.md): Create feedback for an agent response.

This endpoint allows users to provide feedback (upvote/downvote with optional comments)
on agent responses. The collected feedback will be stored and can be used to improve
future agent executions.

Features:
- Capture user feedback (thumbs up/down and comments) on agent responses
- Store feedback linked to specific executions and sessions
- Support cross-session and cross-user feedback analysis

Request Body:
- user_message: The user's input/query
- agent_message: The agent's response being rated
- upvote: True for thumbs up, False for thumbs down
- feedback_text: Optional text feedback/comment
- execution_id: ID of the agent execution
- session_id: Session identifier
- ca_configuration_id: Agent configuration ID

Note: tenant_id, feedback_by, and insert_by are automatically set from the authenticated user context.

Returns:
- 201 Created with feedback record including generated feedback_id

### Get Agent Feedback By Id

 - [GET /forge-agents/api/v1/agents/feedback/{feedback_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_feedback_by_id_api_v1_agents_feedback__feedback_id__get.md): Get a single agent feedback record by ID.

This endpoint retrieves a specific feedback record using its unique ID.

Path Parameters:
- feedback_id: The ID of the feedback record to retrieve

Returns:
- 200 OK with the feedback record
- 404 Not Found if feedback_id doesn't exist

Example:

GET /agents/feedback/550e8400-e29b-41d4-a716-446655440000

### Update Agent Feedback

 - [PUT /forge-agents/api/v1/agents/feedback/{feedback_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/update_agent_feedback_api_v1_agents_feedback__feedback_id__put.md): Update existing agent feedback.

This endpoint allows users to modify their previously submitted feedback.
Users can change the upvote/downvote status or update the feedback text.

Path Parameters:
- feedback_id: The ID of the feedback record to update

Request Body:
- upvote: Optional - True for thumbs up, False for thumbs down
- feedback_text: Optional - Updated text feedback/comment

Note: update_by is automatically set from the authenticated user context.

Returns:
- 200 OK with updated feedback record
- 404 Not Found if feedback_id doesn't exist

### Delete Agent Feedback

 - [DELETE /forge-agents/api/v1/agents/feedback/{feedback_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/delete_agent_feedback_api_v1_agents_feedback__feedback_id__delete.md): Delete agent feedback.

This endpoint permanently deletes a feedback record. This operation cannot be undone.

Path Parameters:
- feedback_id: The ID of the feedback record to delete

Returns:
- 204 No Content on successful deletion
- 404 Not Found if feedback_id doesn't exist

### Refresh Agent Feedback Summary

 - [POST /forge-agents/api/v1/agents/feedback/summarize/{agent_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/refresh_agent_feedback_summary_api_v1_agents_feedback_summarize__agent_id__post.md): Refresh (create or update) the feedback summary for an agent.

Triggers an on-demand re-ranking of all feedback records for the given
agent and regenerates the aggregated summary stored in
xf_agent_feedback_summary. Unlike the automatic background summarization
that runs after each feedback create/update/delete, this endpoint runs
synchronously and returns the resulting summary so the caller can confirm
the outcome.

Path Parameters:
- agent_id: The agent configuration ID (ca_configuration_id)

Returns:
- 200 OK with the refreshed summary record
- 404 Not Found if no summary could be generated (e.g. no feedback exists)

### Get Agent Supervisors

 - [GET /forge-agents/api/v1/agents/{agent_id}/supervisors](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_supervisors_api_v1_agents__agent_id__supervisors_get.md): Get all supervisor agents that have the specified agent as a sub-agent.

Returns a list of supervisors with their names and IDs that are currently
using the specified agent as a sub-agent.

### Search Agents By Capabilities

 - [GET /forge-agents/api/v1/agents/search/by-capabilities](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/search_agents_by_capabilities_api_v1_agents_search_by_capabilities_get.md): Search agents by capability tags.

This endpoint allows you to find agents based on their capability tags. You can search for agents
that have ANY of the specified tags (match_all=false) or ALL of the specified tags (match_all=true).

Example: GET /api/v1/agents/search/by-capabilities?tags=python&tags=data_analysis&match_all=false

### Get All Capability Tags

 - [GET /forge-agents/api/v1/agents/capabilities/tags](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_all_capability_tags_api_v1_agents_capabilities_tags_get.md): Get all unique capability tags across all active agents for the current tenant.

Returns a sorted list of all unique capability tags that have been assigned to agents.
Useful for tag autocomplete and discovery features.

Example: GET /api/v1/agents/capabilities/tags
Returns: ["data_analysis", "python", "visualization", "web_research"]

### List Agent Versions

 - [GET /forge-agents/api/v1/agents/{agent_id}/versions](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/list_agent_versions_api_v1_agents__agent_id__versions_get.md): List version history for an agent configuration.

### Get Agent Version

 - [GET /forge-agents/api/v1/agents/{agent_id}/versions/{version}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_version_api_v1_agents__agent_id__versions__version__get.md): Get a specific version of an agent configuration.

### Rollback Agent Version

 - [POST /forge-agents/api/v1/agents/{agent_id}/versions/{version}/rollback](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/rollback_agent_version_api_v1_agents__agent_id__versions__version__rollback_post.md): Rollback an agent configuration to a previous version.

### Agent Execution

 - [POST /forge-agents/api/v1/agents/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/agent_execution_api_v1_agents_execute_post.md): Execute an agent. The agent execution runs in a dedicated thread pool
to prevent blocking the main event loop and ensure health probes remain responsive.

### Agent Execution Sse

 - [POST /forge-agents/api/v1/agents/execute/stream](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/agent_execution_sse_api_v1_agents_execute_stream_post.md): Execute agents with Server-Sent Events (SSE) streaming.
Unidirectional communication: client sends one query, server streams response.

Features:
- SSE streaming for real-time updates
- Session management for conversation context
- Memory support for maintaining context
- Sequential or parallel tool execution
- Custom agent inputs

### Generate Agents

 - [POST /forge-agents/api/v1/agents/generate](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/generate_agents_api_v1_agents_generate_post.md)

### Prompt Suggestions

 - [GET /forge-agents/api/v1/agents/{agent_id}/prompt-suggestions](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/prompt_suggestions_api_v1_agents__agent_id__prompt_suggestions_get.md)

### Get Agent Runs

 - [GET /forge-agents/api/v1/agent-runs](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_runs_api_v1_agent_runs_get.md)

### Get Agent Output Schema

 - [GET /forge-agents/api/v1/agents/{agent_id}/output-schema](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_output_schema_api_v1_agents__agent_id__output_schema_get.md)

### Get Agent Execution Trace

 - [GET /forge-agents/api/v1/agents/traces/{execution_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_execution_trace_api_v1_agents_traces__execution_id__get.md)

### Reset Agent Session

 - [DELETE /forge-agents/api/v1/agents/sessions/{session_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/reset_agent_session_api_v1_agents_sessions__session_id__delete.md): Reset (delete) an agent conversation session.

This endpoint deletes all checkpoints, conversation history, and pending writes
associated with a specific session ID. Use this to:
- Clear conversation history for a user
- Reset context when starting a new conversation
- Clean up after testing/debugging
- Implement "clear chat" functionality

Note: This operation is irreversible. Once deleted, the conversation history
cannot be recovered.

Args:
    session_id: The session ID (thread_id) to reset. This is the same session_id
               used in the /agents/execute WebSocket endpoint.

Returns:
    dict: Deletion summary with message and session_id

### Get Agent Runs (Paginated)

 - [GET /forge-agents/api/v2/agent-runs](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_runs__paginated__api_v2_agent_runs_get.md)

## Darwin

APIs for Darwin.

### List All Actions

 - [GET /darwin/v1/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_list_all_actions_v1_actions_get.md): Retrieve a list of actions.

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch actions.

Returns:
- A list of actions matching the criteria.

### Save Action

 - [POST /darwin/v1/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_save_action_v1_actions_post.md): save action

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- status.

### Delete Integration

 - [DELETE /darwin/v1/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_delete_integration_v1_actions_delete.md): Delete Actions

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- status:

### Actions Count Per Integration

 - [GET /darwin/v1/actions/count](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_actions_count_per_integration_v1_actions_count_get.md): Retrieve a list of actions.

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch actions.

Returns:
- A list of actions matching the criteria.

### Fetch Action Parameters

 - [POST /darwin/v1/action-parameters](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_fetch_action_parameters_v1_action_parameters_post.md): Retrieve a Fetch Action parameters.

Parameters:
- tenant_id: Identifier for the tenant.
- action_service: Service to fetch actions.

Returns:
- A actions details matching the criteria.

### Upload Openapi Spec File

 - [POST /darwin/v1/actions/openapi-file-upload](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_upload_openapi_spec_file_v1_actions_openapi_file_upload_post.md): Openapi file upload.

### Get Workato User Mapper

 - [GET /darwin/v1/integrations/workato/connection_mapper](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_get_workato_user_mapper_v1_integrations_workato_connection_mapper_get.md): Retrieve a workato connection_mapper.

Parameters:
- tenant_id: Identifier for the tenant.

### Save User Mapper

 - [POST /darwin/v1/integrations/workato/connection_mapper](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_save_user_mapper_v1_integrations_workato_connection_mapper_post.md): save connection_mapper

Parameters:
- tenant_id: Identifier for the tenant.

Returns:
- status.

### Get Access Params

 - [GET /darwin/v1/integrations/{integration_name}/access_params](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_get_access_params_v1_integrations_integration_name_access_params_get.md): get_access_params

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch integrations.

Returns:
- status:

### Save Access Params

 - [POST /darwin/v1/integrations/{integration_name}/access_params](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_save_access_params_v1_integrations_integration_name_access_params_post.md): save_access_params

Parameters:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch integrations.

Returns:
- status:

### Get Actions As Functions

 - [GET /darwin/v1/actions/functions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_get_actions_as_functions_v1_actions_functions_get.md)

### Fetch Actions As Functions

 - [POST /darwin/v1/actions/functions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_fetch_actions_as_functions_v1_actions_functions_post.md)

### Execute Actions

 - [POST /darwin/v1/actions/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_execute_actions_v1_actions_execute_post.md): Execute Action.

### Download File

 - [GET /darwin/v1/reports/downloads/{tenant_id}/{execution_id}/{file}](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_download_file_v1_reports_downloads_tenant_id_execution_id_file_get.md)

### Execute Actions

 - [POST /darwin/v1/actions/custom/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_execute_actions_v1_actions_custom_execute_post.md): Execute an Action.

Request Body:
- tenant_id: Identifier for the tenant.
- configuration_service: Service to fetch actions.
- action_id: Identifier for the Action.
- action_name: Name of the Action.
- user_id: Identifier of the User.
- action_params: Parameters of the Action.
- message: Message/Command for the Action.

Returns:
- An Action Execution response.

### Slack Callback

 - [GET /darwin/auth/slack/callback](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_slack_callback_auth_slack_callback_get.md)

### Get Auth Url Generate

 - [POST /darwin/auth/generate-url](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_get_auth_url_generate_auth_generate_url_post.md)

### Get Auth Status

 - [GET /darwin/auth/status](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_get_auth_status_auth_status_get.md)

### Delete Integration Access Credentials

 - [DELETE /darwin/auth/revert](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_delete_integration_access_credentials_auth_revert_delete.md)

### Outlook Callback

 - [POST /darwin/auth/outlook/callback](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_outlook_callback_auth_outlook_callback_post.md)

### Generate Url

 - [POST /darwin/auth/openapi/generate-url](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_generate_url_auth_openapi_generate_url_post.md)

### Callback

 - [GET /darwin/auth/openapi/callback](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_callback_auth_openapi_callback_get.md)

## Inferencing

Pegasus APIs for Inferencing.

### OpenAI-compatible chat completions endpoint

 - [POST /inferencing/openai/v1/chat/completions](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/chat_completions_openai_v1_chat_completions_post.md): Creates a response for the given chat conversation.

### OpenAI-compatible embeddings endpoint

 - [POST /inferencing/openai/v1/embeddings](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/create_embeddings_openai_v1_embeddings_post.md): Creates an embedding vector for the input text.

### OpenAI-compatible models endpoint

 - [GET /inferencing/openai/v1/models](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/list_models_openai_v1_models_get.md): Lists available LLMs, VLMs and embedders for inference.

### Anthropic Messages API endpoint

 - [POST /inferencing/anthropic/v1/messages](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/messages_anthropic_v1_messages_post.md): Create a message using the Anthropic Messages API format.

### Anthropic Count Tokens API endpoint

 - [POST /inferencing/anthropic/v1/messages/count_tokens](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/count_tokens_anthropic_v1_messages_count_tokens_post.md): Count tokens for an Anthropic messages request.

### Rerank endpoint

 - [POST /inferencing/uniphore/v1/rerank](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/ranker_uniphore_v1_rerank_post.md): Order documents based on their relevance to the query.

### Nemoguard Jailbreak Detect endpoint

 - [POST /inferencing/uniphore/v1/nemoguard-jailbreak-detect](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/nemoguard_jailbreak_detect_uniphore_v1_nemoguard_jailbreak_detect_post.md): Detect attempts to jailbreak LLMs.

### Ranker endpoint (deprecated) (deprecated)

 - [POST /inferencing/uniphore/v1/ranker](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/ranker_uniphore_v1_ranker_post.md): Order documents based on their relevance to the query. DEPRECATED: Use /rerank instead.

## Meta Prompting

APIs for Meta Prompting & Prompt Management.

### Validate Prompt Title

 - [POST /meta-prompting/v1/validate](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/validate_prompt_title_v1_validate_post.md)

### List Prompts

 - [GET /meta-prompting/v1/prompts](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/list_prompts_v1_prompts_get.md)

### Create Prompt

 - [POST /meta-prompting/v1/prompts](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/create_prompt_v1_prompts_post.md)

### List Prompt Histories

 - [GET /meta-prompting/v1/prompts/history](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/list_prompt_histories_v1_prompts_history_get.md)

### Get Prompt

 - [GET /meta-prompting/v1/prompts/{prompt_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_v1_prompts__prompt_id__get.md)

### Hard Delete Prompt

 - [DELETE /meta-prompting/v1/prompts/{prompt_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/hard_delete_prompt_v1_prompts__prompt_id__delete.md): Hard delete a prompt and all its versions.

### Update Prompt

 - [PATCH /meta-prompting/v1/prompts/{prompt_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/update_prompt_v1_prompts__prompt_id__patch.md)

### Update Prompt Activate Version

 - [PATCH /meta-prompting/v1/prompts/{prompt_id}/versions/{version_id}/activate](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/update_prompt_activate_version_v1_prompts__prompt_id__versions__version_id__activate_patch.md)

### Update Prompt Activate Version Number

 - [PATCH /meta-prompting/v1/prompts/{prompt_id}/versions/number/{version_number}/activate](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/update_prompt_activate_version_number_v1_prompts__prompt_id__versions_number__version_number__activate_patch.md)

### Get Prompt Version By Id

 - [GET /meta-prompting/v1/versions/{version_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_version_by_id_v1_versions__version_id__get.md)

### Get Prompt Version By Number

 - [GET /meta-prompting/v1/prompts/{prompt_id}/versions/number/{version_number}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_version_by_number_v1_prompts__prompt_id__versions_number__version_number__get.md)

### List Prompt History

 - [GET /meta-prompting/v1/prompts/{prompt_id}/history](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/list_prompt_history_v1_prompts__prompt_id__history_get.md)

### Generate Prompt

 - [POST /meta-prompting/v1/prompts/generate](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/generate_prompt_v1_prompts_generate_post.md)

### Optimize Prompt

 - [POST /meta-prompting/v1/prompts/optimize](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/optimize_prompt_v1_prompts_optimize_post.md)

### Describe Image Llama

 - [POST /meta-prompting/v1/prompts/image/try](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/describe_image_llama_v1_prompts_image_try_post.md)

### Generate Llama Response

 - [POST /meta-prompting/v1/prompts/text/try](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/generate_llama_response_v1_prompts_text_try_post.md)

### Get Prompt Types

 - [GET /meta-prompting/v1/prompts/meta/types](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_types_v1_prompts_meta_types_get.md)

### Get Prompt Categories

 - [GET /meta-prompting/v1/prompts/meta/categories](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_categories_v1_prompts_meta_categories_get.md)

### Get Prompt Domains

 - [GET /meta-prompting/v1/prompts/meta/domains](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_domains_v1_prompts_meta_domains_get.md)

### Get Prompt Tones

 - [GET /meta-prompting/v1/prompts/meta/tones](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_tones_v1_prompts_meta_tones_get.md)

### Get Prompt Languages

 - [GET /meta-prompting/v1/prompts/meta/languages](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_languages_v1_prompts_meta_languages_get.md)

### Get Prompt

 - [GET /meta-prompting/v2/prompts/{prompt_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_v2_prompts__prompt_id__get.md)

## Platform Config

APIs for Platform Setup - Workflows, Sources, Destinations, Knowledge Bases etc.

### Get list of SLM

 - [GET /platform-config/v1/slm](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/list.md)

### Create new SLM

 - [POST /platform-config/v1/slm](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/create.md)

### Lists jobs with filters

 - [GET /platform-config/v1/jobs](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listjobs.md)

### Notify on successful lora deployment

 - [POST /platform-config/v1/lora](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/notifyloradeployment.md)

### Lists audit logs with filters

 - [POST /platform-config/v1/audit](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listauditlogs.md)

### Get Paged API Keys

 - [GET /platform-config/v1/api-key](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getpagedkeys.md): Fetches a paged list of API Keys with optional filtering

### Create API Key

 - [POST /platform-config/v1/api-key](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createkey.md): Creates a new API Key

### Get list of ALL Supported SLMs

 - [GET /platform-config/v1/slm/all](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listallmodels.md)

### Lists all the sources for a tenantId.

 - [GET /platform-config/v1/sources](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listsources.md)

### Create a new source connector.

 - [POST /platform-config/v1/sources](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createsource.md)

### Get job with id

 - [GET /platform-config/v1/jobs/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getjob.md)

### questions

 - [GET /platform-config/v1/questions](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getquestions.md)

### Ask a Question

 - [POST /platform-config/v1/questions](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/askquestion.md)

### Make inference call to SLM

 - [POST /platform-config/v1/slm/infer](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/infer.md)

### Lists workflows with filters

 - [GET /platform-config/v1/workflows](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listworkflows.md)

### Creates a workflow

 - [POST /platform-config/v1/workflows](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createworkflow.md)

### Gets SLM by id.

 - [GET /platform-config/v1/slm/{slmId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/get_1.md)

### Get API Key by ID

 - [GET /platform-config/v1/api-key/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getkeybyid.md): Fetches an API Key by its ID

### Update API Key

 - [PUT /platform-config/v1/api-key/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updatekey.md): Updates an existing API Key

### Lists all the destinations for a tenantId.

 - [GET /platform-config/v1/destinations](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listdestinations.md)

### Create a new destination connector.

 - [POST /platform-config/v1/destinations](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createdestination.md)

### Request new SLM

 - [POST /platform-config/v1/slm/requests](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/request.md)

### Delete source connector by ID

 - [DELETE /platform-config/v1/sources/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/deletesource.md): Deletes a source connector

### List all archived audit logs

 - [GET /platform-config/v1/audit/archive](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listarchives.md)

### Create configuration

 - [POST /platform-config/v1/configuration](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/create_1.md)

### Get list of Catalogue SLMs

 - [GET /platform-config/v1/slm/catalogue](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listcatalogue.md)

### Gets a workflow with id

 - [GET /platform-config/v1/workflows/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getworkflow.md)

### Updates provided workflow

 - [PUT /platform-config/v1/workflows/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updateworkflow.md)

### Deletes a workflow with id

 - [DELETE /platform-config/v1/workflows/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/deleteworkflow.md)

### Get embedder models

 - [GET /platform-config/v1/embedder/models](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/list_3.md)

### Get knowledgebases

 - [GET /platform-config/v1/knowledge_bases](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/list_2.md)

### Cancels job with id

 - [GET /platform-config/v1/jobs/{id}/cancel](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/abortjob.md)

### Delete destination connector by ID

 - [DELETE /platform-config/v1/destinations/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/deletedestination.md): Deletes a destination connector

### Get job processing details

 - [GET /platform-config/v1/jobs/{id}/details](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getjobdetails.md)

### Test Source connector

 - [GET /platform-config/v1/sources/test/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/testsource.md)

### Gets source connector for a tenantId by id.

 - [GET /platform-config/v1/sources/{sourceId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getsource.md)

### Updates the source connector for the given id.

 - [PUT /platform-config/v1/sources/{sourceId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updatesource.md)

### Gets a template schema for the workflows

 - [GET /platform-config/v1/workflows/template](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/gettemplate.md)

### Validate a workflow

 - [POST /platform-config/v1/workflows/validate](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/validateworkflow.md)

### Executes provided workflow

 - [POST /platform-config/v1/workflows/{id}/run](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/executeworkflow.md)

### Subscribe to job status events

 - [GET /platform-config/v1/jobs/subscribe/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/subscribe.md)

### Get configurations

 - [GET /platform-config/v1/configuration/{type}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/list_4.md)

### Gets knowledgebase by id.

 - [GET /platform-config/v1/knowledge_bases/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/get_2.md)

### Creates an experiment workflow for a document type

 - [POST /platform-config/v1/workflows/experiment](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createworkflowfordocumenttype.md)

### Get knowledgebase statistics

 - [GET /platform-config/v1/knowledge_bases/stats](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/kbstats.md): Gets stats of knowledgebases

### Get list of SLM questions for a specific SLM and tenant

 - [GET /platform-config/v1/slm/{slmId}/questions](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listquestions.md)

### Get retention configuration

 - [GET /platform-config/v1/audit/config/retention](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getretentionconfig.md)

### Update retention configuration

 - [PUT /platform-config/v1/audit/config/retention](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updateretentionconfig.md)

### Download current audit logs for a specific time range

 - [GET /platform-config/v1/audit/current/download](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/downloadcurrentaudit.md)

### Test destination connector

 - [GET /platform-config/v1/destinations/test/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/testdestination.md)

### Get failure details for files in a job

 - [GET /platform-config/v1/jobs/{id}/failed-files](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getfailedfiles.md)

### Cleanup for a template workflow with id

 - [DELETE /platform-config/v1/workflows/experiment/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/deletetemplate.md)

### Subscribe to job processing details events

 - [GET /platform-config/v1/jobs/subscribe/{id}/details](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/subscribejobdetails.md)

### Get archive details by month

 - [GET /platform-config/v1/audit/archive/{archiveMonth}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getarchivebymonth.md)

### Get paginated crawler source IDs

 - [POST /platform-config/v1/crawler/source_ids_paginated](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getsourceidspaginated.md)

### Gets destination connector for a tenantId by id.

 - [GET /platform-config/v1/destinations/{destinationId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getdestination.md)

### Updates the destination connector for the given id.

 - [PUT /platform-config/v1/destinations/{destinationId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updatedestination.md)

### Generate chart

 - [POST /platform-config/v1/questions/{question_id}/chart](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/generatechart.md)

### Download archived audit logs by ID

 - [GET /platform-config/v1/audit/archive/id/{id}/download](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/downloadarchivebyid.md)

### Gets embedder model by id.

 - [GET /platform-config/v1/embedder/models/{embedderModelId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/get_3.md)

### Delete knowledgebase by ID

 - [DELETE /platform-config/v1/knowledge_bases/{knowledgeBaseId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/delete.md): Deletes a knowledgebase

### Updates knowledgebase name and description

 - [PUT /platform-config/v1/knowledge_bases/{knowledge_base_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/update.md)

### Submit feedback for a question answer

 - [POST /platform-config/v1/slm/questions/{questionId}/feedback](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/submitfeedback.md)

### Download archived audit logs by month

 - [GET /platform-config/v1/audit/archive/{archiveMonth}/download](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/downloadarchive.md)

### Retrieves the crawl request body for the most recent job associated with a given workflow_id

 - [GET /platform-config/v1/crawler/crawl_request_body/{workflow_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getcrawlrequestbody.md)

### SLM pairing with given knowledgebase id.

 - [POST /platform-config/v1/slm_to_knowledgebase/{knowledge_base_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/slmpairing.md)

### Assign knowledgebase to group ids

 - [POST /platform-config/v1/knowledge_bases/{knowledge_base_id}/groups](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/assign.md)

## User Management

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

### Create User

 - [POST /user-management/v1/users](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/createuser.md): Creates a new User

### Update User

 - [PUT /user-management/v1/users](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/updateuser.md): Updates a User

### Advanced Search user groups

 - [POST /user-management/v2/groups/search](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/searchusergroups.md): Advanced Searches User groups with search criterion

### Advanced Search User

 - [POST /user-management/v1/users/search](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/searchusers.md): Advanced Searches Users with search criterion

### Get User

 - [GET /user-management/v1/users/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getuserdetail.md): Reads a User given user Id

### Get Current loggedIn User

 - [GET /user-management/v1/users/me](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getcurrentuserdetail.md): Reads the loggedIn User details

### Get Roles

 - [GET /user-management/v1/roles](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getroles.md): Fetches a list of roles, optionally filtered by tenant ID.