Agent Instructions

Manage Agent Instructions, which are agents configured directly via conversation prompts. These endpoints allow you to create, retrieve, publish, and execute draft Agent instructions.

Upsert Draft Instruction

put

Upsert the draft version of the instruction

路径参数

agent_idstring必填

The UUID of the agent

查询参数

tenant_idany of可选

Tenant Id

Example: 40d39c4b-9585-4123-8fd4-f1cc23a1184c

string可选

或

null可选

tenant_unit_idany of可选

Tenant Unit ID

Example: da114de3-d7e6-4161-bc55-0ce85dbee589

string可选

或

null可选

请求体

The request body

created_byany of可选

string可选

或

null可选

updated_byany of可选

string可选

或

null可选

created_by_roleany of可选

string可选

或

null可选

updated_by_roleany of可选

string可选

或

null可选

created_timeany of可选

string · date-time可选

或

null可选

updated_timeany of可选

string · date-time可选

或

null可选

llm_configobject必填

Configuration for the LLM model_name

structured_promptobject · Structured Prompt必填

Structured prompt in JSON format

text_promptstring必填

Textual prompt for the agent

agent_modestring必填

Mode of operation for the agent

product_retrieval_configany of可选

Configuration for the product retrieval used

object可选

或

null可选

featuresany of可选

Additional features in JSON format

object可选

或

null可选

variablesany of可选

Variables in JSON format

object[]可选

或

null可选

响应

200

Successful Response

application/json

created_byany of可选

Identifier of the creator

string可选

或

null可选

updated_byany of可选

Identifier of the last updater

string可选

或

null可选

created_by_roleany of可选

string可选

或

null可选

updated_by_roleany of可选

string可选

或

null可选

created_timestring · date-time必填

Timestamp of creation

updated_timestring · date-time必填

Timestamp of last update

llm_configobject必填

Configuration for the LLM model_name

structured_promptobject · Structured Prompt必填

Structured prompt in JSON format

text_promptstring必填

Textual prompt for the agent

agent_modestring必填

Mode of operation for the agent

product_retrieval_configany of可选

Configuration for the product retrieval used

object可选

或

null可选

featuresany of可选

Additional features in JSON format

object可选

或

null可选

variablesany of可选

Variables in JSON format

object[]可选

或

null可选

idstring必填

Unique identifier for the Agent Instruction

tenant_idstring必填

Tenant identifier

tenant_unit_idstring必填

Tenant unit identifier

agent_idstring必填

Associated agent identifier

versionstring必填

Version timestamp

is_deletedboolean必填

Indicates if the item is deleted

422

Validation Error

application/json

put

/admin/api/v2/agents/{agent_id}/instructions/draft

PUT /admin/api/v2/agents/{agent_id}/instructions/draft HTTP/1.1
Host: api.workfx.ai
Content-Type: application/json
Accept: */*
Content-Length: 655

{
  "created_by": "text",
  "updated_by": "text",
  "created_by_role": "text",
  "updated_by_role": "text",
  "created_time": "2026-03-18T04:46:12.207Z",
  "updated_time": "2026-03-18T04:46:12.207Z",
  "llm_config": {},
  "structured_prompt": {},
  "text_prompt": "text",
  "tools_config": [
    {
      "tool": {
        "tool_type": {},
        "vendor_id": "text",
        "resource_id": "text",
        "tool_name": "text",
        "tool_parameters": {}
      },
      "prompt": "text",
      "approval_mode": "text",
      "approval_condition": {},
      "enable": true
    }
  ],
  "agent_mode": "text",
  "dataset_retrieval_config": {
    "datasets": [
      {
        "id": "text",
        "name": "text",
        "enable": true
      }
    ],
    "top_k": 1,
    "retrieval_mode": "text",
    "tool_enabled": false
  },
  "product_retrieval_config": {},
  "features": {},
  "variables": [
    {}
  ]
}

{
  "created_by": "text",
  "updated_by": "text",
  "created_by_role": "text",
  "updated_by_role": "text",
  "created_time": "2026-03-18T04:46:12.207Z",
  "updated_time": "2026-03-18T04:46:12.207Z",
  "llm_config": {},
  "structured_prompt": {},
  "text_prompt": "text",
  "tools_config": [
    {
      "tool": {
        "tool_type": {},
        "vendor_id": "text",
        "resource_id": "text",
        "tool_name": "text",
        "tool_parameters": {}
      },
      "prompt": "text",
      "approval_mode": "text",
      "approval_condition": {},
      "enable": true
    }
  ],
  "agent_mode": "text",
  "dataset_retrieval_config": {
    "datasets": [
      {
        "id": "text",
        "name": "text",
        "enable": true
      }
    ],
    "top_k": 1,
    "retrieval_mode": "text",
    "tool_enabled": false
  },
  "product_retrieval_config": {},
  "features": {},
  "variables": [
    {}
  ],
  "id": "text",
  "tenant_id": "text",
  "tenant_unit_id": "text",
  "agent_id": "text",
  "version": "text",
  "is_deleted": true
}

Get Draft Instruction

get

Get the draft version of the instruction

路径参数

agent_idstring必填

The UUID of the agent

查询参数

tenant_idany of可选

Tenant Id

Example: 40d39c4b-9585-4123-8fd4-f1cc23a1184c

string可选

或

null可选

tenant_unit_idany of可选

Tenant Unit ID

Example: da114de3-d7e6-4161-bc55-0ce85dbee589

string可选

或

null可选

响应

200

Successful Response

application/json

created_byany of可选

Identifier of the creator

string可选

或

null可选

updated_byany of可选

Identifier of the last updater

string可选

或

null可选

created_by_roleany of可选

string可选

或

null可选

updated_by_roleany of可选

string可选

或

null可选

created_timestring · date-time必填

Timestamp of creation

updated_timestring · date-time必填

Timestamp of last update

llm_configobject必填

Configuration for the LLM model_name

structured_promptobject · Structured Prompt必填

Structured prompt in JSON format

text_promptstring必填

Textual prompt for the agent

agent_modestring必填

Mode of operation for the agent

product_retrieval_configany of可选

Configuration for the product retrieval used

object可选

或

null可选

featuresany of可选

Additional features in JSON format

object可选

或

null可选

variablesany of可选

Variables in JSON format

object[]可选

或

null可选

idstring必填

Unique identifier for the Agent Instruction

tenant_idstring必填

Tenant identifier

tenant_unit_idstring必填

Tenant unit identifier

agent_idstring必填

Associated agent identifier

versionstring必填

Version timestamp

is_deletedboolean必填

Indicates if the item is deleted

422

Validation Error

application/json

get

/admin/api/v2/agents/{agent_id}/instructions/draft

GET /admin/api/v2/agents/{agent_id}/instructions/draft HTTP/1.1
Host: api.workfx.ai
Accept: */*

