# Agent Operations

## Create Agent

> API Layer: Create a new Agent

```json
{"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Agent"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/agents":{"post":{"summary":"Create Agent","deprecated":false,"description":"API Layer: Create a new Agent","operationId":"create_agent_admin_api_v2_agents_post","tags":["Agent"],"parameters":[{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCreateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCreateResponse"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"AgentCreateRequest":{"properties":{"icon_type":{"anyOf":[{"type":"string","enum":["emoji","file_id","url"]},{"type":"null"}],"title":"Icon Type","description":"Source type: 'emoji' or 'url'"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Raw icon value: emoji char, full URL, or gallery key"},"icon_background":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Background","description":"Hex background color behind the icon","default":"#FFF"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"created_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Time"},"updated_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Time"},"mode":{"$ref":"#/components/schemas/AgentMode","description":"Workflow mode, e.g., chat or job"},"type":{"$ref":"#/components/schemas/AgentType","description":"Agent type (single-agent, multi-agent) - legacy types (flow, instruction, tool) are deprecated"},"name":{"type":"string","title":"Name","description":"Workflow name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Workflow description","default":""},"abilities":{"anyOf":[{"$ref":"#/components/schemas/AbilityEntity-Input"},{"type":"null"}],"description":"Extend properties","default":{"opening_statement":"","suggested_questions":[],"suggested_questions_after_answer":{"enabled":false},"text_to_speech":{"enabled":false,"language":"","voice":""},"speech_to_text":{"enabled":false},"retriever_resource":{"enabled":false},"sensitive_word_avoidance":{"enabled":false},"file_upload":{"allowed_file_extensions":[],"allowed_file_types":["image","video","audio","document"],"allowed_file_upload_methods":["local_file","remote_url"],"enabled":true,"fileUploadConfig":{"audio_file_size_limit":50,"batch_count_limit":5,"file_size_limit":15,"image_file_size_limit":10,"video_file_size_limit":100,"workflow_file_upload_limit":10},"image_config":{"detail":"low"},"number_limits":4}},"$ref":"#/components/schemas/AbilityEntity-Input"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List of tags","default":[]},"is_favorite":{"type":"boolean","title":"Is Favorite","description":"Indicates if the item is marked as favorite","default":false},"extend_properties":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Extend Properties","description":"Extend properties"}},"type":"object","required":["mode","type","name"],"title":"AgentCreateRequest","description":"Request model for creating a workflow. Only includes fields that should be provided by the frontend."},"AgentMode":{"type":"string","enum":["flow-job","flow-chat","instruction-chat","multi-agent-flow-job","multi-agent-flow-chat","multi-agent-instruction-chat"],"title":"AgentMode"},"AgentType":{"type":"string","enum":["single-agent","multi-agent","flow","instruction","tool"],"title":"AgentType"},"AbilityEntity-Input":{"properties":{"opening_statement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Opening Statement","description":"Opening statement","default":""},"suggested_questions":{"items":{"type":"string"},"type":"array","title":"Suggested Questions","description":"List of suggested questions","default":[]},"suggested_questions_after_answer":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Suggested questions after answer entity","default":{"enabled":true}},"text_to_speech":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Text to speech entity","default":{"enabled":true,"voice":"","language":""}},"speech_to_text":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Speech to text entity","default":{"enabled":true}},"retriever_resource":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Retriever resource entity","default":{"enabled":true}},"sensitive_word_avoidance":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Sensitive word avoidance entity","default":{"enabled":false}},"file_upload":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"File upload entity"}},"type":"object","title":"AbilityEntity","description":"Ability entity"},"AgentCreateResponse":{"properties":{"icon_type":{"anyOf":[{"type":"string","enum":["emoji","file_id","url"]},{"type":"null"}],"title":"Icon Type","description":"Source type: 'emoji' or 'url'"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Raw icon value: emoji char, full URL, or gallery key"},"icon_background":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Background","description":"Hex background color behind the icon","default":"#FFF"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"created_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Time"},"updated_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Time"},"mode":{"$ref":"#/components/schemas/AgentMode","description":"Workflow mode, e.g., chat or job"},"type":{"type":"string","description":"Agent type (single-agent, multi-agent) - legacy types (flow, instruction, tool) are deprecated"},"name":{"type":"string","title":"Name","description":"Workflow name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Workflow description","default":""},"abilities":{"anyOf":[{"$ref":"#/components/schemas/AbilityEntity-Output"},{"type":"null"}],"description":"Extend properties","default":{"opening_statement":"","suggested_questions":[],"suggested_questions_after_answer":{"enabled":false},"text_to_speech":{"enabled":false,"language":"","voice":""},"speech_to_text":{"enabled":false},"retriever_resource":{"enabled":false},"sensitive_word_avoidance":{"enabled":false},"file_upload":{"allowed_file_extensions":[],"allowed_file_types":["image","video","audio","document"],"allowed_file_upload_methods":["local_file","remote_url"],"enabled":true,"fileUploadConfig":{"audio_file_size_limit":50,"batch_count_limit":5,"file_size_limit":15,"image_file_size_limit":10,"video_file_size_limit":100,"workflow_file_upload_limit":10},"image_config":{"detail":"low"},"number_limits":4}},"$ref":"#/components/schemas/AbilityEntity-Output"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List of tags","default":[]},"is_favorite":{"type":"boolean","title":"Is Favorite","description":"Indicates if the item is marked as favorite","default":false},"extend_properties":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Extend Properties","description":"Extend properties"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Workflow ID"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant ID of creator"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant Unit ID of creator"},"status":{"type":"string","title":"Status","description":"Workflow status","default":"ACTIVE"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Workflow status"},"definition_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition Id","description":"Definition id"},"definition_type":{"anyOf":[{"$ref":"#/components/schemas/AgentDefinitionType"},{"type":"null"}],"description":"definition_type"},"ab_test_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ab Test Id","description":"AB test config ID"},"ab_test_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ab Test Enabled","description":"Indicates if AB testing is enabled","default":false},"usage_guide":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Guide","description":"Usage guide"},"visibility":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Resource visibility"},"agent_definition_entity":{"anyOf":[{"type":"object","properties":{}},{"$ref":"#/components/schemas/AgentInstructionEntity"},{"type":"null"}],"title":"Agent Definition Entity","description":"Agent definition entity"},"variables":{"anyOf":[{"items":{"type":"object","properties":{}},"type":"array"},{"type":"null"}],"title":"Variables","description":"Variables"},"icon_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Url","readOnly":true}},"type":"object","required":["mode","type","name","tenant_id","tenant_unit_id","icon_url"],"title":"AgentCreateResponse","description":"Response model for created workflow, which includes all fields of AgentItem."},"AbilityEntity-Output":{"properties":{"opening_statement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Opening Statement","description":"Opening statement","default":""},"suggested_questions":{"items":{"type":"string"},"type":"array","title":"Suggested Questions","description":"List of suggested questions","default":[]},"suggested_questions_after_answer":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Suggested questions after answer entity","default":{"enabled":true}},"text_to_speech":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Text to speech entity","default":{"enabled":true,"voice":"","language":""}},"speech_to_text":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Speech to text entity","default":{"enabled":true}},"retriever_resource":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Retriever resource entity","default":{"enabled":true}},"sensitive_word_avoidance":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Sensitive word avoidance entity","default":{"enabled":false}},"file_upload":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"File upload entity"}},"type":"object","title":"AbilityEntity","description":"Ability entity"},"AgentDefinitionType":{"type":"string","enum":["flow","instruction","tool"],"title":"AgentDefinitionType"},"AgentInstructionEntity":{"properties":{"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By","description":"Identifier of the creator"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By","description":"Identifier of the last updater"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"created_time":{"type":"string","format":"date-time","title":"Created Time","description":"Timestamp of creation"},"updated_time":{"type":"string","format":"date-time","title":"Updated Time","description":"Timestamp of last update"},"llm_config":{"description":"Configuration for the LLM model_name","type":"object","properties":{}},"structured_prompt":{"type":"object","title":"Structured Prompt","description":"Structured prompt in JSON format","properties":{}},"text_prompt":{"type":"string","title":"Text Prompt","description":"Textual prompt for the agent"},"tools_config":{"items":{"$ref":"#/components/schemas/AgentToolConfig-Output"},"type":"array","title":"Tools Config","description":"Configuration for tools used by the agent"},"agent_mode":{"type":"string","title":"Agent Mode","description":"Mode of operation for the agent"},"dataset_retrieval_config":{"$ref":"#/components/schemas/DatasetsRetrievalConfig","description":"Configuration for the dataset used"},"product_retrieval_config":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Configuration for the product retrieval used"},"features":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Features","description":"Additional features in JSON format"},"variables":{"anyOf":[{"items":{"type":"object","properties":{}},"type":"array"},{"type":"null"}],"title":"Variables","description":"Variables in JSON format"},"id":{"type":"string","title":"Id","description":"Unique identifier for the Agent Instruction"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant identifier"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant unit identifier"},"agent_id":{"type":"string","title":"Agent Id","description":"Associated agent identifier"},"version":{"type":"string","title":"Version","description":"Version timestamp"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Indicates if the item is deleted"}},"type":"object","required":["created_time","updated_time","llm_config","structured_prompt","text_prompt","tools_config","agent_mode","dataset_retrieval_config","id","tenant_id","tenant_unit_id","agent_id","version","is_deleted"],"title":"AgentInstructionEntity"},"AgentToolConfig-Output":{"properties":{"tool":{"$ref":"#/components/schemas/AgentToolEntity","description":"Tool entity"},"prompt":{"type":"string","title":"Prompt","description":"Prompt for the tool"},"approval_mode":{"type":"string","title":"Approval Mode","description":"Mode of approval"},"approval_condition":{"type":"object","title":"Approval Condition","description":"Condition for approval","properties":{}},"enable":{"type":"boolean","title":"Enable","description":"Enable or disable the tool"}},"type":"object","required":["tool","prompt","approval_mode","approval_condition","enable"],"title":"AgentToolConfig"},"AgentToolEntity":{"properties":{"tool_type":{"type":"object","properties":{}},"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id"},"resource_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Id"},"tool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Name"},"tool_parameters":{"type":"object","title":"Tool Parameters","properties":{}}},"type":"object","required":["tool_type"],"title":"AgentToolEntity","description":"Agent Tool Entity."},"DatasetsRetrievalConfig":{"properties":{"datasets":{"items":{"$ref":"#/components/schemas/DatasetConfig"},"type":"array","title":"Datasets","description":"List of datasets"},"top_k":{"type":"integer","title":"Top K","description":"Top K datasets"},"retrieval_mode":{"type":"string","title":"Retrieval Mode","description":"Retrieval mode, vector or keyword or hybrid"},"tool_enabled":{"type":"boolean","title":"Tool Enabled","description":"Enable or disable the tool","default":false}},"type":"object","required":["datasets","top_k","retrieval_mode"],"title":"DatasetsRetrievalConfig"},"DatasetConfig":{"properties":{"id":{"type":"string","title":"Id","description":"Dataset ID"},"name":{"type":"string","title":"Name","description":"Dataset Name"},"enable":{"type":"boolean","title":"Enable","description":"Enable or disable the dataset"}},"type":"object","required":["id","name","enable"],"title":"DatasetConfig"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}
```

