Dify API

Name: Dify API API
Brand: Dify API
Availability: InStock

✓ Official Vendor SpecAI/MLLanguage Modelsbearer18 EndpointsREST

For Agents

Run chat completions, manage conversations, transcribe and synthesize audio, and upload files for Dify-hosted AI apps and agents.

Connect the Dify API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Dify API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Dify API API.

Send chat messages and stream responses from a Dify chatbot or agent

Manage multi-turn conversations including renaming and deleting threads

Upload files for use as context in chat or workflow runs

Transcribe audio to text and synthesize text to audio through the Dify runtime

GET STARTED

Start building with Dify API API

Explore with Jentic

View OpenAPI Document

The Dify API is the application-runtime interface for Dify AI apps — chatbots, agents, and workflow apps built in the Dify console. It exposes chat-message generation, conversation management, file upload, audio transcription and synthesis, message feedback, annotations, and app metadata behind a small Bearer-authenticated surface. Eighteen endpoints cover the runtime needs of an embedded chatbot or backend AI workflow without exposing the underlying model providers directly.

Use Cases

Patterns agents use Dify API API for, with concrete tasks.

★ Embedded Chatbot Backend

Power a website or in-app chat widget by routing user messages to a Dify app through POST /chat-messages. The endpoint streams the assistant response, threads messages into a conversation, and returns metadata such as latency and token usage. Suitable for support assistants, knowledge-base chatbots, and product-onboarding agents built in the Dify console.

Send the user message to /chat-messages with the current conversation id, stream tokens to the UI, and store the new message id when the stream ends

Voice-Enabled AI Agent

Build a voice agent by chaining /audio-to-text, /chat-messages, and /text-to-audio. The user's spoken input is transcribed, sent to the Dify app, and the assistant's reply is synthesized back to audio for playback. This collapses what used to require three separate vendor integrations into a single platform with consistent auth.

Receive a recorded audio clip, post it to /audio-to-text, send the transcript to /chat-messages, then call /text-to-audio on the response and return the audio to the caller

Feedback-Driven Quality Loop

Capture thumbs-up and thumbs-down feedback on assistant responses to iterate on prompts and knowledge bases. POST to /messages/{message_id}/feedbacks records the user verdict, and downstream analytics or review pipelines can pull underperforming messages for prompt tuning. This makes the Dify app a continuously improving product surface.

When the user clicks thumbs-down on assistant message msg-123, POST to /messages/msg-123/feedbacks with rating=dislike and the user's optional reason

AI Agent Tool Backend

Use a Dify app as a callable tool from another AI agent through Jentic. The orchestrator searches for "send a Dify chat message", Jentic returns POST /chat-messages with its input schema, and the agent invokes it as a sub-task — for example, to summarise a document or answer a domain-specific question handled by a specialised Dify app.

Call the legal-summary Dify app via /chat-messages with the contract text as user input, return the structured summary, and store it in the case record

Key Endpoints

18 endpoints — the dify api is the application-runtime interface for dify ai apps — chatbots, agents, and workflow apps built in the dify console.

METHOD

PATH

DESCRIPTION

POST

/chat-messages

Send a chat message and stream the response

POST

/chat-messages/{task_id}/stop

Stop a streaming chat task

GET

/conversations

List conversations for the current user

POST

/files/upload

Upload a file for use as context

POST

/audio-to-text

Transcribe an audio file

POST

/text-to-audio

Synthesize audio from text

POST

/messages/{message_id}/feedbacks

Submit feedback on a message

POST

/chat-messages

Send a chat message and stream the response

POST

/chat-messages/{task_id}/stop

Stop a streaming chat task

GET

/conversations

List conversations for the current user

POST

/files/upload

Upload a file for use as context

POST

/audio-to-text

Transcribe an audio file

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Dify app-scoped bearer tokens are stored encrypted in the Jentic vault. Agents call Dify endpoints through scoped execution credentials — raw tokens never enter the model context.

Intent-based discovery

Agents search by intent such as "send a chat message" or "transcribe audio" and Jentic returns the corresponding Dify operation with its input schema.

Time to first call

Direct Dify integration: 1 day for chat streaming, file upload, and feedback wiring. Through Jentic: under 1 hour.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

OpenAI API

Direct LLM access without the Dify app-builder layer

Choose OpenAI directly when you do not need Dify's app, knowledge-base, and workflow runtime

Alternative

Anthropic API

Claude family models direct from Anthropic

Use Anthropic directly when targeting Claude with custom orchestration rather than Dify-hosted apps

Complementary

ElevenLabs API

Higher-quality voice synthesis if Dify text-to-audio is not sufficient

Use ElevenLabs when voice quality or voice-cloning features exceed what Dify's built-in audio offers

FAQs

Specific to using Dify API API through Jentic.

What authentication does the Dify API use?

Dify uses HTTP Bearer authentication. Each Dify app issues an app-scoped API key from the Dify console. Through Jentic the token is stored in the encrypted vault and injected at execution time only.

Can I stream chat responses from a Dify app?

Yes. POST /chat-messages supports a streaming response mode that returns server-sent events as the assistant generates tokens. The same endpoint also supports a blocking mode if streaming is not needed.

What are the rate limits for the Dify API?

Dify applies per-app rate limits set on the Dify console. The exact ceiling depends on the plan tier; bursty workloads should respect the limits visible in 429 response headers and retry with exponential backoff.

How do I send a chat message through Jentic?

Run a Jentic search for "send a Dify chat message". Jentic returns POST /chat-messages with its input schema (query, conversation_id, user, response_mode). Load the schema, populate the fields, and execute.

Does the API support file uploads as conversation context?

Yes. POST /files/upload accepts multipart file uploads and returns a file id that can be referenced in subsequent /chat-messages requests, so the assistant can read documents the user has attached.

How do I install the Jentic SDK to call Dify?

Run pip install jentic, set JENTIC_AGENT_API_KEY to your ak_* key, then use Jentic with SearchRequest, LoadRequest, and ExecutionRequest. Sign up at https://app.jentic.com/sign-up.