How to add custom API interfaces, do you have any documentation

[libin1219]

Self Checks

• I have searched for existing issues search for existing issues, including closed ones.
• I confirm that I am using English to submit this report (我已阅读并同意 Language Policy).
• [FOR CHINESE USERS] 请务必使用英文提交 Issue，否则会被关闭。谢谢！:)
• Please do not modify this template :) and fill in all the required fields.

1. Is this request related to a challenge you're experiencing? Tell me about your story.

The current DIY agent cannot upload videos, I want to modify it

2. Additional context or comments

No response

[dosubot[bot]]

There isn’t official end-user documentation for adding custom API interfaces in Dify, but the codebase provides a clear pattern. Dify’s backend uses Flask blueprints and Flask-RESTX namespaces to modularize API endpoints. To add a custom API interface, you typically:

1. Define a new Flask blueprint and/or a flask_restx Namespace for your API endpoints.
2. Implement your endpoint logic in a controller module (see api/controllers/service_api/ for examples).
3. Register your blueprint in api/extensions/ext_blueprints.py so it’s included in the app initialization. For example, the files and service_api blueprints are registered there with CORS and security settings applied (source).
4. Use the ExternalApi class (in api/libs/external_api.py) to wrap your API, which sets up bearer token authentication, Swagger UI docs, and structured error handling (source).
5. Import your controller module in the appropriate __init__.py (like api/controllers/service_api/__init__.py) so its routes/namespaces are registered (source).

For file/video uploads: Dify’s backend already supports video file types at the utility level, and the /files/upload endpoint (handled by the files blueprint) accepts multipart uploads with API key authorization. However, the agent UI and workflow config do not currently expose file or video upload options for agents—enabling this would require both backend and frontend changes (source).

If you want to proceed, look at how the files endpoints are implemented and registered, and follow the same pattern for your custom API. For agent video upload support, you’ll also need to extend the agent configuration UI to allow file input types.

Let me know if you want a code snippet or more details on a specific part of this process.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}

   

[heathdutton]

For adding custom API capabilities (like video upload), you have a few options:

1. HTTP Request node - call any external API directly in your workflow

2. Custom Tools - create a tool in Tools > Custom that wraps your API endpoint. Define the schema and Dify handles the rest

3. Plugins - for more complex integrations, check the plugin development docs

For video specifically, you would likely create a custom tool that POSTs to your video processing endpoint.

Does that point you in the right direction?