## List Agents

> API Layer: Retrieve a list of Agents with pagination and filtering.

```json
{"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Agent"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/agents":{"get":{"summary":"List Agents","deprecated":false,"description":"API Layer: Retrieve a list of Agents with pagination and filtering.","operationId":"list_agents_admin_api_v2_agents_get","tags":["Agent"],"parameters":[{"name":"page_num","in":"query","description":"Current page number","required":false,"schema":{"type":"integer","description":"Current page number","default":1,"title":"Page Num"}},{"name":"page_size","in":"query","description":"Items per page","required":false,"schema":{"type":"integer","description":"Items per page","default":20,"title":"Page Size"}},{"name":"is_favorite","in":"query","description":"Filter by favorite status","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter by favorite status","title":"Is Favorite"}},{"name":"tags","in":"query","description":"Filter by tags","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter by tags","title":"Tags"}},{"name":"mode","in":"query","description":"Filter by mode (flow-chat | flow-job | instruction-chat | multi-agent-flow-chat | multi-agent-flow-job | multi-agent-instruction-chat)","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by mode (flow-chat | flow-job | instruction-chat | multi-agent-flow-chat | multi-agent-flow-job | multi-agent-instruction-chat)","title":"Mode"}},{"name":"name","in":"query","description":"Filter by name (fuzzy match)","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by name (fuzzy match)","title":"Name"}},{"name":"order","in":"query","description":"order by: 'recent'(default) or 'oldest'","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"order by: 'recent'(default) or 'oldest'","default":"recent","title":"Order"}},{"name":"exclude_draft","in":"query","description":"Exclude draft agents","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Exclude draft agents","default":false,"title":"Exclude Draft"}},{"name":"agent_ids","in":"query","description":"Filter by agent ids","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter by agent ids","title":"Agent Ids"}},{"name":"type","in":"query","description":"Filter by agent type ('single-agent' | 'multi-agent')","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by agent type ('single-agent' | 'multi-agent')","title":"Type"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentListResponse"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"AgentListResponse":{"properties":{"page_num":{"type":"integer","title":"Page Num","description":"Current page number"},"page_size":{"type":"integer","title":"Page Size","description":"Number of items per page"},"total_count":{"type":"integer","title":"Total Count","description":"Total number of items"},"total_pages":{"type":"integer","title":"Total Pages","description":"Total number of pages"},"has_next_page":{"type":"boolean","title":"Has Next Page","description":"Whether there is a next page"},"data":{"items":{"$ref":"#/components/schemas/AgentEntity"},"type":"array","title":"Data","description":"List of items"}},"type":"object","required":["page_num","page_size","total_count","total_pages","has_next_page","data"],"title":"AgentListResponse","description":"Paginated response for flows."},"AgentEntity":{"properties":{"icon_type":{"anyOf":[{"type":"string","enum":["emoji","file_id","url"]},{"type":"null"}],"title":"Icon Type","description":"Source type: 'emoji' or 'url'"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Raw icon value: emoji char, full URL, or gallery key"},"icon_background":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Background","description":"Hex background color behind the icon","default":"#FFF"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"created_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Time"},"updated_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Time"},"mode":{"$ref":"#/components/schemas/AgentMode","description":"Workflow mode, e.g., chat or job"},"type":{"type":"string","description":"Agent type (single-agent, multi-agent) - legacy types (flow, instruction, tool) are deprecated"},"name":{"type":"string","title":"Name","description":"Workflow name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Workflow description","default":""},"abilities":{"anyOf":[{"$ref":"#/components/schemas/AbilityEntity-Output"},{"type":"null"}],"description":"Extend properties","default":{"opening_statement":"","suggested_questions":[],"suggested_questions_after_answer":{"enabled":false},"text_to_speech":{"enabled":false,"language":"","voice":""},"speech_to_text":{"enabled":false},"retriever_resource":{"enabled":false},"sensitive_word_avoidance":{"enabled":false},"file_upload":{"allowed_file_extensions":[],"allowed_file_types":["image","video","audio","document"],"allowed_file_upload_methods":["local_file","remote_url"],"enabled":true,"fileUploadConfig":{"audio_file_size_limit":50,"batch_count_limit":5,"file_size_limit":15,"image_file_size_limit":10,"video_file_size_limit":100,"workflow_file_upload_limit":10},"image_config":{"detail":"low"},"number_limits":4}}},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List of tags","default":[]},"is_favorite":{"type":"boolean","title":"Is Favorite","description":"Indicates if the item is marked as favorite","default":false},"extend_properties":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Extend Properties","description":"Extend properties"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Workflow ID"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant ID of creator"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant Unit ID of creator"},"status":{"type":"string","title":"Status","description":"Workflow status","default":"ACTIVE"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Workflow status"},"definition_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition Id","description":"Definition id"},"definition_type":{"anyOf":[{"$ref":"#/components/schemas/AgentDefinitionType"},{"type":"null"}],"description":"definition_type"},"ab_test_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ab Test Id","description":"AB test config ID"},"ab_test_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ab Test Enabled","description":"Indicates if AB testing is enabled","default":false},"usage_guide":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Guide","description":"Usage guide"},"visibility":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Resource visibility"},"agent_definition_entity":{"anyOf":[{"type":"object","properties":{}},{"$ref":"#/components/schemas/AgentInstructionEntity"},{"type":"null"}],"title":"Agent Definition Entity","description":"Agent definition entity"},"variables":{"anyOf":[{"items":{"type":"object","properties":{}},"type":"array"},{"type":"null"}],"title":"Variables","description":"Variables"},"icon_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Url","readOnly":true}},"type":"object","required":["mode","type","name","tenant_id","tenant_unit_id","icon_url"],"title":"AgentEntity","description":"Full Agent model with additional fields used for responses."},"AgentMode":{"type":"string","enum":["flow-job","flow-chat","instruction-chat","multi-agent-flow-job","multi-agent-flow-chat","multi-agent-instruction-chat"],"title":"AgentMode"},"AbilityEntity-Output":{"properties":{"opening_statement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Opening Statement","description":"Opening statement","default":""},"suggested_questions":{"items":{"type":"string"},"type":"array","title":"Suggested Questions","description":"List of suggested questions","default":[]},"suggested_questions_after_answer":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Suggested questions after answer entity","default":{"enabled":true}},"text_to_speech":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Text to speech entity","default":{"enabled":true,"voice":"","language":""}},"speech_to_text":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Speech to text entity","default":{"enabled":true}},"retriever_resource":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Retriever resource entity","default":{"enabled":true}},"sensitive_word_avoidance":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Sensitive word avoidance entity","default":{"enabled":false}},"file_upload":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"File upload entity"}},"type":"object","title":"AbilityEntity","description":"Ability entity"},"AgentDefinitionType":{"type":"string","enum":["flow","instruction","tool"],"title":"AgentDefinitionType"},"AgentInstructionEntity":{"properties":{"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By","description":"Identifier of the creator"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By","description":"Identifier of the last updater"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"created_time":{"type":"string","format":"date-time","title":"Created Time","description":"Timestamp of creation"},"updated_time":{"type":"string","format":"date-time","title":"Updated Time","description":"Timestamp of last update"},"llm_config":{"description":"Configuration for the LLM model_name","type":"object","properties":{}},"structured_prompt":{"type":"object","title":"Structured Prompt","description":"Structured prompt in JSON format","properties":{}},"text_prompt":{"type":"string","title":"Text Prompt","description":"Textual prompt for the agent"},"tools_config":{"items":{"$ref":"#/components/schemas/AgentToolConfig-Output"},"type":"array","title":"Tools Config","description":"Configuration for tools used by the agent"},"agent_mode":{"type":"string","title":"Agent Mode","description":"Mode of operation for the agent"},"dataset_retrieval_config":{"$ref":"#/components/schemas/DatasetsRetrievalConfig","description":"Configuration for the dataset used"},"product_retrieval_config":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Configuration for the product retrieval used"},"features":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Features","description":"Additional features in JSON format"},"variables":{"anyOf":[{"items":{"type":"object","properties":{}},"type":"array"},{"type":"null"}],"title":"Variables","description":"Variables in JSON format"},"id":{"type":"string","title":"Id","description":"Unique identifier for the Agent Instruction"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant identifier"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant unit identifier"},"agent_id":{"type":"string","title":"Agent Id","description":"Associated agent identifier"},"version":{"type":"string","title":"Version","description":"Version timestamp"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Indicates if the item is deleted"}},"type":"object","required":["created_time","updated_time","llm_config","structured_prompt","text_prompt","tools_config","agent_mode","dataset_retrieval_config","id","tenant_id","tenant_unit_id","agent_id","version","is_deleted"],"title":"AgentInstructionEntity"},"AgentToolConfig-Output":{"properties":{"tool":{"$ref":"#/components/schemas/AgentToolEntity","description":"Tool entity"},"prompt":{"type":"string","title":"Prompt","description":"Prompt for the tool"},"approval_mode":{"type":"string","title":"Approval Mode","description":"Mode of approval"},"approval_condition":{"type":"object","title":"Approval Condition","description":"Condition for approval","properties":{}},"enable":{"type":"boolean","title":"Enable","description":"Enable or disable the tool"}},"type":"object","required":["tool","prompt","approval_mode","approval_condition","enable"],"title":"AgentToolConfig"},"AgentToolEntity":{"properties":{"tool_type":{"type":"object","properties":{}},"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id"},"resource_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Id"},"tool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Name"},"tool_parameters":{"type":"object","title":"Tool Parameters","properties":{}}},"type":"object","required":["tool_type"],"title":"AgentToolEntity","description":"Agent Tool Entity."},"DatasetsRetrievalConfig":{"properties":{"datasets":{"items":{"$ref":"#/components/schemas/DatasetConfig"},"type":"array","title":"Datasets","description":"List of datasets"},"top_k":{"type":"integer","title":"Top K","description":"Top K datasets"},"retrieval_mode":{"type":"string","title":"Retrieval Mode","description":"Retrieval mode, vector or keyword or hybrid"},"tool_enabled":{"type":"boolean","title":"Tool Enabled","description":"Enable or disable the tool","default":false}},"type":"object","required":["datasets","top_k","retrieval_mode"],"title":"DatasetsRetrievalConfig"},"DatasetConfig":{"properties":{"id":{"type":"string","title":"Id","description":"Dataset ID"},"name":{"type":"string","title":"Name","description":"Dataset Name"},"enable":{"type":"boolean","title":"Enable","description":"Enable or disable the dataset"}},"type":"object","required":["id","name","enable"],"title":"DatasetConfig"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}
```