{
  "created_by": "text",
  "updated_by": "text",
  "created_by_role": "text",
  "updated_by_role": "text",
  "created_time": "2026-03-18T04:46:12.207Z",
  "updated_time": "2026-03-18T04:46:12.207Z",
  "llm_config": {},
  "structured_prompt": {},
  "text_prompt": "text",
  "tools_config": [
    {
      "tool": {
        "tool_type": {},
        "vendor_id": "text",
        "resource_id": "text",
        "tool_name": "text",
        "tool_parameters": {}
      },
      "prompt": "text",
      "approval_mode": "text",
      "approval_condition": {},
      "enable": true
    }
  ],
  "agent_mode": "text",
  "dataset_retrieval_config": {
    "datasets": [
      {
        "id": "text",
        "name": "text",
        "enable": true
      }
    ],
    "top_k": 1,
    "retrieval_mode": "text",
    "tool_enabled": false
  },
  "product_retrieval_config": {},
  "features": {},
  "variables": [
    {}
  ],
  "id": "text",
  "tenant_id": "text",
  "tenant_unit_id": "text",
  "agent_id": "text",
  "version": "text",
  "is_deleted": true
}

Publish Draft Instruction

post

Get the draft version of the instruction

路径参数

agent_idstring必填

The UUID of the agent

查询参数

tenant_idany of可选

Tenant Id

Example: 40d39c4b-9585-4123-8fd4-f1cc23a1184c

string可选

或

null可选

tenant_unit_idany of可选

Tenant Unit ID

Example: da114de3-d7e6-4161-bc55-0ce85dbee589

string可选

或

null可选

响应

200

Successful Response

application/json

created_byany of可选

Identifier of the creator

string可选

或

null可选

updated_byany of可选

Identifier of the last updater

string可选

或

null可选

created_by_roleany of可选

string可选

或

null可选

updated_by_roleany of可选

string可选

或

null可选

created_timestring · date-time必填

Timestamp of creation

updated_timestring · date-time必填

Timestamp of last update

llm_configobject必填

Configuration for the LLM model_name

structured_promptobject · Structured Prompt必填

Structured prompt in JSON format

text_promptstring必填

Textual prompt for the agent

agent_modestring必填

Mode of operation for the agent

product_retrieval_configany of可选

Configuration for the product retrieval used

object可选

或

null可选

featuresany of可选

Additional features in JSON format

object可选

或

null可选

variablesany of可选

Variables in JSON format

object[]可选

或

null可选

idstring必填

Unique identifier for the Agent Instruction

tenant_idstring必填

Tenant identifier

tenant_unit_idstring必填

Tenant unit identifier

agent_idstring必填

Associated agent identifier

versionstring必填

Version timestamp

is_deletedboolean必填

Indicates if the item is deleted

422

Validation Error

application/json

post

/admin/api/v2/agents/{agent_id}/instructions/publish

