# 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-x-forge.dev.uniphorecloud.com ``` ## Security ### Agents.bearerAuth Type: http Scheme: bearer Bearer Format: JWT ### Darwin.bearerAuth Type: http Scheme: bearer Bearer Format: JWT ### Orchestrator.bearerAuth Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Uniphore Business AI Cloud](https://docs.businessai.uniphorecloud.com/_spec/API%20Reference/api.yaml) ## Action Orchestrator APIs for Actions Orchestration. ### List All Categories - [GET /action-orchestrator/v1/categories](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_categories_v1_categories_get.md): Retrieve a list of categories. Parameters: - tenant_id: Identifier for the tenant. - configuration_service: Service to fetch categories. Returns: - A list of categories matching the criteria. ### List All Integrations - [GET /action-orchestrator/v1/integrations](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_integrations_v1_integrations_get.md): Retrieve a list of integrations. Parameters: - tenant_id: Identifier for the tenant. - configuration_service: Service to fetch integrations. Returns: - A list of integrations matching the criteria. ### Save Integration - [POST /action-orchestrator/v1/integrations](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/save_integration_v1_integrations_post.md): save integration Parameters: - tenant_id: Identifier for the tenant. Returns: - status. ### Delete Integration - [DELETE /action-orchestrator/v1/integrations/{integration_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/delete_integration_v1_integrations__integration_id__delete.md): Delete Integration Parameters: - tenant_id: Identifier for the tenant. - configuration_service: Service to fetch integrations. Returns: - status: ### Get Access Params - [GET /action-orchestrator/v1/integrations/{integration_id}/access_params](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_access_params_v1_integrations__integration_id__access_params_get.md): get_access_params Parameters: - tenant_id: Identifier for the tenant. - configuration_service: Service to fetch integrations. Returns: - status: ### Save Access Params - [POST /action-orchestrator/v1/integrations/{integration_id}/access_params](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/save_access_params_v1_integrations__integration_id__access_params_post.md): save_access_params Parameters: - tenant_id: Identifier for the tenant. - configuration_service: Service to fetch integrations. Returns: - status: ### Get Workato User Mapper - [GET /action-orchestrator/v1/integrations/workato/connection_mapper](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_workato_user_mapper_v1_integrations_workato_connection_mapper_get.md): Retrieve a workato user_mapper. Parameters: - tenant_id: Identifier for the tenant. ### Save User Mapper - [POST /action-orchestrator/v1/integrations/workato/connection_mapper](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/save_user_mapper_v1_integrations_workato_connection_mapper_post.md): save user_mapper Parameters: - tenant_id: Identifier for the tenant. Returns: - status. ### Get Integration Resources - [POST /action-orchestrator/v1/integrations/resources](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_integration_resources_v1_integrations_resources_post.md): Save integration Parameters: - tenant_id: Identifier for the tenant. - request: List of integration strings. - user_id: ID of the user making the request. Returns: - CommonResponse with status. ### List All Actions - [GET /action-orchestrator/v1/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_actions_v1_actions_get.md): Retrieve a list of actions. Parameters: - tenant_id: Identifier for the tenant. - configuration_service: Service to fetch actions. Returns: - A list of actions matching the criteria. ### Save Action - [POST /action-orchestrator/v1/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/save_action_v1_actions_post.md): save action Parameters: - tenant_id: Identifier for the tenant. Returns: - status. ### Actions Count - [GET /action-orchestrator/v1/actions/count](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/actions_count_v1_actions_count_get.md): Retrieve a Actions count. Parameters: - tenant_id: Identifier for the tenant. Returns: - A Actions count matching the criteria. ### Test Mcp Registry Connection - [POST /action-orchestrator/v1/actions/mcp/servers/registry/connection-test](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/test_mcp_registry_connection_v1_actions_mcp_servers_registry_connection_test_post.md): Test Mcp Registry Connection Parameters: - tenant_id: Identifier for the tenant. Returns: - status. ### Get Mcp Registry Connection - [GET /action-orchestrator/v1/actions/mcp/servers/registry/connection](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_mcp_registry_connection_v1_actions_mcp_servers_registry_connection_get.md): Get Mcp Registry Connection Parameters: - tenant_id: Identifier for the tenant. Returns: - Mcp Registry Connection Details. ### Mcp Registry Connection - [POST /action-orchestrator/v1/actions/mcp/servers/registry/connection](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/mcp_registry_connection_v1_actions_mcp_servers_registry_connection_post.md): Mcp Registry Connection Parameters: - tenant_id: Identifier for the tenant. Returns: - status. ### List Mcp Servers - [GET /action-orchestrator/v1/actions/mcp/servers](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_mcp_servers_v1_actions_mcp_servers_get.md): Get list mcp servers Parameters: - tenant_id: Identifier for the tenant. Returns: - list mcp servers matching the criteria. ### Count Mcp Servers - [GET /action-orchestrator/v1/actions/mcp/servers/count](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/count_mcp_servers_v1_actions_mcp_servers_count_get.md): mcp servers count Parameters: - tenant_id: Identifier for the tenant. Returns: - count mcp servers ### List All Mcp Servers - [GET /action-orchestrator/v1/actions/mcp/servers/search](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_mcp_servers_v1_actions_mcp_servers_search_get.md): Retrieve a List all mcp servers. Parameters: - tenant_id: Identifier for the tenant. Returns: - A list of mcp servers matching the criteria. ### Get Mcp Server Registry - [GET /action-orchestrator/v1/actions/mcp/servers/registry](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_mcp_server_registry_v1_actions_mcp_servers_registry_get.md): Get mcp server registry Parameters: - tenant_id: Identifier for the tenant. Returns: - status. ### Registry Mcp Server - [POST /action-orchestrator/v1/actions/mcp/servers/registry](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/registry_mcp_server_v1_actions_mcp_servers_registry_post.md): Registry mcp server Parameters: - tenant_id: Identifier for the tenant. Returns: - status. ### Test Mcp Server Connection - [POST /action-orchestrator/v1/actions/mcp/servers/connection-test](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/test_mcp_server_connection_v1_actions_mcp_servers_connection_test_post.md): test mcp server connection Parameters: - tenant_id: Identifier for the tenant. Returns: - connection status. ### Get Mcp Server Details - [GET /action-orchestrator/v1/actions/mcp/servers/{qualified_name}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_mcp_server_details_v1_actions_mcp_servers__qualified_name__get.md): Get mcp server details Parameters: - tenant_id: Identifier for the tenant. Returns: - mcp server details matching the criteria. ### Upload Openapi Spec File - [POST /action-orchestrator/v1/actions/openapi-file-upload](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/upload_openapi_spec_file_v1_actions_openapi_file_upload_post.md): Openapi file upload. ### List All Integrations - [GET /action-orchestrator/v1/workato-integrations](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/list_all_integrations_v1_workato_integrations_get.md) ### Get Integration - [GET /action-orchestrator/v1/workato-integrations/{integration}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_integration_v1_workato_integrations__integration__get.md) ### Get Workato Action - [GET /action-orchestrator/v1/workato-actions/{action_name}](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_workato_action_v1_workato_actions__action_name__get.md) ### Get Actions As Functions - [GET /action-orchestrator/v1/actions/functions](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/get_actions_as_functions_v1_actions_functions_get.md) ### Fetch Actions As Functions - [POST /action-orchestrator/v1/actions/functions](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/fetch_actions_as_functions_v1_actions_functions_post.md) ### Action Code Snippet - [POST /action-orchestrator/v1/actions/code-snippets](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/action_code_snippet_v1_actions_code_snippets_post.md): Action Code Snippet ### Execute Action - [POST /action-orchestrator/v1/actions/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/execute_action_v1_actions_execute_post.md): Execute Action. ### Upload The File Resource - [POST /action-orchestrator/v1/actions/resource-upload](https://docs.businessai.uniphorecloud.com/api-reference/api/action-orchestrator/upload_the_file_resource_v1_actions_resource_upload_post.md): file upload. ## Agents APIs for Agents. ### Create Crews - [POST /crewai-agents/api/v1/crews](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/create_crews_api_v1_crews_post.md) ### Delete All Crews - [DELETE /crewai-agents/api/v1/crews](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/delete_all_crews_api_v1_crews_delete.md) ### Get Crews - [GET /crewai-agents/api/v1/crews/{crew_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_crews_api_v1_crews__crew_id__get.md) ### Update Crews - [PUT /crewai-agents/api/v1/crews/{crew_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/update_crews_api_v1_crews__crew_id__put.md) ### Delete Crews - [DELETE /crewai-agents/api/v1/crews/{crew_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/delete_crews_api_v1_crews__crew_id__delete.md) ### Crew Execution - [POST /crewai-agents/api/v1/crews/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/crew_execution_api_v1_crews_execute_post.md) ### Generate Crews - [POST /crewai-agents/api/v1/crews/generate](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/generate_crews_api_v1_crews_generate_post.md) ### Get All Agents - [GET /crewai-agents/api/v1/agents](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_all_agents_api_v1_agents_get.md) ### Create Crewai Agents - [POST /crewai-agents/api/v1/agents](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/create_crewai_agents_api_v1_agents_post.md) ### Delete All Agents - [DELETE /crewai-agents/api/v1/agents](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/delete_all_agents_api_v1_agents_delete.md) ### Get Agents - [GET /crewai-agents/api/v1/agents/{agent_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agents_api_v1_agents__agent_id__get.md) ### Update Agents - [PUT /crewai-agents/api/v1/agents/{agent_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/update_agents_api_v1_agents__agent_id__put.md) ### Delete Agents - [DELETE /crewai-agents/api/v1/agents/{agent_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/delete_agents_api_v1_agents__agent_id__delete.md) ### Agent Execution - [POST /crewai-agents/api/v1/agents/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/agent_execution_api_v1_agents_execute_post.md) ### Generate Agents - [POST /crewai-agents/api/v1/agents/generate](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/generate_agents_api_v1_agents_generate_post.md) ### Prompt Suggestions - [GET /crewai-agents/api/v1/agents/{agent_id}/prompt-suggestions](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/prompt_suggestions_api_v1_agents__agent_id__prompt_suggestions_get.md) ### Get Agent Runs - [GET /crewai-agents/api/v1/agent-runs](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_runs_api_v1_agent_runs_get.md) ### Get Agent Output Schema - [GET /crewai-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) ## Darwin APIs for Darwin. ### List All Actions - [GET /darwin/v1/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/list_all_actions_v1_actions_get.md): Retrieve a list of actions. Parameters: - tenant_id: Identifier for the tenant. - configuration_service: Service to fetch actions. Returns: - A list of actions matching the criteria. ### Save Action - [POST /darwin/v1/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/save_action_v1_actions_post.md): save action Parameters: - tenant_id: Identifier for the tenant. Returns: - status. ### Delete Integration - [DELETE /darwin/v1/actions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/delete_integration_v1_actions_delete.md): Delete Actions Parameters: - tenant_id: Identifier for the tenant. Returns: - status: ### Actions Count Per Integration - [GET /darwin/v1/actions/count](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/actions_count_per_integration_v1_actions_count_get.md): Retrieve a list of actions. Parameters: - tenant_id: Identifier for the tenant. - configuration_service: Service to fetch actions. Returns: - A list of actions matching the criteria. ### Fetch Action Parameters - [POST /darwin/v1/action-parameters](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/fetch_action_parameters_v1_action_parameters_post.md): Retrieve a Fetch Action parameters. Parameters: - tenant_id: Identifier for the tenant. - action_service: Service to fetch actions. Returns: - A actions details matching the criteria. ### Upload Openapi Spec File - [POST /darwin/v1/actions/openapi-file-upload](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/upload_openapi_spec_file_v1_actions_openapi_file_upload_post.md): Openapi file upload. ### Get Workato User Mapper - [GET /darwin/v1/integrations/workato/connection_mapper](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/get_workato_user_mapper_v1_integrations_workato_connection_mapper_get.md): Retrieve a workato connection_mapper. Parameters: - tenant_id: Identifier for the tenant. ### Save User Mapper - [POST /darwin/v1/integrations/workato/connection_mapper](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/save_user_mapper_v1_integrations_workato_connection_mapper_post.md): save connection_mapper Parameters: - tenant_id: Identifier for the tenant. Returns: - status. ### Get Access Params - [GET /darwin/v1/integrations/{integration_name}/access_params](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/get_access_params_v1_integrations__integration_name__access_params_get.md): get_access_params Parameters: - tenant_id: Identifier for the tenant. - configuration_service: Service to fetch integrations. Returns: - status: ### Save Access Params - [POST /darwin/v1/integrations/{integration_name}/access_params](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/save_access_params_v1_integrations__integration_name__access_params_post.md): save_access_params Parameters: - tenant_id: Identifier for the tenant. - configuration_service: Service to fetch integrations. Returns: - status: ### Get Actions As Functions - [GET /darwin/v1/actions/functions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/get_actions_as_functions_v1_actions_functions_get.md) ### Fetch Actions As Functions - [POST /darwin/v1/actions/functions](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/fetch_actions_as_functions_v1_actions_functions_post.md) ### Execute Actions - [POST /darwin/v1/actions/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/execute_actions_v1_actions_execute_post.md): Execute Action. ### Download File - [GET /darwin/v1/reports/downloads/{file}](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/download_file_v1_reports_downloads__file__get.md) ### Execute Actions - [POST /darwin/v1/actions/custom/execute](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/execute_actions_v1_actions_custom_execute_post.md): Execute an Action. Request Body: - tenant_id: Identifier for the tenant. - configuration_service: Service to fetch actions. - action_id: Identifier for the Action. - action_name: Name of the Action. - user_id: Identifier of the User. - action_params: Parameters of the Action. - message: Message/Command for the Action. Returns: - An Action Execution response. ### Slack Callback - [GET /darwin/auth/slack/callback](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/slack_callback_auth_slack_callback_get.md) ### Get Auth Url Generate - [GET /darwin/auth/generate-url](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/get_auth_url_generate_auth_generate_url_get.md) ### Get Auth Url - [GET /darwin/auth/status](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/get_auth_url_auth_status_get.md) ### Outlook Callback - [POST /darwin/auth/outlook/callback](https://docs.businessai.uniphorecloud.com/api-reference/api/darwin/outlook_callback_auth_outlook_callback_post.md) ## Evaluation APIs for Evaluation of models ### Upload Xlsx - [POST /evaluation/upload-ground-truth](https://docs.businessai.uniphorecloud.com/api-reference/api/evaluation/upload_xlsx_upload_ground_truth_post.md) ### Upload Csv - [POST /evaluation/upload-ground-truth-csv](https://docs.businessai.uniphorecloud.com/api-reference/api/evaluation/upload_csv_upload_ground_truth_csv_post.md) ### Download Csv - [GET /evaluation/download-ground-truth](https://docs.businessai.uniphorecloud.com/api-reference/api/evaluation/download_csv_download_ground_truth_get.md) ### Get Jobs - [GET /evaluation/job](https://docs.businessai.uniphorecloud.com/api-reference/api/evaluation/get_jobs_job_get.md) ### Get Job - [GET /evaluation/job/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/evaluation/get_job_job__id__get.md) ### Create Eval Batch Job - [POST /evaluation/batch/evaluate](https://docs.businessai.uniphorecloud.com/api-reference/api/evaluation/create_eval_batch_job_batch_evaluate_post.md) ### Download Csv - [GET /evaluation/metrics/download/{job_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/evaluation/download_csv_metrics_download__job_id__get.md) ### Get Latest Job Metrics - [GET /evaluation/metrics](https://docs.businessai.uniphorecloud.com/api-reference/api/evaluation/get_latest_job_metrics_metrics_get.md) ### Get Metrics By Job Id - [GET /evaluation/metrics/{job_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/evaluation/get_metrics_by_job_id_metrics__job_id__get.md) ## Inferencing Pegasus APIs for Inferencing. ### List Models - [GET /inferencing/openai/v1/models](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/list_models_openai_v1_models_get.md): Lists the currently available models, and provides basic information about each one. ### Chat Completions - [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 model response for the given chat conversation. ### Create Embeddings - [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 representing the input text. ### Show available models - [GET /inferencing/uniphore/v1/models](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/list_models_uniphore_v1_models_get.md): List all available models in the Pegasus Inference API. ### Show available setups - [GET /inferencing/uniphore/v1/setups](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/list_setups_uniphore_v1_setups_get.md) ### Show available LLMs - [GET /inferencing/uniphore/v1/models/llms](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/list_llms_uniphore_v1_models_llms_get.md): List all available LLMs in the Pegasus Inference API. ### Show available VLMs - [GET /inferencing/uniphore/v1/models/vlms](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/list_vlms_uniphore_v1_models_vlms_get.md): List all available VLMs in the Pegasus Inference API. ### Show available embedders - [GET /inferencing/uniphore/v1/models/embedders](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/list_embedders_uniphore_v1_models_embedders_get.md): List all available embedders in the Pegasus Inference API. ### Show available rankers - [GET /inferencing/uniphore/v1/models/rankers](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/list_rankers_uniphore_v1_models_rankers_get.md): List all available rankers in the Pegasus Inference API. ### Show available guardrails - [GET /inferencing/uniphore/v1/models/guardrails](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/list_guardrails_uniphore_v1_models_guardrails_get.md): List all available guardrails in the Pegasus Inference API. ### Nemoguard Jailbreak Detect - [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): Inference to Nemoguard Jailbreak Detect model. ### Ranker - [POST /inferencing/uniphore/v1/ranker](https://docs.businessai.uniphorecloud.com/api-reference/api/inferencing/ranker_uniphore_v1_ranker_post.md): Inference to Ranker models. ## Meta Prompting APIs for Meta Prompting & Prompt Management. ### Validate Prompt Title - [POST /meta-prompting/v1/validate](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/validate_prompt_title_v1_validate_post.md) ### List Prompts - [GET /meta-prompting/v1/prompts](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/list_prompts_v1_prompts_get.md) ### Create Prompt - [POST /meta-prompting/v1/prompts](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/create_prompt_v1_prompts_post.md) ### List Prompt Histories - [GET /meta-prompting/v1/prompts/history](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/list_prompt_histories_v1_prompts_history_get.md) ### Get Prompt - [GET /meta-prompting/v1/prompts/{prompt_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_v1_prompts__prompt_id__get.md) ### Hard Delete Prompt - [DELETE /meta-prompting/v1/prompts/{prompt_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/hard_delete_prompt_v1_prompts__prompt_id__delete.md): Hard delete a prompt and all its versions. ### Update Prompt - [PATCH /meta-prompting/v1/prompts/{prompt_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/update_prompt_v1_prompts__prompt_id__patch.md) ### Update Prompt Activate Version - [PATCH /meta-prompting/v1/prompts/{prompt_id}/versions/{version_id}/activate](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/update_prompt_activate_version_v1_prompts__prompt_id__versions__version_id__activate_patch.md) ### Update Prompt Activate Version Number - [PATCH /meta-prompting/v1/prompts/{prompt_id}/versions/number/{version_number}/activate](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/update_prompt_activate_version_number_v1_prompts__prompt_id__versions_number__version_number__activate_patch.md) ### Get Prompt Version By Id - [GET /meta-prompting/v1/versions/{version_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_version_by_id_v1_versions__version_id__get.md) ### Get Prompt Version By Number - [GET /meta-prompting/v1/prompts/{prompt_id}/versions/number/{version_number}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_version_by_number_v1_prompts__prompt_id__versions_number__version_number__get.md) ### List Prompt History - [GET /meta-prompting/v1/prompts/{prompt_id}/history](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/list_prompt_history_v1_prompts__prompt_id__history_get.md) ### Generate Prompt - [POST /meta-prompting/v1/prompts/generate](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/generate_prompt_v1_prompts_generate_post.md) ### Describe Image Llama - [POST /meta-prompting/v1/prompts/image/try](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/describe_image_llama_v1_prompts_image_try_post.md) ### Generate Llama Response - [POST /meta-prompting/v1/prompts/text/try](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/generate_llama_response_v1_prompts_text_try_post.md) ### Get Prompt Types - [GET /meta-prompting/v1/prompts/meta/types](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_types_v1_prompts_meta_types_get.md) ### Get Prompt Categories - [GET /meta-prompting/v1/prompts/meta/categories](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_categories_v1_prompts_meta_categories_get.md) ### Get Prompt Domains - [GET /meta-prompting/v1/prompts/meta/domains](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_domains_v1_prompts_meta_domains_get.md) ### Get Prompt Tones - [GET /meta-prompting/v1/prompts/meta/tones](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_tones_v1_prompts_meta_tones_get.md) ### Get Prompt Languages - [GET /meta-prompting/v1/prompts/meta/languages](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_languages_v1_prompts_meta_languages_get.md) ### Get Prompt - [GET /meta-prompting/v2/prompts/{prompt_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/meta-prompting/get_prompt_v2_prompts__prompt_id__get.md) ## Platform Config APIs for Platform Setup - Workflows, Sources, Destinations, Knowledge Bases etc. ### Gets a workflow with id - [GET /platform-config/v1/workflows/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getworkflow.md) ### Updates provided workflow - [PUT /platform-config/v1/workflows/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updateworkflow.md) ### Deletes a workflow with id - [DELETE /platform-config/v1/workflows/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/deleteworkflow.md) ### Gets source connector for a tenantId by id. - [GET /platform-config/v1/sources/{sourceId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getsource.md) ### Updates the source connector for the given id. - [PUT /platform-config/v1/sources/{sourceId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updatesource.md) ### Updates knowledgebase name and description - [PUT /platform-config/v1/knowledge_bases/{knowledge_base_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/update.md) ### Gets destination connector for a tenantId by id. - [GET /platform-config/v1/destinations/{destinationId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getdestination.md) ### Updates the destination connector for the given id. - [PUT /platform-config/v1/destinations/{destinationId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/updatedestination.md) ### Lists workflows with filters - [GET /platform-config/v1/workflows](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listworkflows.md) ### Creates a workflow - [POST /platform-config/v1/workflows](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createworkflow.md) ### Executes provided workflow - [POST /platform-config/v1/workflows/{id}/run](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/executeworkflow.md) ### Validate a workflow - [POST /platform-config/v1/workflows/validate](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/validateworkflow.md) ### Creates an experiment workflow for a document type - [POST /platform-config/v1/workflows/experiment](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createworkflowfordocumenttype.md) ### Lists all the sources for a tenantId. - [GET /platform-config/v1/sources](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listsources.md) ### Create a new source connector. - [POST /platform-config/v1/sources](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createsource.md) ### SLM pairing with given knowledgebase id. - [POST /platform-config/v1/slm_to_knowledgebase/{knowledge_base_id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/slmpairing.md) ### questions - [GET /platform-config/v1/questions](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getquestions.md) ### Ask a Question - [POST /platform-config/v1/questions](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/askquestion.md) ### Generate chart - [POST /platform-config/v1/questions/{question_id}/chart](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/generatechart.md) ### Lists all the destinations for a tenantId. - [GET /platform-config/v1/destinations](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listdestinations.md) ### Create a new destination connector. - [POST /platform-config/v1/destinations](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/createdestination.md) ### Create configuration - [POST /platform-config/v1/configuration](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/create.md) ### Gets a template schema for the workflows - [GET /platform-config/v1/workflows/template](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/gettemplate.md) ### Test Source connector - [GET /platform-config/v1/sources/test/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/testsource.md) ### Get list of SLM - [GET /platform-config/v1/slm](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/list_1.md) ### Gets SLM by id. - [GET /platform-config/v1/slm/{slmId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/get_1.md) ### Get knowledgebases - [GET /platform-config/v1/knowledge_bases](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/list_2.md) ### Gets knowledgebase by id. - [GET /platform-config/v1/knowledge_bases/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/get_2.md) ### Lists jobs with filters - [GET /platform-config/v1/jobs](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/listjobs.md) ### Get job with id - [GET /platform-config/v1/jobs/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getjob.md) ### Get failure details for files in a job - [GET /platform-config/v1/jobs/{id}/failed-files](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getfailedfiles.md) ### Get job processing details - [GET /platform-config/v1/jobs/{id}/details](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/getjobdetails.md) ### Cancels job with id - [GET /platform-config/v1/jobs/{id}/cancel](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/abortjob.md) ### Subscribe to job status events - [GET /platform-config/v1/jobs/subscribe/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/subscribe.md) ### Subscribe to job processing details events - [GET /platform-config/v1/jobs/subscribe/{id}/details](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/subscribejobdetails.md) ### Get embedder models - [GET /platform-config/v1/embedder/models](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/list_3.md) ### Gets embedder model by id. - [GET /platform-config/v1/embedder/models/{embedderModelId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/get_3.md) ### Test destination connector - [GET /platform-config/v1/destinations/test/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/testdestination.md) ### Get configurations - [GET /platform-config/v1/configuration/{type}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/list_4.md) ### Cleanup for a template workflow with id - [DELETE /platform-config/v1/workflows/experiment/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/deletetemplate.md) ### Delete source connector by ID - [DELETE /platform-config/v1/sources/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/deletesource.md): Deletes a source connector ### Delete knowledgebase by ID - [DELETE /platform-config/v1/knowledge_bases/{knowledgeBaseId}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/delete.md): Deletes a knowledgebase ### Delete destination connector by ID - [DELETE /platform-config/v1/destinations/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/platform-config/deletedestination.md): Deletes a destination connector ## Question & Answer APIs for Question & Answering ### Post Question - [POST /question-answer/v1/question/](https://docs.businessai.uniphorecloud.com/api-reference/api/question-and-answer/post_question_v1_question__post.md): Request a question. ### Batch Question - [POST /question-answer/v1/question/batch](https://docs.businessai.uniphorecloud.com/api-reference/api/question-and-answer/batch_question_v1_question_batch_post.md): Request multiple answers in batch mode. ### Feedback Question - [POST /question-answer/v1/question/{question_id}/feedback](https://docs.businessai.uniphorecloud.com/api-reference/api/question-and-answer/feedback_question_v1_question__question_id__feedback_post.md): Providing feedback to a question. ### List Question - [POST /question-answer/v1/question/list](https://docs.businessai.uniphorecloud.com/api-reference/api/question-and-answer/list_question_v1_question_list_post.md): List questions. ### Post Chart - [POST /question-answer/v1/chart](https://docs.businessai.uniphorecloud.com/api-reference/api/question-and-answer/post_chart_v1_chart_post.md): Request a chart. ## Tag APIs for Tag. ### Fetch Metadata - [POST /tagging/api/v1/tag/fetch_metadata](https://docs.businessai.uniphorecloud.com/api-reference/api/tag/fetch_metadata_api_v1_tag_fetch_metadata_post.md) ### Get Table Relationships - [POST /tagging/api/v1/tag/get_table_relationships](https://docs.businessai.uniphorecloud.com/api-reference/api/tag/get_table_relationships_api_v1_tag_get_table_relationships_post.md) ### Update Table Relationships - [POST /tagging/api/v1/tag/update_table_relationships](https://docs.businessai.uniphorecloud.com/api-reference/api/tag/update_table_relationships_api_v1_tag_update_table_relationships_post.md) ### Get Table Description - [POST /tagging/api/v1/tag/get_table_description](https://docs.businessai.uniphorecloud.com/api-reference/api/tag/get_table_description_api_v1_tag_get_table_description_post.md) ### Update Descriptions - [POST /tagging/api/v1/tag/update_descriptions](https://docs.businessai.uniphorecloud.com/api-reference/api/tag/update_descriptions_api_v1_tag_update_descriptions_post.md) ### Get Table List - [GET /tagging/api/v1/tag/get_tables_list](https://docs.businessai.uniphorecloud.com/api-reference/api/tag/get_table_list_api_v1_tag_get_tables_list_get.md) ### Get Connector Schemas - [GET /tagging/api/v1/tag/get_source_connections](https://docs.businessai.uniphorecloud.com/api-reference/api/tag/get_connector_schemas_api_v1_tag_get_source_connections_get.md) ### Get Latest Connection Job Status - [GET /tagging/api/v1/tag/latest_job_status](https://docs.businessai.uniphorecloud.com/api-reference/api/tag/get_latest_connection_job_status_api_v1_tag_latest_job_status_get.md) ### Upload Csv - [POST /tagging/api/v1/tag/upload_csv](https://docs.businessai.uniphorecloud.com/api-reference/api/tag/upload_csv_api_v1_tag_upload_csv_post.md) ### Fetch Tables - [POST /tagging/api/v1/tag/fetch_tables](https://docs.businessai.uniphorecloud.com/api-reference/api/tag/fetch_tables_api_v1_tag_fetch_tables_post.md) ## User Management APIs for User Management - Users, Roles, Permissions etc. ### Update User - [PUT /user-management/v1/users](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/updateuser.md): Updates a User ### Create User - [POST /user-management/v1/users](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/createuser.md): Creates a new User ### Update User - [PUT /user-management/users](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/updateuser_1.md): Updates a User ### Create User - [POST /user-management/users](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/createuser_1.md): Creates a new User ### Advanced Search User - [POST /user-management/v1/users/search](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/searchusers.md): Advanced Searches Users with search criterion ### Advanced Search User - [POST /user-management/users/search](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/searchusers_1.md): Advanced Searches Users with search criterion ### Get Current loggedIn User - [GET /user-management/v1/users/me](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getcurrentuserdetail.md): Reads the loggedIn User details ### Get User - [GET /user-management/users/{id}](https://docs.businessai.uniphorecloud.com/api-reference/api/user-management/getuserdetail.md): Reads a User given user Id