## Get Agent

> API Layer: Retrieve a Agent by ID

```json
{"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Agent"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/agents/{agent_id}":{"get":{"summary":"Get Agent","deprecated":false,"description":"API Layer: Retrieve a Agent by ID","operationId":"get_agent_admin_api_v2_agents__agent_id__get","tags":["Agent"],"parameters":[{"name":"agent_id","in":"path","description":"","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentGetResponse"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"AgentGetResponse":{"properties":{"icon_type":{"anyOf":[{"type":"string","enum":["emoji","file_id","url"]},{"type":"null"}],"title":"Icon Type","description":"Source type: 'emoji' or 'url'"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Raw icon value: emoji char, full URL, or gallery key"},"icon_background":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Background","description":"Hex background color behind the icon","default":"#FFF"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"created_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Time"},"updated_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Time"},"mode":{"$ref":"#/components/schemas/AgentMode","description":"Workflow mode, e.g., chat or job"},"type":{"type":"string","description":"Agent type (single-agent, multi-agent) - legacy types (flow, instruction, tool) are deprecated"},"name":{"type":"string","title":"Name","description":"Workflow name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Workflow description","default":""},"abilities":{"anyOf":[{"$ref":"#/components/schemas/AbilityEntity-Output"},{"type":"null"}],"description":"Extend properties","default":{"opening_statement":"","suggested_questions":[],"suggested_questions_after_answer":{"enabled":false},"text_to_speech":{"enabled":false,"language":"","voice":""},"speech_to_text":{"enabled":false},"retriever_resource":{"enabled":false},"sensitive_word_avoidance":{"enabled":false},"file_upload":{"allowed_file_extensions":[],"allowed_file_types":["image","video","audio","document"],"allowed_file_upload_methods":["local_file","remote_url"],"enabled":true,"fileUploadConfig":{"audio_file_size_limit":50,"batch_count_limit":5,"file_size_limit":15,"image_file_size_limit":10,"video_file_size_limit":100,"workflow_file_upload_limit":10},"image_config":{"detail":"low"},"number_limits":4}}},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List of tags","default":[]},"is_favorite":{"type":"boolean","title":"Is Favorite","description":"Indicates if the item is marked as favorite","default":false},"extend_properties":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Extend Properties","description":"Extend properties"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Workflow ID"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant ID of creator"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant Unit ID of creator"},"status":{"type":"string","title":"Status","description":"Workflow status","default":"ACTIVE"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Workflow status"},"definition_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition Id","description":"Definition id"},"definition_type":{"anyOf":[{"$ref":"#/components/schemas/AgentDefinitionType"},{"type":"null"}],"description":"definition_type"},"ab_test_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ab Test Id","description":"AB test config ID"},"ab_test_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ab Test Enabled","description":"Indicates if AB testing is enabled","default":false},"usage_guide":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Guide","description":"Usage guide"},"visibility":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Resource visibility"},"agent_definition_entity":{"anyOf":[{"type":"object","properties":{}},{"$ref":"#/components/schemas/AgentInstructionEntity"},{"type":"null"}],"title":"Agent Definition Entity","description":"Agent definition entity"},"variables":{"anyOf":[{"items":{"type":"object","properties":{}},"type":"array"},{"type":"null"}],"title":"Variables","description":"Variables"},"icon_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Url","readOnly":true}},"type":"object","required":["mode","type","name","tenant_id","tenant_unit_id","icon_url"],"title":"AgentGetResponse","description":"Response model for created workflow, which includes all fields of AgentItem."},"AgentMode":{"type":"string","enum":["flow-job","flow-chat","instruction-chat","multi-agent-flow-job","multi-agent-flow-chat","multi-agent-instruction-chat"],"title":"AgentMode"},"AbilityEntity-Output":{"properties":{"opening_statement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Opening Statement","description":"Opening statement","default":""},"suggested_questions":{"items":{"type":"string"},"type":"array","title":"Suggested Questions","description":"List of suggested questions","default":[]},"suggested_questions_after_answer":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Suggested questions after answer entity","default":{"enabled":true}},"text_to_speech":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Text to speech entity","default":{"enabled":true,"voice":"","language":""}},"speech_to_text":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Speech to text entity","default":{"enabled":true}},"retriever_resource":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Retriever resource entity","default":{"enabled":true}},"sensitive_word_avoidance":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Sensitive word avoidance entity","default":{"enabled":false}},"file_upload":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"File upload entity"}},"type":"object","title":"AbilityEntity","description":"Ability entity"},"AgentDefinitionType":{"type":"string","enum":["flow","instruction","tool"],"title":"AgentDefinitionType"},"AgentInstructionEntity":{"properties":{"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By","description":"Identifier of the creator"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By","description":"Identifier of the last updater"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"created_time":{"type":"string","format":"date-time","title":"Created Time","description":"Timestamp of creation"},"updated_time":{"type":"string","format":"date-time","title":"Updated Time","description":"Timestamp of last update"},"llm_config":{"description":"Configuration for the LLM model_name","type":"object","properties":{}},"structured_prompt":{"type":"object","title":"Structured Prompt","description":"Structured prompt in JSON format","properties":{}},"text_prompt":{"type":"string","title":"Text Prompt","description":"Textual prompt for the agent"},"tools_config":{"items":{"$ref":"#/components/schemas/AgentToolConfig-Output"},"type":"array","title":"Tools Config","description":"Configuration for tools used by the agent"},"agent_mode":{"type":"string","title":"Agent Mode","description":"Mode of operation for the agent"},"dataset_retrieval_config":{"$ref":"#/components/schemas/DatasetsRetrievalConfig","description":"Configuration for the dataset used"},"product_retrieval_config":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Configuration for the product retrieval used"},"features":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Features","description":"Additional features in JSON format"},"variables":{"anyOf":[{"items":{"type":"object","properties":{}},"type":"array"},{"type":"null"}],"title":"Variables","description":"Variables in JSON format"},"id":{"type":"string","title":"Id","description":"Unique identifier for the Agent Instruction"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant identifier"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant unit identifier"},"agent_id":{"type":"string","title":"Agent Id","description":"Associated agent identifier"},"version":{"type":"string","title":"Version","description":"Version timestamp"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Indicates if the item is deleted"}},"type":"object","required":["created_time","updated_time","llm_config","structured_prompt","text_prompt","tools_config","agent_mode","dataset_retrieval_config","id","tenant_id","tenant_unit_id","agent_id","version","is_deleted"],"title":"AgentInstructionEntity"},"AgentToolConfig-Output":{"properties":{"tool":{"$ref":"#/components/schemas/AgentToolEntity","description":"Tool entity"},"prompt":{"type":"string","title":"Prompt","description":"Prompt for the tool"},"approval_mode":{"type":"string","title":"Approval Mode","description":"Mode of approval"},"approval_condition":{"type":"object","title":"Approval Condition","description":"Condition for approval","properties":{}},"enable":{"type":"boolean","title":"Enable","description":"Enable or disable the tool"}},"type":"object","required":["tool","prompt","approval_mode","approval_condition","enable"],"title":"AgentToolConfig"},"AgentToolEntity":{"properties":{"tool_type":{"type":"object","properties":{}},"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id"},"resource_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Id"},"tool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Name"},"tool_parameters":{"type":"object","title":"Tool Parameters","properties":{}}},"type":"object","required":["tool_type"],"title":"AgentToolEntity","description":"Agent Tool Entity."},"DatasetsRetrievalConfig":{"properties":{"datasets":{"items":{"$ref":"#/components/schemas/DatasetConfig"},"type":"array","title":"Datasets","description":"List of datasets"},"top_k":{"type":"integer","title":"Top K","description":"Top K datasets"},"retrieval_mode":{"type":"string","title":"Retrieval Mode","description":"Retrieval mode, vector or keyword or hybrid"},"tool_enabled":{"type":"boolean","title":"Tool Enabled","description":"Enable or disable the tool","default":false}},"type":"object","required":["datasets","top_k","retrieval_mode"],"title":"DatasetsRetrievalConfig"},"DatasetConfig":{"properties":{"id":{"type":"string","title":"Id","description":"Dataset ID"},"name":{"type":"string","title":"Name","description":"Dataset Name"},"enable":{"type":"boolean","title":"Enable","description":"Enable or disable the dataset"}},"type":"object","required":["id","name","enable"],"title":"DatasetConfig"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}
```

