# Agents

APIs for Agents.

 - [GET /forge-agents/api/v1/agents/by-all-groups](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/list_all_agent_groups_api_v1_agents_by_all_groups_get.md): Admin-only: return all groups and their agent mappings.
 - [GET /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}/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/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/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/agents](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_all_agents_api_v1_agents_get.md)
 - [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/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/{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
 - [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/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/{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/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
 - [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
 - [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}/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.
 - [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/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}/versions](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/list_agent_versions_api_v1_agents__agent_id__versions_get.md): List version history for an agent configuration.
 - [GET /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.
 - [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.
 - [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
 - [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/{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/agent-runs](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_runs_api_v1_agent_runs_get.md)
 - [GET /forge-agents/api/v1/agents/{agent_id}/output-schema](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_output_schema_api_v1_agents__agent_id__output_schema_get.md)
 - [GET /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)
 - [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/v2/agent-runs](https://docs.businessai.uniphorecloud.com/api-reference/api/agents/get_agent_runs__paginated__api_v2_agent_runs_get.md)