# 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-dev-xforge.baic-dev.uniphorecloud.com ``` ## Security ### AgentMonitoring.HTTPBearer Type: http Scheme: bearer ### Inferencing.OAuth2PasswordBearer Type: oauth2 Token URL: token Scopes: ### Inferencing.APIKeyHeader Type: apiKey In: header Name: x-api-key ### Darwin.bearerAuth Type: http Scheme: bearer Bearer Format: JWT ### Orchestrator.bearerAuth Type: http Scheme: bearer Bearer Format: JWT ### AgentEvaluation.HTTPBearer Type: http Scheme: bearer ### Agents.bearerAuth Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description - [Uniphore Business AI Cloud](https://docs.businessai.uniphorecloud.com/_bundle/API%20Reference/api.yaml) ## Action Orchestrator - [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. - [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. - [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 /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 /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: - [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 /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. - [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 /action-orchestrator/v1/integrations/connection_mapper](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_user_connection_mapper_v1_integrations_connection_mapper_get.md): Retrieve a user_mapper. Parameters: - tenant_id: Identifier for the tenant. - [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. - [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. - [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. - [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. - [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 wi - [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 wi - [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. - [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 /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. - [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. - [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. - [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 - [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 /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. - [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. - [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 /action-orchestrator/v1/actions/mcp/smithery/connection-status](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/check_smithery_oauth_connection_status_v1_actions_mcp_smithery_connection_status_get.md) - [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 /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') - [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 /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. - [POST /action-orchestrator/v1/generate-workflow](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/generate_workflow_v1_generate_workflow_post.md) - [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. - [POST /action-orchestrator/v1/actions/connector](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/save_integrations_v1_actions_connector_post.md): save code. - [GET /action-orchestrator/v1/workato/actions/schema](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_schema_for_a_workato_action_v1_workato_actions_schema_get.md): Resolve the AO integration row to its Workato api_collection_name, find that collection in Workato, look up the named endpoint, and return the row plus spec-derived fields (operation_id, summary, requ - [GET /action-orchestrator/v1/workato/api-collections](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_api_collections_v1_workato_api_collections_get.md) - [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 /action-orchestrator/v1/workato-connections](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_connection_v1_workato_connections_get.md) - [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) - [POST /action-orchestrator/v1/workato/sync](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/trigger_workato_sync_v1_workato_sync_post.md) - [POST /action-orchestrator/v1/workato/start-recipes](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/start_recipes_and_api_collections_v1_workato_start_recipes_post.md) - [GET /action-orchestrator/v1/workato/sync/status](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_workato_sync_status_v1_workato_sync_status_get.md) - [GET /action-orchestrator/v1/workato/api-key](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_darwin_api_key_v1_workato_api_key_get.md) - [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) - [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) - [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 - [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. - [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. - [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. - [GET /action-orchestrator/auth/callback](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/callback_auth_callback_get.md) - [POST /action-orchestrator/auth/generate-url](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/generate_reauthorize_url_auth_generate_url_post.md) - [POST /action-orchestrator/auth/manual-callback](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/manual_callback_auth_manual_callback_post.md) - [GET /action-orchestrator/auth/status](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_auth_status_auth_status_get.md) - [POST /action-orchestrator/auth/revert](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/revoke_authorization_auth_revert_post.md) - [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. - [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 packa - [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 /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. - [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 by name). - If no skill with this name exists → creates a new skill at version 1. - If a skill with this name already exists → increments the version and u - [POST /action-orchestrator/v1/skills/create](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/create_skill_v1_skills_create_post.md): Create a new skill from a ZIP package. Rejects if a skill with the same name (case-insensitive) already exists. The skill name is read from SKILL.md frontmatter and stored in lowercase. Use the option - [PUT /action-orchestrator/v1/skills/{skill_id}/upload](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/update_skill_v1_skills__skill_id__upload_put.md): Update an existing skill by ID. Increments the version. Rejects if the skill doesn't exist. The skill name is read from SKILL.md frontmatter and stored in lowercase. Use the optional `name` form field - [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. Supports pagination via `skip` and `limit` parameters. When metadata_only=true, includes summary statistics (active count, total coun - [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 /action-orchestrator/v1/skills/{skill_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/delete_skill_v1_skills__skill_id__delete.md): Hard-delete a skill and all its execution logs. System skills cannot be deleted. - [GET /action-orchestrator/v1/skills/{skill_id}/detail](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_full_skill_detail_v1_skills__skill_id__detail_get.md): Get complete skill details for the UI. Returns all database fields (description, category, tags, frontmatter, scan_result, storage_path, etc.) plus the full SKILL.md body (full_content). Use this endp - [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 /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 /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 /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. - [PATCH /action-orchestrator/v1/skills/{skill_id}/active](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/enable_or_disable_a_skill_v1_skills__skill_id__active_patch.md): Enable or disable a skill without deleting it. - `is_active: true` — makes the skill visible and available for execution. - `is_active: false` — hides the skill from listings and prevents execution, b - [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 /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). If version is not specified, r - [POST /action-orchestrator/v1/files](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/upload_a_file_v1_files_post.md) - [GET /action-orchestrator/v1/files/{file_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_file_metadata_v1_files__file_id__get.md) - [DELETE /action-orchestrator/v1/files/{file_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/delete_a_file_v1_files__file_id__delete.md) - [GET /action-orchestrator/v1/files/{file_id}/content](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/download_file_content_v1_files__file_id__content_get.md) - [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 - [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 - [GET /action-orchestrator/v1/remote-agents/{id}/access_params](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_access_params_v1_remote_agents__id__access_params_get.md): get_access_params Parameters: - tenant_id: Identifier for the tenant. - configuration_service: Service to fetch remote-agents. Returns: - status: - [POST /action-orchestrator/v1/remote-agents/{id}/access_params](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/save_access_params_v1_remote_agents__id__access_params_post.md): save_access_params Parameters: - tenant_id: Identifier for the tenant. - Service to fetch remote-agents. Returns: - status: - [GET /action-orchestrator/v1/remote-agents/connection_mapper](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_user_connection_mapper_v1_remote_agents_connection_mapper_get.md): Retrieve a user_mapper. Parameters: - tenant_id: Identifier for the tenant. - [GET /action-orchestrator/v1/remote-agents](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_remote_agents_v1_remote_agents_get.md) - [POST /action-orchestrator/v1/remote-agents](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/create_remote_agents_v1_remote_agents_post.md): Create Remote Agents Parameters: - tenant_id: Identifier for the tenant. Returns: - connection status. - [POST /action-orchestrator/v1/fetch-remote-agents](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_remote_agents_v1_fetch_remote_agents_post.md) - [GET /action-orchestrator/v1/remote-agents/{remote_agent_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_remote_agent_v1_remote_agents__remote_agent_id__get.md) - [DELETE /action-orchestrator/v1/remote-agents/{remote_agent_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/delete_remote_agent_v1_remote_agents__remote_agent_id__delete.md) - [POST /action-orchestrator/v1/remote-agents/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/execute_remote_agent_v1_remote_agents_execute_post.md): Execute a configured remote A2A agent with a single user message. Resolves the stored credentials for `agent_name`, fetches its agent card, forwards the message via the A2A protocol, and returns the a - [POST /action-orchestrator/v1/remote-agents/execute/stream](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/execute_remote_agent__sse__v1_remote_agents_execute_stream_post.md): Execute a configured remote A2A agent and stream the response over Server-Sent Events. SSE frames carry one of these event kinds: `start`, `task`, `message`, `status`, `artifact`, `final`, `error`. Th - [POST /action-orchestrator/auth/remote_agent/generate-url](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/darwin_generate_url_auth_remote_agent_generate_url_post.md) - [GET /action-orchestrator/auth/remote_agent/callback](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/darwin_callback_auth_remote_agent_callback_get.md) - [GET /action-orchestrator/v1/workflows](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_workflow_v1_workflows_get.md) - [POST /action-orchestrator/v1/fetch-workflows](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_workflow_v1_fetch_workflows_post.md) - [POST /action-orchestrator/v1/jobs](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/submit_async_job_v1_jobs_post.md): Submit a long-running job (fire and forget). Persists the job (status=PROCESSING) and returns immediately with a `request_id`. Processing runs in the background; on completion the result is persisted - [GET /action-orchestrator/v1/jobs/{request_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_async_job_v1_jobs__request_id__get.md): Read a job's current state and result (DB is the source of truth). ## Agent Evaluation API ## Agent Monitoring API - [GET /agent-monitoring/api/v1/monitoring/agents/by-name](https://docs.businessai.uniphorecloud.com/api-reference/api/agent-monitoring-api/list_agents_by_name_metrics_api_v1_monitoring_agents_by_name_get.md): Return statistical metrics for every distinct agent_name found in Opik. `page_size` controls how many **agents** are returned per page (not traces). `trace_size` caps the number of traces fetched per - [GET /agent-monitoring/api/v1/monitoring/agents/by-name/{agent_name}](https://docs.businessai.uniphorecloud.com/api-reference/api/agent-monitoring-api/get_agent_metrics_by_name_api_v1_monitoring_agents_by_name__agent_name__get.md): Return statistical metrics for all traces belonging to a given agent_name. Filters Opik traces by `metadata.agent_name` and aggregates them into a single statistical summary. Each metric field exposes - [GET /agent-monitoring/api/v1/monitoring/agents/executions](https://docs.businessai.uniphorecloud.com/api-reference/api/agent-monitoring-api/get_agent_executions_api_v1_monitoring_agents_executions_get.md): Return a paginated list of individual executions, optionally filtered. At least one of `agent_id` or `agent_name` is required. `start_date_time` and `end_date_time` are required unless `last_n`, `agen - [GET /agent-monitoring/api/v1/monitoring/agents/{agent_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agent-monitoring-api/get_agent_metrics_api_v1_monitoring_agents__agent_id__get.md): Return aggregated monitoring metrics for a single agent. Queries Opik traces where `metadata.agent_id` matches the given UUID and aggregates metrics over all collected traces. Use **start_date**/**end - [GET /agent-monitoring/api/v1/monitoring/agents](https://docs.businessai.uniphorecloud.com/api-reference/api/agent-monitoring-api/list_agents_metrics_api_v1_monitoring_agents_get.md): Return aggregated monitoring metrics for every agent found in Opik. Groups traces by `metadata.agent_id` and returns one summary per agent, ordered by most recently active first. Use **start_date**/** - [GET /agent-monitoring/api/v1/monitoring/system/health](https://docs.businessai.uniphorecloud.com/api-reference/api/agent-monitoring-api/get_system_health_api_v1_monitoring_system_health_get.md): Return overall system-level health metrics. Aggregates across all agents found in Opik (or the specified agents): - **total_agents**, **total_agents_by_name** - **total_executions**, **total_cost_usd* - [GET /agent-monitoring/api/v1/monitoring/system/health/timeseries](https://docs.businessai.uniphorecloud.com/api-reference/api/agent-monitoring-api/get_system_health_timeseries_api_v1_monitoring_system_health_timeseries_get.md): Return a time-series of system-health snapshots for charting. For `interval` in `hourly`/`daily`/`weekly` each entry in `buckets` is the same shape as `GET /system/health` but computed only over trace - [GET /agent-monitoring/api/v1/monitoring/system/status](https://docs.businessai.uniphorecloud.com/api-reference/api/agent-monitoring-api/get_status_summary_api_v1_monitoring_system_status_get.md): Return a status summary based on Opik traces. - **trace_statuses**: count of traces per derived status (`{"completed": 120, "failed": 5, "in_progress": 2}`). Derived from `error_info` (failed) / `end_ ## Agents - [GET /forge-agents/api/v1/agents](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_all_agents_api_v1_agents_get.md): List agents for the tenant with optional filters. Pagination is opt-in: when `limit` is supplied the response is a paginated envelope `{items, total, limit, offset, has_more}`; when `limit` is omitted - [POST /forge-agents/api/v1/agents](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/create_crewai_agents_api_v1_agents_post.md) - [DELETE /forge-agents/api/v1/agents](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/delete_all_agents_api_v1_agents_delete.md) - [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 /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 /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) - [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) - [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. - [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: - a - [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 - [POST /forge-agents/api/v1/agents/generate](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/generate_agents_api_v1_agents_generate_post.md) - [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. - [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) - [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 /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. Resp - [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. - [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 manage - [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 configura - [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 d - [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. - [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. - [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. - [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. - [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 h - [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) - [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: - - [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: - fe - [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 - [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 - [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. - [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. Featur - [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) - [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) - [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_fee - [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 /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. - [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. ## Darwin - [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. A StackOne integ - [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 /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: - [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. - [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. - [POST /darwin/v1/actions/connector](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_save_stackone_integrations_v1_actions_connector_post.md): save code. - [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 /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. - [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 /darwin/v1/integrations/connection_mapper](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_get_user_mapper_v1_integrations_connection_mapper_get.md): Retrieve a connection_mapper. Parameters: - tenant_id: Identifier for the tenant. - [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: - [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 /darwin/v1/actions/functions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_get_actions_as_functions_v1_actions_functions_get.md) - [POST /darwin/v1/actions/functions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_fetch_actions_as_functions_v1_actions_functions_post.md) - [POST /darwin/v1/actions/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_execute_actions_v1_actions_execute_post.md): Execute Action. - [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) - [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. - - [GET /darwin/auth/slack/callback](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_slack_callback_auth_slack_callback_get.md) - [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 /darwin/auth/status](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_get_auth_status_auth_status_get.md) - [DELETE /darwin/auth/revert](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_delete_integration_access_credentials_auth_revert_delete.md) - [POST /darwin/auth/outlook/callback](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_outlook_callback_auth_outlook_callback_post.md) - [POST /darwin/auth/test-connection](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_test_connection_auth_test_connection_post.md) - [POST /darwin/auth/openapi/generate-url](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_generate_url_auth_openapi_generate_url_post.md) - [GET /darwin/auth/openapi/callback](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_callback_auth_openapi_callback_get.md) - [GET /darwin/v1/connectors](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_list_connectors_v1_connectors_get.md): Retrieve the Darwin connectors available to the project. Parameters: - filter: free-text search across key, name, description and categories. - key / category: exact-match narrowing. - page / page_siz - [GET /darwin/v1/connectors/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_list_actions_v1_connectors_actions_get.md): List connectors and the actions they expose. Parameters: - connectors / account_ids / action_key: narrow the listing. - search: free-text over provider names and action labels. - include / exclude: co - [GET /darwin/v1/connectors/{connector_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_get_connector_v1_connectors_connector_id_get.md): Retrieve a single StackOne connector. Parameters: - connector_id: key[@version][~owner] identifier. - version / owner: override what the id resolves to. - connector_profile_id: mark which actions the - [GET /darwin/v1/connectors/{connector_id}/actions/{action_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_get_connector_action_v1_connectors_connector_id_actions_action_id_get.md): Retrieve the full definition of one action on a StackOne connector. Parameters: - connector_id: key[@version][~owner] identifier. - action_id: the action to describe, e.g. hibob_list_employees. - vers - [GET /darwin/v1/connector-profiles](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_list_connector_profiles_v1_connector_profiles_get.md): List the StackOne connector profiles configured in the project. Parameters: - connector_key: restrict to one or more connectors. - active: restrict by active state. - page / page_size: pagination. - e - [POST /darwin/v1/connector-profiles](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_create_connector_profile_v1_connector_profiles_post.md): Create a StackOne connector profile. Request Body: - connector_key, authentication_config_key, name: required. - environment / active / is_default / version / pinned_version: default to production, tr - [GET /darwin/v1/connector-profiles/{profile_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_get_connector_profile_v1_connector_profiles_profile_id_get.md): Retrieve one StackOne connector profile. Parameters: - profile_id: the profile's unique identifier. - expand: pull in the connector, version or count fields. Returns: - The profile with its setup fie - [DELETE /darwin/v1/connector-profiles/{profile_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_delete_connector_profile_v1_connector_profiles_profile_id_delete.md): Delete a StackOne connector profile. Deleting also removes the profile's webhook subscriptions and stored secrets. A profile that still has linked accounts cannot be deleted, and StackOne reports tha - [PATCH /darwin/v1/connector-profiles/{profile_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_update_connector_profile_v1_connector_profiles_profile_id_patch.md): Update a StackOne connector profile. Send only the fields to change. Request Body: - Every field is optional; omitted fields keep their stored values. - setup_fields / secrets replace the stored set w - [POST /darwin/v1/connectors/auth-links](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_create_auth_link_v1_connectors_auth_links_post.md): Generate an account-linking auth link for an end-user. Creates a StackOne connect session (`POST /connect_sessions`) and returns its `auth_link_url` — the link the end-user opens to connect their acco - [POST /darwin/v1/connectors/actions/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_execute_action_v1_connectors_actions_execute_post.md): Execute a StackOne action against a linked account. Calls `POST /actions/rpc`, which routes to the account's provider, handles provider authentication and returns normalized data. Request Body: - acti - [POST /darwin/v1/connectors/callback](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/darwin_receive_webhook_event_v1_connectors_callback_post.md): Receive a webhook event from StackOne. This is the URL registered by the startup webhook registration (`STACKONE_CALLBACK_URL`), so StackOne — not an authenticated caller — is what POSTs here. It ther ## Data Layer - [GET /platform-config/proxy/dl-platform/workflows/{workflowId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getworkflowbyid.md): Returns a single Dataflow by their unique ID - [PUT /platform-config/proxy/dl-platform/workflows/{workflowId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updateworkflow.md): Update a Dataflow with the provided information - [DELETE /platform-config/proxy/dl-platform/workflows/{workflowId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deleteworkflow.md): Delete a Dataflow with given ID - [GET /platform-config/proxy/dl-platform/knowledge-clusters/{kcId}/hooks/{hookId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/get.md): Returns a single Job Hook by its unique ID - [PUT /platform-config/proxy/dl-platform/knowledge-clusters/{kcId}/hooks/{hookId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/update.md): Updates the given Job Hook and returns its ID. Send application/json to change fields only, or multipart/form-data with files_added and files_removed to apply a file delta in the same call; sending ne - [DELETE /platform-config/proxy/dl-platform/knowledge-clusters/{kcId}/hooks/{hookId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/delete.md): Delete a Job Hook with given ID - [GET /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getcomputeconnectorbyid.md): Returns a single Compute connector by their unique ID - [PUT /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updatecomputeconnector.md): Update a Compute connector with the provided information - [DELETE /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deletecomputeconnector.md): Delete a Compute Connector with given ID - [GET /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}/templates/{computeTemplateId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getcomputetemplatebyid.md): Returns a single Compute template by their unique ID - [PUT /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}/templates/{computeTemplateId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updatecomputetemplate.md): Update a Compute template with the provided information - [DELETE /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}/templates/{computeTemplateId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deletecomputetemplate.md): Delete a Compute template - [GET /platform-config/proxy/dl-platform/workflows](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getworkflow.md): Returns List of Dataflows by provided criteria - [POST /platform-config/proxy/dl-platform/workflows](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createworkflow.md): Create a Dataflow with the provided information - [GET /platform-config/proxy/dl-platform/workflows/{workflowId}/versions](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/listversions.md): Returns List of Versions for the given Dataflow by provided criteria - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createversion.md): Creates a new Version for the given Dataflow and returns its ID - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/tasks](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createtask.md): Adds a task to the given Dataflow Version and returns its task id - [DELETE /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/tasks](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deletetasks.md): Deletes the given task ids from the dataflow version in a single transaction. Task ids not present in the version are ignored. - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/tasks/{taskId}/script](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/uploadtaskscript.md): Uploads a bash script for a task in this dataflow version - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/resume](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/resumeworkflowversion.md): Returns versionId if resumed - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/pause](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/pauseworkflowversion.md): Returns versionId if paused - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/clone](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/cloneversion.md): Creates a new Dataflow Version by copying the given Version and returns the new Version ID - [POST /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/activate](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/activateversion.md): Marks the given Dataflow Version as the active Version for its Dataflow - [GET /platform-config/proxy/dl-platform/workflow_runs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getworkflowruns.md): Returns List of Dataflow Runs by provided criteria - [POST /platform-config/proxy/dl-platform/workflow_runs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/submitworkflowrun.md): Returns id of submitted Dataflow Run - [POST /platform-config/proxy/dl-platform/query](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/submitasyncquery.md): Submits a query for asynchronous execution and returns the ID used to poll its status and results - [GET /platform-config/proxy/dl-platform/pipelines](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/listpipelines.md): Returns List of Pipelines by provided criteria. Set resolveRef to true to also resolve the referenced source and knowledge cluster details. - [POST /platform-config/proxy/dl-platform/pipelines](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createpipeline.md): Create a Pipeline with the provided information - [GET /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/listversions_1.md): Returns List of Versions for the given Pipeline by provided criteria - [POST /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createversion_1.md): Creates a new Version for the given Pipeline and returns its ID - [POST /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}/config](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updateconfig.md): Replaces the configuration of the given Pipeline Version - [POST /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}/clone](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/cloneversion_1.md): Creates a new Pipeline Version by copying the given Version and returns the new Version ID - [POST /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}/activate](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/activateversion_1.md): Marks the given Pipeline Version as the active Version for its Pipeline - [GET /platform-config/proxy/dl-platform/knowledge-clusters/{kcId}/hooks](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/list_1.md): Returns List of Job Hooks for the given Knowledge Cluster by provided criteria - [POST /platform-config/proxy/dl-platform/knowledge-clusters/{kcId}/hooks](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/create_1.md): Creates a Job Hook for the given Knowledge Cluster and returns its ID. Send application/json for a Job Hook without files, or multipart/form-data with a hook part and repeated files parts to create th - [GET /platform-config/proxy/dl-platform/jobs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/listjobs.md): Returns List of Ingestion Jobs by provided criteria - [POST /platform-config/proxy/dl-platform/jobs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/submitbatchjob.md): Submit a batch job - [POST /platform-config/proxy/dl-platform/jobs/{jobId}/cancel](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/canceljobbyid.md): Will submit job cancellation request, job will be canclled in background so there will be slight delay. - [POST /platform-config/proxy/dl-platform/configPortability/import](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/doimport.md): Same as import, with the request JSON in a 'config' part and each file in a part named for the entity and file it belongs to - [POST /platform-config/proxy/dl-platform/configPortability/import/init](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/initimport.md): Parses an exported config file and returns the sub-entity mappings required for import (for a pipeline version, the source tables referenced by its SQL) - [GET /platform-config/proxy/dl-platform/compute-connectors](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getcomputeconnectors.md): Returns List of Compute connectors by provided criteria - [POST /platform-config/proxy/dl-platform/compute-connectors](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createcomputeconnector.md): Create a Compute connector with the provided information - [GET /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}/templates](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getcomputeconnectors_1.md): Returns List of Compute templates for a compute connector by criteria - [POST /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}/templates](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createcomputetemplate.md): Create a Compute template with the provided information - [POST /platform-config/proxy/dl-platform/compute-connectors/{computeConnectorId}/templates/{computeTemplateId}/action/{actionType}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/triggercomputeaction.md) - [GET /platform-config/proxy/dl-platform/audit-logs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/listauditlogs.md): Returns a paginated list of entity audit log entries - [POST /platform-config/proxy/dl-platform/audit-logs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/createauditlog.md): Accepts an audit event from an external service and persists it - [GET /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getversion.md): Returns a single Dataflow Version by its unique ID, including its parameters, tasks and edges - [DELETE /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deleteversion.md): Delete a Dataflow Version with given ID - [PATCH /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updateversion.md): Applies a partial update to the given Dataflow Version - [GET /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/tasks/{taskId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/gettask.md): Returns a single task from the given Dataflow Version by its task id - [PATCH /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/tasks/{taskId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updatetask.md): Applies a partial update to a task in the given Dataflow Version - [DELETE /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/edges](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/removeedges.md): Removes dependency edges between tasks in the given Dataflow Version. Edges not present in the version are ignored. - [PATCH /platform-config/proxy/dl-platform/workflows/{workflowId}/versions/{versionId}/edges](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/addedges.md): Adds dependency edges between tasks in the given Dataflow Version. Each edge points from one task id to another. - [PATCH /platform-config/proxy/dl-platform/query/{id}/cancel](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/cancelquery.md): Requests cancellation of a Query that has not finished executing - [PATCH /platform-config/proxy/dl-platform/query/{id}/approve](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/approvequery.md): Approves a Query that is awaiting approval so that it can proceed to execution - [GET /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getversion_1.md): Returns a single Pipeline Version by its unique ID - [DELETE /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deleteversion_1.md): Delete a Pipeline Version with given ID - [PATCH /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updateversion_1.md): Applies a partial update to the given Pipeline Version. Set add_audit to true to record an audit entry for the change. - [GET /platform-config/proxy/dl-platform/pipelines/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getpipeline.md): Returns a single Pipeline by its unique ID. Set resolveRef to true to also resolve the referenced source and knowledge cluster details. - [DELETE /platform-config/proxy/dl-platform/pipelines/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deletepipeline.md): Delete a Pipeline with given ID - [PATCH /platform-config/proxy/dl-platform/pipelines/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/updatepipeline.md): Applies a partial update to the Pipeline with the given ID - [GET /platform-config/proxy/dl-platform/workflow_runs/{runId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getworkflowrun.md): Returns Dataflow Run Details - [GET /platform-config/proxy/dl-platform/workflow_runs/{runId}/restart](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/restartworkflowrun.md): Restart runId - [GET /platform-config/proxy/dl-platform/workflow_runs/{runId}/logs/download](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/downloadworkflowrunlogs.md): Streams a zip aggregating dataflow run logs. With no filters, includes every retry attempt's task log for every task plus the job logs for the latest attempt of each job task. Pass ?taskId to scope to - [GET /platform-config/proxy/dl-platform/workflow_runs/{runId}/cancel](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/cancelworkflowrun.md): Returns runId if cancellation requested - [GET /platform-config/proxy/dl-platform/workflow_runs/logs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getworkflowruntasklogs.md): Returns Dataflow task Log - [GET /platform-config/proxy/dl-platform/query/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getquerydetails.md): Returns the details and current status of a single Query by its unique ID - [GET /platform-config/proxy/dl-platform/query/{id}/output](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/queryoutput.md): Returns a single page of results for a Query. Use page to walk through the result set. - [GET /platform-config/proxy/dl-platform/query/{id}/output/stream](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/streamqueryoutput.md): Returns output of query as SSE, one page is one event. Emits a page event per page of results, with the page number as the event id, then a complete event carrying totalPages and rowCount. Rejected un - [GET /platform-config/proxy/dl-platform/pipelines_versions/by_session_id/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getversionsbysessionid.md): Returns the Pipeline Versions whose active session matches the given session ID - [GET /platform-config/proxy/dl-platform/pipelines/{pipelineId}/versions/{versionId}/schema-suggestions](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getschemasuggestions.md): Reads forge-tag's column mapping manifest for the version and falls back to deducing both from the pipeline SQL when there is none, as there is for a pipeline written by hand. Always 200: what could n - [GET /platform-config/proxy/dl-platform/lineage/tables/{tableId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/gettablelineage.md): Returns the lineage graph for an ingestion table by its ID. Resolves the table's fully-qualified name from its connection and target database, schema and table, then returns the same result as the ass - [GET /platform-config/proxy/dl-platform/lineage/processes/{processType}/{processEntityId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getprocessrows.md): Returns the raw lineage edges recorded by a single process. processType is PIPELINE_RUN or INGESTION and processEntityId identifies that run. - [DELETE /platform-config/proxy/dl-platform/lineage/processes/{processType}/{processEntityId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/deleteprocess.md): Deletes every lineage edge recorded by the given process and returns the number of rows removed. - [GET /platform-config/proxy/dl-platform/lineage/assets/{fqn}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getassetlineage.md): Returns the lineage graph for the asset with the given fully-qualified name. Use direction to select upstream, downstream or both, transitive to walk the full chain instead of only direct edges, and a - [GET /platform-config/proxy/dl-platform/knowledge-clusters/{kcId}/hooks/{hookId}/usage](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/usage.md): Returns the pipelines that reference the given Job Hook, with the phase each one uses it in - [GET /platform-config/proxy/dl-platform/jobs/{jobId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getjobbyid.md): Returns a single Job by their unique ID - [GET /platform-config/proxy/dl-platform/jobs/{jobId}/summaries](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getjobsummaries.md): Returns execution summaries/logs for a job - [GET /platform-config/proxy/dl-platform/jobs/{jobId}/stats](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getjobstats.md): Returns the per-statement row counts of a pipeline run, plus the run totals - [GET /platform-config/proxy/dl-platform/jobs/{jobId}/logs/download](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/downloadjoblogs.md): Streams a zip with the per-job application log (job_.log) and the concatenated job summaries (job_summaries_.txt) for a single run. Each artifact is omitted when absent. - [GET /platform-config/proxy/dl-platform/configPortability/export](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/export.md): Returns the entity configuration as a downloadable JSON file - [GET /platform-config/proxy/dl-platform/compute-connectors/{platform}/{computeType}/defaults](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getdefaults.md): Get default configurations for compute - [GET /platform-config/proxy/dl-platform/applications](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/list_2.md): Returns details of all applications spawned by the given Job ID - [GET /platform-config/proxy/dl-platform/applications/{applicationId}](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getbyid_1.md): Returns details of the given Application ID - [GET /platform-config/proxy/dl-platform/applications/{applicationId}/logs](https://docs.businessai.uniphorecloud.com/api-reference/api/data-layer/getapplicationlogs.md): Fetches the logs for a given Application ID ## Inferencing - [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. - [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. - [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. - [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. - [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. - [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. - [POST /inferencing/uniphore/v1/classify](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/classify_uniphore_v1_classify_post.md): Classify input strings using an NLI/classification model (e.g. entailment/neutral/contradiction). - [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. - [POST /inferencing/uniphore/v1/predict](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/predict_uniphore_v1_predict_post.md): Classify input strings using a TEI-backed text-classification model (native TEI /predict response shape). - [POST /inferencing/uniphore/v1/systemone/decide](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/decide_uniphore_v1_systemone_decide_post.md): Ask a batch of typed questions (noul/score/choice) about a state string, via laya-serve's native /v1/systemone response shape. - [POST /inferencing/uniphore/v1/systemone/rank](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/rank_uniphore_v1_systemone_rank_post.md): Rank candidate answers to a question in context, via clm-serve's native /v1/rank response shape. - [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 - [GET /meta-prompting/v1/prompts](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/list_prompts_v1_prompts_get.md) - [POST /meta-prompting/v1/prompts](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/create_prompt_v1_prompts_post.md) - [POST /meta-prompting/v1/validate](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/validate_prompt_title_v1_validate_post.md) - [GET /meta-prompting/v1/prompts/history](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/list_prompt_histories_v1_prompts_history_get.md) - [POST /meta-prompting/v1/prompts/generate](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/generate_prompt_v1_prompts_generate_post.md) - [POST /meta-prompting/v1/prompts/optimize](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/optimize_prompt_v1_prompts_optimize_post.md) - [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) - [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) - [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 /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 /meta-prompting/v1/prompts/{prompt_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_v1_prompts__prompt_id__get.md) - [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. - [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) - [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) - [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 /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 /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 /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 /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) - [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) - [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) - [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) ## Platform Config - [GET /platform-config/v1/slm](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/list.md) - [POST /platform-config/v1/slm](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/create.md) - [GET /platform-config/v1/jobs](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listjobs.md) - [POST /platform-config/v1/lora](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/notifyloradeployment.md) - [POST /platform-config/v1/audit](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listauditlogs.md) - [POST /platform-config/v1/api-key](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createkey.md): Creates a new API Key - [GET /platform-config/v1/slm/all](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listallmodels.md) - [GET /platform-config/v1/sources](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listsources.md) - [POST /platform-config/v1/sources](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createsource.md) - [GET /platform-config/v1/jobs/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getjob.md) - [GET /platform-config/v1/questions](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getquestions.md) - [POST /platform-config/v1/questions](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/askquestion.md) - [POST /platform-config/v1/slm/infer](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/infer.md) - [GET /platform-config/v1/workflows](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listworkflows.md) - [POST /platform-config/v1/workflows](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createworkflow.md) - [GET /platform-config/v1/slm/{slmId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/get_1.md) - [PUT /platform-config/v1/api-key/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updatekey.md): Updates an existing API Key - [GET /platform-config/v1/destinations](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listdestinations.md) - [POST /platform-config/v1/destinations](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createdestination.md) - [POST /platform-config/v1/slm/requests](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/request.md) - [DELETE /platform-config/v1/sources/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/deletesource.md): Deletes a source connector - [GET /platform-config/v1/audit/archive](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listarchives.md) - [POST /platform-config/v1/configuration](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/create_1.md) - [GET /platform-config/v1/slm/catalogue](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listcatalogue.md) - [GET /platform-config/v1/api-key/masked](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getpagedkeysmasked.md): Fetches a paged list of API Keys with the value masked (4 leading + 3 trailing chars visible) - [GET /platform-config/v1/workflows/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getworkflow.md) - [PUT /platform-config/v1/workflows/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updateworkflow.md) - [DELETE /platform-config/v1/workflows/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/deleteworkflow.md) - [GET /platform-config/v1/embedder/models](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/list_3.md) - [GET /platform-config/v1/knowledge_bases](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/list_2.md) - [GET /platform-config/v1/jobs/{id}/cancel](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/abortjob.md) - [DELETE /platform-config/v1/destinations/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/deletedestination.md): Deletes a destination connector - [GET /platform-config/v1/jobs/{id}/details](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getjobdetails.md) - [GET /platform-config/v1/sources/test/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/testsource.md) - [GET /platform-config/v1/sources/{sourceId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getsource.md) - [PUT /platform-config/v1/sources/{sourceId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updatesource.md) - [GET /platform-config/v1/workflows/template](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/gettemplate.md) - [POST /platform-config/v1/workflows/validate](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/validateworkflow.md) - [POST /platform-config/v1/workflows/{id}/run](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/executeworkflow.md) - [GET /platform-config/v1/api-key/masked/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getkeybyidmasked.md): Fetches an API Key by its ID with the value masked (4 leading + 3 trailing chars visible) - [GET /platform-config/v1/jobs/subscribe/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/subscribe.md) - [GET /platform-config/v1/configuration/{type}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/list_4.md) - [GET /platform-config/v1/knowledge_bases/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/get_2.md) - [POST /platform-config/v1/workflows/experiment](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createworkflowfordocumenttype.md) - [GET /platform-config/v1/knowledge_bases/stats](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/kbstats.md): Gets stats of knowledgebases - [GET /platform-config/v1/slm/{slmId}/questions](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listquestions.md) - [GET /platform-config/v1/audit/config/retention](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getretentionconfig.md) - [PUT /platform-config/v1/audit/config/retention](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updateretentionconfig.md) - [GET /platform-config/v1/audit/current/download](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/downloadcurrentaudit.md) - [GET /platform-config/v1/destinations/test/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/testdestination.md) - [GET /platform-config/v1/jobs/{id}/failed-files](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getfailedfiles.md) - [DELETE /platform-config/v1/workflows/experiment/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/deletetemplate.md) - [GET /platform-config/v1/jobs/subscribe/{id}/details](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/subscribejobdetails.md) - [GET /platform-config/v1/audit/archive/{archiveMonth}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getarchivebymonth.md) - [POST /platform-config/v1/crawler/source_ids_paginated](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getsourceidspaginated.md) - [GET /platform-config/v1/destinations/{destinationId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getdestination.md) - [PUT /platform-config/v1/destinations/{destinationId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updatedestination.md) - [POST /platform-config/v1/questions/{question_id}/chart](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/generatechart.md) - [GET /platform-config/v1/audit/archive/id/{id}/download](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/downloadarchivebyid.md) - [GET /platform-config/v1/embedder/models/{embedderModelId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/get_3.md) - [DELETE /platform-config/v1/knowledge_bases/{knowledgeBaseId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/delete.md): Deletes a knowledgebase - [PUT /platform-config/v1/knowledge_bases/{knowledge_base_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/update.md) - [POST /platform-config/v1/slm/questions/{questionId}/feedback](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/submitfeedback.md) - [GET /platform-config/v1/audit/archive/{archiveMonth}/download](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/downloadarchive.md) - [GET /platform-config/v1/crawler/crawl_request_body/{workflow_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getcrawlrequestbody.md) - [POST /platform-config/v1/slm_to_knowledgebase/{knowledge_base_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/slmpairing.md) - [POST /platform-config/v1/knowledge_bases/{knowledge_base_id}/groups](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/assign.md) ## User Management - [GET /user-management/v2/groups](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/list.md): Optional filters: search (case-insensitive substring on group_name), source. Optional active=true|false — true returns only 'active' groups; false returns everything else (inactive/suspended/deprovisi - [POST /user-management/v1/users](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/createuser.md): Creates a new User - [PUT /user-management/v1/users](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/updateuser.md): Updates a User - [GET /user-management/v1/users/{userId}/roles](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getuserroles.md): Returns the role assigned to a user - [PUT /user-management/v1/users/{userId}/roles](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/updateuserroles.md): Assigns or replaces the role for a user - [GET /user-management/v1/users/{userId}/domains/{domainId}/metadata](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getmetadata.md): Gets the domain metadata for a user - [PUT /user-management/v1/users/{userId}/domains/{domainId}/metadata](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/setmetadata.md): Replaces the domain metadata for a user - [GET /user-management/v1/roles/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getrolebyid.md): Returns a role by ID - [PUT /user-management/v1/roles/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/updaterole.md): Updates a role - [DELETE /user-management/v1/roles/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/deleterole.md): Deletes a role. 409 ROLE_IS_SYSTEM on baseline roles; 409 ROLE_IN_USE with impact-list details if any users or groups are still bound (unbind first). 204 on success. - [GET /user-management/v1/rbac-config](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getconfig.md): Returns the current per-tenant RBAC configuration (default role, SCIM JIT toggle, conflict policy). Served from the in-process cache; no DB round-trip on the happy path. - [PUT /user-management/v1/rbac-config](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/updateconfig.md): Partial update of the tenant RBAC config; refreshes the in-process cache on commit. At least one field must be provided. - [GET /user-management/v1/permissions/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getpermission.md): Returns a permission by ID - [GET /user-management/v1/domains](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/list_1.md): Lists all domains for a given tenant - [POST /user-management/v1/domains](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/create_1.md): Creates a new domain - [PUT /user-management/v1/domains](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/update_1.md): Updates an existing domain - [GET /user-management/scim/v2/Users/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getuser.md): Returns a SCIM user by ID - [PUT /user-management/scim/v2/Users/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/replaceuser.md): Replaces all attributes of a SCIM user - [DELETE /user-management/scim/v2/Users/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/deleteuser.md): Deprovisions a SCIM user - [PATCH /user-management/scim/v2/Users/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/patchuser.md): Partially updates a SCIM user - [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 - [GET /user-management/v1/users/{userId}/domains](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getuserdomains.md): Lists all domain assignments for a user with their metadata - [POST /user-management/v1/users/{userId}/domains](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/assigndomain.md): Assigns a domain to a user with optional metadata - [POST /user-management/v1/users/search](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/searchusers.md): Advanced Searches Users with search criterion - [POST /user-management/v1/users/count](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/countusers.md): Returns the total number of users matching the same filter used by POST /v1/users/search. Pagination and sort fields in the request are ignored. - [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. - [POST /user-management/v1/roles](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/createrole.md): Creates a new role - [GET /user-management/v1/roles/{id}/permissions](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getrolepermissions.md): Returns all permissions assigned to a role - [PATCH /user-management/v1/roles/{id}/permissions](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/patchpermissions.md): Atomic add + remove of permissions on a role in a single transaction. Returns the merged resource (full post-write permission set). 409 ROLE_IS_SYSTEM on baseline roles; 400 CONFLICTING_DELTA when add - [GET /user-management/v1/permissions](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/listpermissions.md): Returns a paginated list of permissions for a tenant - [GET /user-management/v1/api-keys](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/listapikeys.md): Lists all API keys for a tenant (metadata only, no hashes or plaintext). - [POST /user-management/v1/api-keys](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/createapikey.md): Creates a new API key for a tenant. Returns the plaintext key once. - [POST /user-management/v1/api-keys/validate](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/validateapikey.md): Validates an API key. Open endpoint — no authentication required. Called by pod-to-pod services. - [GET /user-management/scim/v2/Users](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/listusers.md): Returns a paginated list of SCIM users - [POST /user-management/scim/v2/Users](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/createuser_1.md): Provisions a new SCIM user - [GET /user-management/scim/v2/Groups](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/listgroups.md): Returns a paginated list of SCIM groups - [POST /user-management/scim/v2/Groups](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/creategroup.md): Provisions a new SCIM group - [GET /user-management/v1/roles/{id}/groups](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getmappedgroups.md): Returns the role plus the groups currently conferring it (via xf_group_role_rel). - [PATCH /user-management/v1/roles/{id}/groups](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/addmappedgroups.md): Batch-adds one or more groups to this role in a single transaction. Non-stealing: 200 on success, 409 GROUP_ALREADY_MAPPED with a list of conflicts if any input group is currently mapped to a differen - [GET /user-management/v1/api-keys/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getapikey.md): Returns a single API key's metadata. - [DELETE /user-management/v1/api-keys/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/revokeapikey.md): Revokes (soft deletes) an API key. - [PATCH /user-management/v1/api-keys/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/updateapikey.md): Updates API key metadata (name, scopes, expiry). - [GET /user-management/scim/v2/Groups/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getgroup.md): Returns a SCIM group by ID - [DELETE /user-management/scim/v2/Groups/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/deletegroup.md): Deprovisions a SCIM group - [PATCH /user-management/scim/v2/Groups/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/patchgroup.md): Partially updates a SCIM group and its members - [GET /user-management/v1/users/{userId}/effective-permissions](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getusereffectivepermissions.md): Admin view of another user's resolved permission set (module:operation slugs). - [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 /user-management/v1/users/me](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getcurrentuserdetail.md): Reads the loggedIn User details - [GET /user-management/v1/provisioning/group-role-mappings](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/listgroupmappings.md): Cross-role view of xf_group_role_rel, newest first. Optional case-insensitive source filter. - [GET /user-management/v1/permissions/catalog](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getcatalog.md): Returns the module-grouped catalog. Optional ?source= filter (case-insensitive). Omitted defaults to source='seed' — the baseline rows the platform ships with. Reserved value 'all' returns every row a - [GET /user-management/v1/domains/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getbyid_1.md): Reads a domain by ID - [DELETE /user-management/v1/domains/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/delete_1.md): Deletes a domain and its user assignments - [GET /user-management/scim/v2/ServiceProviderConfig](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/serviceproviderconfig.md): Returns supported SCIM features and authentication schemes - [GET /user-management/scim/v2/Schemas](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/schemas.md): Returns SCIM schema definitions for User and Group - [GET /user-management/scim/v2/ResourceTypes](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/resourcetypes.md): Returns supported SCIM resource types (User, Group) - [DELETE /user-management/v1/users/{userId}/roles/{roleId}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/revokeuserrole.md): Revokes one direct role grant. 404 if not assigned; 409 USER_ROLE_MINIMUM_REQUIRED if it would leave the user with zero roles. - [DELETE /user-management/v1/users/{userId}/domains/{domainId}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/removedomain.md): Removes a domain assignment from a user - [DELETE /user-management/v1/roles/{id}/groups/{groupId}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/removemappedgroup.md): Deletes the xf_group_role_rel row where role_id = {id} AND group_id = {groupId} and cascades a set-difference reconcile over the group's members. Fails with 409 UNMAP_WOULD_STRIP_LAST_ROLE if any affe - [PUT /user-management/v1/permissions/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/updatepermission.md): Deprecated: permission catalog is seed-managed; runtime update is retained for backwards compatibility. - [DELETE /user-management/v1/permissions/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/deletepermission.md): Deprecated: permission catalog is seed-managed; runtime delete is retained for backwards compatibility. - [POST /user-management/v1/roles/{id}/permissions](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/assignpermissions.md): Deprecated: use PATCH /v1/roles/{id}/permissions — strict superset, atomic add+remove in one transaction. - [DELETE /user-management/v1/roles/{id}/permissions](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/unassignpermissions.md): Deprecated: use PATCH /v1/roles/{id}/permissions — strict superset, atomic add+remove in one transaction. - [POST /user-management/v1/permissions](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/createpermission.md): Deprecated: permission catalog is seed-managed; runtime create is retained for backwards compatibility.