## Get Agent By Code

> API Layer: Retrieve a Agent by code

```json
{"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Agent"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/agents/code/{agent_code}":{"get":{"summary":"Get Agent By Code","deprecated":false,"description":"API Layer: Retrieve a Agent by code","operationId":"get_agent_by_code_admin_api_v2_agents_code__agent_code__get","tags":["Agent"],"parameters":[{"name":"agent_code","in":"path","description":"","required":true,"schema":{"type":"string","title":"Agent Code"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentGetResponse"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"AgentGetResponse":{"properties":{"icon_type":{"anyOf":[{"type":"string","enum":["emoji","file_id","url"]},{"type":"null"}],"title":"Icon Type","description":"Source type: 'emoji' or 'url'"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Raw icon value: emoji char, full URL, or gallery key"},"icon_background":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Background","description":"Hex background color behind the icon","default":"#FFF"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"created_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Time"},"updated_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Time"},"mode":{"$ref":"#/components/schemas/AgentMode","description":"Workflow mode, e.g., chat or job"},"type":{"type":"string","description":"Agent type (single-agent, multi-agent) - legacy types (flow, instruction, tool) are deprecated"},"name":{"type":"string","title":"Name","description":"Workflow name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Workflow description","default":""},"abilities":{"anyOf":[{"$ref":"#/components/schemas/AbilityEntity-Output"},{"type":"null"}],"description":"Extend properties","default":{"opening_statement":"","suggested_questions":[],"suggested_questions_after_answer":{"enabled":false},"text_to_speech":{"enabled":false,"language":"","voice":""},"speech_to_text":{"enabled":false},"retriever_resource":{"enabled":false},"sensitive_word_avoidance":{"enabled":false},"file_upload":{"allowed_file_extensions":[],"allowed_file_types":["image","video","audio","document"],"allowed_file_upload_methods":["local_file","remote_url"],"enabled":true,"fileUploadConfig":{"audio_file_size_limit":50,"batch_count_limit":5,"file_size_limit":15,"image_file_size_limit":10,"video_file_size_limit":100,"workflow_file_upload_limit":10},"image_config":{"detail":"low"},"number_limits":4}}},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List of tags","default":[]},"is_favorite":{"type":"boolean","title":"Is Favorite","description":"Indicates if the item is marked as favorite","default":false},"extend_properties":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Extend Properties","description":"Extend properties"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Workflow ID"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant ID of creator"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant Unit ID of creator"},"status":{"type":"string","title":"Status","description":"Workflow status","default":"ACTIVE"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Workflow status"},"definition_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition Id","description":"Definition id"},"definition_type":{"anyOf":[{"$ref":"#/components/schemas/AgentDefinitionType"},{"type":"null"}],"description":"definition_type"},"ab_test_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ab Test Id","description":"AB test config ID"},"ab_test_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ab Test Enabled","description":"Indicates if AB testing is enabled","default":false},"usage_guide":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Guide","description":"Usage guide"},"visibility":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Resource visibility"},"agent_definition_entity":{"anyOf":[{"type":"object","properties":{}},{"$ref":"#/components/schemas/AgentInstructionEntity"},{"type":"null"}],"title":"Agent Definition Entity","description":"Agent definition entity"},"variables":{"anyOf":[{"items":{"type":"object","properties":{}},"type":"array"},{"type":"null"}],"title":"Variables","description":"Variables"},"icon_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Url","readOnly":true}},"type":"object","required":["mode","type","name","tenant_id","tenant_unit_id","icon_url"],"title":"AgentGetResponse","description":"Response model for created workflow, which includes all fields of AgentItem."},"AgentMode":{"type":"string","enum":["flow-job","flow-chat","instruction-chat","multi-agent-flow-job","multi-agent-flow-chat","multi-agent-instruction-chat"],"title":"AgentMode"},"AbilityEntity-Output":{"properties":{"opening_statement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Opening Statement","description":"Opening statement","default":""},"suggested_questions":{"items":{"type":"string"},"type":"array","title":"Suggested Questions","description":"List of suggested questions","default":[]},"suggested_questions_after_answer":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Suggested questions after answer entity","default":{"enabled":true}},"text_to_speech":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Text to speech entity","default":{"enabled":true,"voice":"","language":""}},"speech_to_text":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Speech to text entity","default":{"enabled":true}},"retriever_resource":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Retriever resource entity","default":{"enabled":true}},"sensitive_word_avoidance":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Sensitive word avoidance entity","default":{"enabled":false}},"file_upload":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"File upload entity"}},"type":"object","title":"AbilityEntity","description":"Ability entity"},"AgentDefinitionType":{"type":"string","enum":["flow","instruction","tool"],"title":"AgentDefinitionType"},"AgentInstructionEntity":{"properties":{"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By","description":"Identifier of the creator"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By","description":"Identifier of the last updater"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"created_time":{"type":"string","format":"date-time","title":"Created Time","description":"Timestamp of creation"},"updated_time":{"type":"string","format":"date-time","title":"Updated Time","description":"Timestamp of last update"},"llm_config":{"description":"Configuration for the LLM model_name","type":"object","properties":{}},"structured_prompt":{"type":"object","title":"Structured Prompt","description":"Structured prompt in JSON format","properties":{}},"text_prompt":{"type":"string","title":"Text Prompt","description":"Textual prompt for the agent"},"tools_config":{"items":{"$ref":"#/components/schemas/AgentToolConfig-Output"},"type":"array","title":"Tools Config","description":"Configuration for tools used by the agent"},"agent_mode":{"type":"string","title":"Agent Mode","description":"Mode of operation for the agent"},"dataset_retrieval_config":{"$ref":"#/components/schemas/DatasetsRetrievalConfig","description":"Configuration for the dataset used"},"product_retrieval_config":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Configuration for the product retrieval used"},"features":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Features","description":"Additional features in JSON format"},"variables":{"anyOf":[{"items":{"type":"object","properties":{}},"type":"array"},{"type":"null"}],"title":"Variables","description":"Variables in JSON format"},"id":{"type":"string","title":"Id","description":"Unique identifier for the Agent Instruction"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant identifier"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant unit identifier"},"agent_id":{"type":"string","title":"Agent Id","description":"Associated agent identifier"},"version":{"type":"string","title":"Version","description":"Version timestamp"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Indicates if the item is deleted"}},"type":"object","required":["created_time","updated_time","llm_config","structured_prompt","text_prompt","tools_config","agent_mode","dataset_retrieval_config","id","tenant_id","tenant_unit_id","agent_id","version","is_deleted"],"title":"AgentInstructionEntity"},"AgentToolConfig-Output":{"properties":{"tool":{"$ref":"#/components/schemas/AgentToolEntity","description":"Tool entity"},"prompt":{"type":"string","title":"Prompt","description":"Prompt for the tool"},"approval_mode":{"type":"string","title":"Approval Mode","description":"Mode of approval"},"approval_condition":{"type":"object","title":"Approval Condition","description":"Condition for approval","properties":{}},"enable":{"type":"boolean","title":"Enable","description":"Enable or disable the tool"}},"type":"object","required":["tool","prompt","approval_mode","approval_condition","enable"],"title":"AgentToolConfig"},"AgentToolEntity":{"properties":{"tool_type":{"type":"object","properties":{}},"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id"},"resource_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Id"},"tool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Name"},"tool_parameters":{"type":"object","title":"Tool Parameters","properties":{}}},"type":"object","required":["tool_type"],"title":"AgentToolEntity","description":"Agent Tool Entity."},"DatasetsRetrievalConfig":{"properties":{"datasets":{"items":{"$ref":"#/components/schemas/DatasetConfig"},"type":"array","title":"Datasets","description":"List of datasets"},"top_k":{"type":"integer","title":"Top K","description":"Top K datasets"},"retrieval_mode":{"type":"string","title":"Retrieval Mode","description":"Retrieval mode, vector or keyword or hybrid"},"tool_enabled":{"type":"boolean","title":"Tool Enabled","description":"Enable or disable the tool","default":false}},"type":"object","required":["datasets","top_k","retrieval_mode"],"title":"DatasetsRetrievalConfig"},"DatasetConfig":{"properties":{"id":{"type":"string","title":"Id","description":"Dataset ID"},"name":{"type":"string","title":"Name","description":"Dataset Name"},"enable":{"type":"boolean","title":"Enable","description":"Enable or disable the dataset"}},"type":"object","required":["id","name","enable"],"title":"DatasetConfig"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}
```

