如何在Dify中配置自定义工具(Custom Tool)接入内部私有API

梦敏姑娘_7922

梦敏姑娘_7922

2026-06-08

840人浏览

原创

必须通过自定义工具声明端点并注入安全凭证,否则ai工作流无法调用内网私有api;需提供openapi schema或手动配置json schema、认证方式及环境变量,再测试连通性与参数绑定。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如何在dify中配置自定义工具(custom tool)接入内部私有api

要在Dify中让AI工作流调用企业内网的私有API(如审批系统、CRM接口、敏感词检测服务),必须通过自定义工具完成端点声明与安全注入,否则模型节点无法识别外部HTTP能力。

准备私有API的OpenAPI Schema或手动定义接口契约

这一步决定后续配置是否能自动生成参数映射。如果私有API已提供标准 OpenAPI 3.0 YAML/JSON 文件,直接使用;若无,则需人工补全请求方法、路径、headers、body结构及响应示例。

不提供准确Schema会导致Dify无法校验输入字段,工作流编排时出现“参数缺失”报错,且调试阶段看不到字段提示。

打开你的私有API文档,确认它支持 POST 方法、Content-Type 为 application/json,并记录完整请求路径(例如 【https://192.168.10.55:8443/api/v1/audit/submit】)。

在Dify控制台创建自定义工具

登录Dify企业版 → 左侧导航栏点击「工具(Tools)」→「自定义(Custom)」→ 点击「创建自定义工具」。

选择「从 OpenAPI 文件导入」或「手动配置」:前者粘贴YAML内容后Dify自动解析出全部端点;后者需逐项填写名称、描述、URL、请求方法、Headers和Body Schema。

手动配置时,Body Schema必须用 JSON Schema 格式书写。例如提交审批的body需写成:{"type":"object","properties":{"order_id":{"type":"string"},"reason":{"type":"string"}},"required":["order_id"]}。漏掉 required 字段将导致该参数在工作流中不可设为必填。

Dify
Dify

Dify AI应用开发平台指南。用于构建LLM应用、工作流、Agent和知识库。当用户需要(1)使用Dify创建AI应用 (2)设计LLM工作流 (3)配置知识库RAG (4)开发AI Agent (5)调用Dify API (6)自托管部署Dify时激活此技能。

下载

配置认证方式并注入凭证

方法一:使用 API Key(推荐用于内网静态Token)
在「鉴权(Authentication)」下拉菜单中选择「API Key」→ 输入Key名称(如 X-API-Key)→ 在值字段填写 【{{env.internal_api_key}}】 → 保存后前往「设置 → 环境变量」新增同名变量并填入真实密钥。

方法二:Bearer Token(适用于OAuth2或短期JWT)
选择「Bearer Token」→ Token字段填写 【{{env.jwt_token}}】 → 同样需在环境变量中声明并赋值。

注意:环境变量名必须与工具配置中引用的完全一致,大小写敏感,且不能含空格或特殊符号。

测试工具连通性与参数绑定

第一步:点击工具卡片右上角「测试」按钮 → 在弹窗中展开「请求详情」→ 检查 URL、Method、Headers 是否与私有API要求一致,特别是协议是否为 https(内网若用 http,需确保Dify服务器允许非加密回环调用)。

第二步:在「输入参数」区域填入合法样例值 → 点击「发送请求」→ 查看响应状态码与body内容。返回 200 且含预期字段(如 {"status":"success","id":"req_abc123"})即表示通路正常。

第三步:回到工作流编辑页,拖入该自定义工具节点 → 点击节点,在「参数映射」面板中,将上游节点输出的变量(如 user_input)拖拽绑定到当前工具的 body.order_id 字段。绑定错误会导致请求体为空对象 {},后端拒绝处理。

这一步操作起来很简单,直接把变量拖进去就行,但必须确认右侧字段路径与你之前定义的 Schema 完全匹配,比如定义的是 body.data.id,就绝不能绑到 body.id。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

dify

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Dify 本地部署与企业配置
Dify 本地部署与企业配置

本专题系统讲解 Dify 从零开始的本地部署方法与企业环境配置实践,涵盖 Docker 安装、依赖准备、数据库初始化、反向代理、参数调优、安全加固与多用户开通,帮助开发者与企业团队快速搭建稳定可用的 Dify 平台。

2026.06.05

777

15

Dify Agent智能体开发实战教程
Dify Agent智能体开发实战教程

本专题聚焦 Dify Agent 智能体的设计与开发,涵盖 Agent 模式选择、工具集成、提示词设计、多步推理、上下文记忆与多 Agent 协作,帮助开发者构建可执行复杂业务任务的智能体应用。

2026.06.05

265

15

Dify RAG知识库构建实战教程
Dify RAG知识库构建实战教程

本专题围绕 Dify RAG 知识库的全流程实践展开,从文档导入、分段切片、向量化到混合检索、重排优化与召回评估,帮助你打造高准确率、低幻觉的企业知识问答应用。

2026.06.05

256

15

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

20

11

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

2026.10.22

0

10

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

2026.10.22

20

15

Gradle怎么构建Java项目
Gradle怎么构建Java项目

本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。

2026.10.22

0

10

PHP时间戳漏洞修复教程
PHP时间戳漏洞修复教程

本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。

2026.10.22

20

25

Golangci-lint配置文件与规则设置
Golangci-lint配置文件与规则设置

本专题聚焦Golangci-lint YAML配置文件,讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置,便于团队统一检查标准。

2026.10.22

0

15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Dify零基础教程
Dify零基础教程

共0课时 | 154人学习

学习Agent,从Dify开始
学习Agent,从Dify开始

共0课时 | 152人学习

Dify 部署与运维指南
Dify 部署与运维指南

共0课时 | 0人学习