POST /admin/api/v2/agents/{agent_id}/instructions/publish HTTP/1.1
Host: api.workfx.ai
Accept: */*

{
  "created_by": "text",
  "updated_by": "text",
  "created_by_role": "text",
  "updated_by_role": "text",
  "created_time": "2026-03-18T04:46:12.207Z",
  "updated_time": "2026-03-18T04:46:12.207Z",
  "llm_config": {},
  "structured_prompt": {},
  "text_prompt": "text",
  "tools_config": [
    {
      "tool": {
        "tool_type": {},
        "vendor_id": "text",
        "resource_id": "text",
        "tool_name": "text",
        "tool_parameters": {}
      },
      "prompt": "text",
      "approval_mode": "text",
      "approval_condition": {},
      "enable": true
    }
  ],
  "agent_mode": "text",
  "dataset_retrieval_config": {
    "datasets": [
      {
        "id": "text",
        "name": "text",
        "enable": true
      }
    ],
    "top_k": 1,
    "retrieval_mode": "text",
    "tool_enabled": false
  },
  "product_retrieval_config": {},
  "features": {},
  "variables": [
    {}
  ],
  "id": "text",
  "tenant_id": "text",
  "tenant_unit_id": "text",
  "agent_id": "text",
  "version": "text",
  "is_deleted": true
}

List Agent Instructions

get

路径参数

agent_idstring必填

The UUID of the agent

查询参数

pageinteger可选

The page number

Default: 1

page_sizeinteger可选

The number of items per page

Default: 10

tenant_idany of可选

Tenant Id

Example: 40d39c4b-9585-4123-8fd4-f1cc23a1184c

string可选

或

null可选

tenant_unit_idany of可选

Tenant Unit ID

Example: da114de3-d7e6-4161-bc55-0ce85dbee589

string可选

或

null可选

响应

200

Successful Response

application/json

page_numinteger必填

Current page number

page_sizeinteger必填

Number of items per page

total_countinteger必填

Total number of items

total_pagesinteger必填

Total number of pages

has_next_pageboolean必填

Whether there is a next page

422

Validation Error

application/json

get

/admin/api/v2/agents/{agent_id}/instructions

GET /admin/api/v2/agents/{agent_id}/instructions HTTP/1.1
Host: api.workfx.ai
Accept: */*

{
  "page_num": 1,
  "page_size": 1,
  "total_count": 1,
  "total_pages": 1,
  "has_next_page": true,
  "data": [
    {
      "created_by": "text",
      "updated_by": "text",
      "created_by_role": "text",
      "updated_by_role": "text",
      "created_time": "2026-03-18T04:46:12.207Z",
      "updated_time": "2026-03-18T04:46:12.207Z",
      "llm_config": {},
      "structured_prompt": {},
      "text_prompt": "text",
      "tools_config": [
        {
          "tool": {
            "tool_type": {},
            "vendor_id": "text",
            "resource_id": "text",
            "tool_name": "text",
            "tool_parameters": {}
          },
          "prompt": "text",
          "approval_mode": "text",
          "approval_condition": {},
          "enable": true
        }
      ],
      "agent_mode": "text",
      "dataset_retrieval_config": {
        "datasets": [
          {
            "id": "text",
            "name": "text",
            "enable": true
          }
        ],
        "top_k": 1,
        "retrieval_mode": "text",
        "tool_enabled": false
      },
      "product_retrieval_config": {},
      "features": {},
      "variables": [
        {}
      ],
      "id": "text",
      "tenant_id": "text",
      "tenant_unit_id": "text",
      "agent_id": "text",
      "version": "text",
      "is_deleted": true
    }
  ]
}

Run Specific Instruction

post

Run a specific instruction by ID

路径参数

agent_idstring · uuid必填Example: e06f8e4f-fb57-450d-a8f1-661c7d655769

查询参数

tenant_idany of可选

Tenant Id

Example: 40d39c4b-9585-4123-8fd4-f1cc23a1184c

string可选

或

null可选

tenant_unit_idany of可选

Tenant Unit ID

Example: da114de3-d7e6-4161-bc55-0ce85dbee589

string可选

或

null可选

请求体

queryany of可选Default: ""

string可选

或

null可选

inputsany of可选

Input variables

Example: {"var1":"1","var2":2}

object可选

或

null可选

streamingboolean可选Default: false

filesany of可选Default: []

string[]可选

或

null可选

response_typeany of可选Default: wfx

string可选

或

null可选

wfx_contextany of可选Default: {}

object可选

或

null可选

conversation_idany of可选

string可选

或

null可选

响应

200

Successful Response

application/json

string可选

422

Validation Error

application/json

post

/admin/api/v2/agents/{agent_id}/instructions/draft/runs

POST /admin/api/v2/agents/{agent_id}/instructions/draft/runs HTTP/1.1
Host: api.workfx.ai
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "query": "",
  "inputs": {
    "var1": "1",
    "var2": 2
  },
  "streaming": false,
  "files": [
    "text"
  ],
  "response_type": "wfx",
  "wfx_context": {},
  "conversation_id": "text"
}

text

上一页Agent Operations 下一页Tools

最后更新于9个月前

这有帮助吗？

hashtagUpsert Draft Instruction

hashtagGet Draft Instruction

hashtagPublish Draft Instruction

hashtagList Agent Instructions

hashtagRun Specific Instruction

Upsert Draft Instruction

Get Draft Instruction

Publish Draft Instruction

List Agent Instructions

Run Specific Instruction