## Update Agent

> API Layer: Update an existing Agent

```json
{"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Agent"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/agents/{agent_id}":{"put":{"summary":"Update Agent","deprecated":false,"description":"API Layer: Update an existing Agent","operationId":"update_agent_admin_api_v2_agents__agent_id__put","tags":["Agent"],"parameters":[{"name":"agent_id","in":"path","description":"","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentUpdateResponse"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"AgentUpdateRequest":{"properties":{"icon_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Type","description":"Type of icon used"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Icon representation"},"icon_background":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Background","description":"Background color of the icon"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Workflow name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Workflow description"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"List of tags"},"is_favorite":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Favorite","description":"Indicates if the item is marked as favorite"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Workflow status"},"ab_test_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Ab Test Id","description":"AB test config ID"},"ab_test_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ab Test Enabled","description":"Indicates if AB testing is enabled"},"extend_properties":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Extend Properties","description":"Extend properties"},"usage_guide":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Guide","description":"Usage guide"}},"type":"object","title":"AgentUpdateRequest"},"AgentUpdateResponse":{"properties":{"icon_type":{"anyOf":[{"type":"string","enum":["emoji","file_id","url"]},{"type":"null"}],"title":"Icon Type","description":"Source type: 'emoji' or 'url'"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Raw icon value: emoji char, full URL, or gallery key"},"icon_background":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Background","description":"Hex background color behind the icon","default":"#FFF"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"created_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Time"},"updated_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Time"},"mode":{"$ref":"#/components/schemas/AgentMode","description":"Workflow mode, e.g., chat or job"},"type":{"type":"string","description":"Agent type (single-agent, multi-agent) - legacy types (flow, instruction, tool) are deprecated"},"name":{"type":"string","title":"Name","description":"Workflow name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Workflow description","default":""},"abilities":{"anyOf":[{"$ref":"#/components/schemas/AbilityEntity-Output"},{"type":"null"}],"description":"Extend properties","default":{"opening_statement":"","suggested_questions":[],"suggested_questions_after_answer":{"enabled":false},"text_to_speech":{"enabled":false,"language":"","voice":""},"speech_to_text":{"enabled":false},"retriever_resource":{"enabled":false},"sensitive_word_avoidance":{"enabled":false},"file_upload":{"allowed_file_extensions":[],"allowed_file_types":["image","video","audio","document"],"allowed_file_upload_methods":["local_file","remote_url"],"enabled":true,"fileUploadConfig":{"audio_file_size_limit":50,"batch_count_limit":5,"file_size_limit":15,"image_file_size_limit":10,"video_file_size_limit":100,"workflow_file_upload_limit":10},"image_config":{"detail":"low"},"number_limits":4}}},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"List of tags","default":[]},"is_favorite":{"type":"boolean","title":"Is Favorite","description":"Indicates if the item is marked as favorite","default":false},"extend_properties":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Extend Properties","description":"Extend properties"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Workflow ID"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant ID of creator"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant Unit ID of creator"},"status":{"type":"string","title":"Status","description":"Workflow status","default":"ACTIVE"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Workflow status"},"definition_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition Id","description":"Definition id"},"definition_type":{"anyOf":[{"$ref":"#/components/schemas/AgentDefinitionType"},{"type":"null"}],"description":"definition_type"},"ab_test_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ab Test Id","description":"AB test config ID"},"ab_test_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ab Test Enabled","description":"Indicates if AB testing is enabled","default":false},"usage_guide":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usage Guide","description":"Usage guide"},"visibility":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Resource visibility"},"agent_definition_entity":{"anyOf":[{"type":"object","properties":{}},{"$ref":"#/components/schemas/AgentInstructionEntity"},{"type":"null"}],"title":"Agent Definition Entity","description":"Agent definition entity"},"variables":{"anyOf":[{"items":{"type":"object","properties":{}},"type":"array"},{"type":"null"}],"title":"Variables","description":"Variables"},"icon_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon Url","readOnly":true}},"type":"object","required":["mode","type","name","tenant_id","tenant_unit_id","icon_url"],"title":"AgentUpdateResponse","description":"Response model for created workflow, which includes all fields of AgentItem."},"AgentMode":{"type":"string","enum":["flow-job","flow-chat","instruction-chat","multi-agent-flow-job","multi-agent-flow-chat","multi-agent-instruction-chat"],"title":"AgentMode"},"AbilityEntity-Output":{"properties":{"opening_statement":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Opening Statement","description":"Opening statement","default":""},"suggested_questions":{"items":{"type":"string"},"type":"array","title":"Suggested Questions","description":"List of suggested questions","default":[]},"suggested_questions_after_answer":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Suggested questions after answer entity","default":{"enabled":true}},"text_to_speech":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Text to speech entity","default":{"enabled":true,"voice":"","language":""}},"speech_to_text":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Speech to text entity","default":{"enabled":true}},"retriever_resource":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Retriever resource entity","default":{"enabled":true}},"sensitive_word_avoidance":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Sensitive word avoidance entity","default":{"enabled":false}},"file_upload":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"File upload entity"}},"type":"object","title":"AbilityEntity","description":"Ability entity"},"AgentDefinitionType":{"type":"string","enum":["flow","instruction","tool"],"title":"AgentDefinitionType"},"AgentInstructionEntity":{"properties":{"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By","description":"Identifier of the creator"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By","description":"Identifier of the last updater"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"created_time":{"type":"string","format":"date-time","title":"Created Time","description":"Timestamp of creation"},"updated_time":{"type":"string","format":"date-time","title":"Updated Time","description":"Timestamp of last update"},"llm_config":{"description":"Configuration for the LLM model_name","type":"object","properties":{}},"structured_prompt":{"type":"object","title":"Structured Prompt","description":"Structured prompt in JSON format","properties":{}},"text_prompt":{"type":"string","title":"Text Prompt","description":"Textual prompt for the agent"},"tools_config":{"items":{"$ref":"#/components/schemas/AgentToolConfig-Output"},"type":"array","title":"Tools Config","description":"Configuration for tools used by the agent"},"agent_mode":{"type":"string","title":"Agent Mode","description":"Mode of operation for the agent"},"dataset_retrieval_config":{"$ref":"#/components/schemas/DatasetsRetrievalConfig","description":"Configuration for the dataset used"},"product_retrieval_config":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Configuration for the product retrieval used"},"features":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Features","description":"Additional features in JSON format"},"variables":{"anyOf":[{"items":{"type":"object","properties":{}},"type":"array"},{"type":"null"}],"title":"Variables","description":"Variables in JSON format"},"id":{"type":"string","title":"Id","description":"Unique identifier for the Agent Instruction"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant identifier"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant unit identifier"},"agent_id":{"type":"string","title":"Agent Id","description":"Associated agent identifier"},"version":{"type":"string","title":"Version","description":"Version timestamp"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Indicates if the item is deleted"}},"type":"object","required":["created_time","updated_time","llm_config","structured_prompt","text_prompt","tools_config","agent_mode","dataset_retrieval_config","id","tenant_id","tenant_unit_id","agent_id","version","is_deleted"],"title":"AgentInstructionEntity"},"AgentToolConfig-Output":{"properties":{"tool":{"$ref":"#/components/schemas/AgentToolEntity","description":"Tool entity"},"prompt":{"type":"string","title":"Prompt","description":"Prompt for the tool"},"approval_mode":{"type":"string","title":"Approval Mode","description":"Mode of approval"},"approval_condition":{"type":"object","title":"Approval Condition","description":"Condition for approval","properties":{}},"enable":{"type":"boolean","title":"Enable","description":"Enable or disable the tool"}},"type":"object","required":["tool","prompt","approval_mode","approval_condition","enable"],"title":"AgentToolConfig"},"AgentToolEntity":{"properties":{"tool_type":{"type":"object","properties":{}},"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id"},"resource_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resource Id"},"tool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Name"},"tool_parameters":{"type":"object","title":"Tool Parameters","properties":{}}},"type":"object","required":["tool_type"],"title":"AgentToolEntity","description":"Agent Tool Entity."},"DatasetsRetrievalConfig":{"properties":{"datasets":{"items":{"$ref":"#/components/schemas/DatasetConfig"},"type":"array","title":"Datasets","description":"List of datasets"},"top_k":{"type":"integer","title":"Top K","description":"Top K datasets"},"retrieval_mode":{"type":"string","title":"Retrieval Mode","description":"Retrieval mode, vector or keyword or hybrid"},"tool_enabled":{"type":"boolean","title":"Tool Enabled","description":"Enable or disable the tool","default":false}},"type":"object","required":["datasets","top_k","retrieval_mode"],"title":"DatasetsRetrievalConfig"},"DatasetConfig":{"properties":{"id":{"type":"string","title":"Id","description":"Dataset ID"},"name":{"type":"string","title":"Name","description":"Dataset Name"},"enable":{"type":"boolean","title":"Enable","description":"Enable or disable the dataset"}},"type":"object","required":["id","name","enable"],"title":"DatasetConfig"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}
```

## Delete Agent

> API Layer: Delete a Agent by ID

```json
{"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Agent"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/agents/{agent_id}":{"delete":{"summary":"Delete Agent","deprecated":false,"description":"API Layer: Delete a Agent by ID","operationId":"delete_agent_admin_api_v2_agents__agent_id__delete","tags":["Agent"],"parameters":[{"name":"agent_id","in":"path","description":"","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"responses":{"204":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}
```

## Invoke Agent Chat

> API Layer: Invoke a Agent

```json
{"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Agent"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/agents/{agent_id}/chat":{"post":{"summary":"Invoke Agent Chat","deprecated":false,"description":"API Layer: Invoke a Agent","operationId":"invoke_agent_chat_admin_api_v2_agents__agent_id__chat_post","tags":["Agent"],"parameters":[{"name":"agent_id","in":"path","description":"","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentChatInvokeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"AgentChatInvokeRequest":{"properties":{"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","default":""},"inputs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Inputs","description":"Input variables"},"streaming":{"type":"boolean","title":"Streaming","default":false},"files":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Files","default":[]},"response_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Type","default":"wfx"},"wfx_context":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Wfx Context","default":{}},"conversation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversation Id"}},"type":"object","title":"AgentChatInvokeRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}
```

## Resume Invoke Agent Chat

> API Layer: Resume Invoke a Agent

```json
{"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Agent"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/agents/{agent_id}/chat/resume":{"post":{"summary":"Resume Invoke Agent Chat","deprecated":false,"description":"API Layer: Resume Invoke a Agent","operationId":"resume_invoke_agent_chat_admin_api_v2_agents__agent_id__chat_resume_post","tags":["Agent"],"parameters":[{"name":"agent_id","in":"path","description":"","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentChatResumeInvokeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"AgentChatResumeInvokeRequest":{"properties":{"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","default":""},"inputs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Inputs","description":"Input variables"},"streaming":{"type":"boolean","title":"Streaming","default":false},"files":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Files","default":[]},"response_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Type","default":"wfx"},"wfx_context":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Wfx Context","default":{}},"conversation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversation Id"},"interrupt_inputs":{"type":"object","title":"Interrupt Inputs","properties":{}},"is_interrupted":{"type":"boolean","title":"Is Interrupted"},"flow_run_id":{"type":"string","title":"Flow Run Id"}},"type":"object","required":["interrupt_inputs","is_interrupted","flow_run_id"],"title":"AgentChatResumeInvokeRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}
```

## Invoke Agent Job

> API Layer: Invoke a Agent

```json
{"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Agent"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/agents/{agent_id}/job":{"post":{"summary":"Invoke Agent Job","deprecated":false,"description":"API Layer: Invoke a Agent","operationId":"invoke_agent_job_admin_api_v2_agents__agent_id__job_post","tags":["Agent"],"parameters":[{"name":"agent_id","in":"path","description":"","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentJobInvokeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"AgentJobInvokeRequest":{"properties":{"query":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query","default":""},"inputs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Inputs","description":"Input variables"},"streaming":{"type":"boolean","title":"Streaming","default":false},"files":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Files","default":[]},"response_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Type","default":"wfx"},"wfx_context":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Wfx Context","default":{}},"conversation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversation Id"}},"type":"object","title":"AgentJobInvokeRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.workfx.ai/workfx-1.1.x-english/developer-docs/api-reference/agent/agent-operations.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.