Guia da API Dify 2026: Integrar IA via REST no seu App

O que é a API do Dify?

A API do Dify é uma API REST que permite chamar programaticamente qualquer app criado no Dify — de qualquer linguagem de programação ou plataforma. Quando você publica um app Dify (chatbot, agente, workflow ou app de conclusão), ele recebe seu próprio endpoint de API que pode ser chamado com uma chave secreta.

A URL base para o Dify Cloud é https://api.dify.ai/v1. Na auto-hospedagem, substitua pelo seu próprio domínio: https://seu-servidor.com/v1.

Casos de uso típicos

Visão geral dos endpoints de API

A API do Dify oferece endpoints para enviar mensagens, gerenciar conversas, fazer upload de arquivos e mais. Todos os endpoints são relativos à URL base https://api.dify.ai/v1.

Respostas em streaming (SSE)

O streaming permite exibir tokens durante a geração — como o efeito de digitação do ChatGPT. O Dify usa Server-Sent Events (SSE) para streaming. Defina "response_mode": "streaming" no corpo da requisição.

Cada evento chega como uma linha com o prefixo data:. Os tipos de evento incluem message (um chunk de token), message_end (mensagem final com metadados) e error.

Exemplo de streaming com curl

curl -X POST 'https://api.dify.ai/v1/chat-messages' \
  -H 'Authorization: Bearer SUA_CHAVE_API' \
  -H 'Content-Type: application/json' \
  --no-buffer \
  -d '{
    "inputs": {},
    "query": "Escreva um poema curto sobre IA.",
    "response_mode": "streaming",
    "conversation_id": "",
    "user": "usuario-123"
  }'

Exemplo de streaming em Python

import requests
import json

def stream_chat(query, user="usuario-123"):
    with requests.post(
        "https://api.dify.ai/v1/chat-messages",
        headers={
            "Authorization": "Bearer SUA_CHAVE_API",
            "Content-Type": "application/json",
        },
        json={
            "inputs": {},
            "query": query,
            "response_mode": "streaming",
            "conversation_id": "",
            "user": user,
        },
        stream=True,
    ) as response:
        for line in response.iter_lines():
            if line and line.startswith(b"data: "):
                data = json.loads(line[6:])
                if data.get("event") == "message":
                    print(data["answer"], end="", flush=True)
                elif data.get("event") == "message_end":
                    print()
                    break

stream_chat("Explique computação quântica de forma simples.")

JavaScript / Browser (fetch com ReadableStream)

async function streamChat(query) {
  const response = await fetch("https://api.dify.ai/v1/chat-messages", {
    method: "POST",
    headers: {
      "Authorization": "Bearer SUA_CHAVE_API",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      inputs: {},
      query,
      response_mode: "streaming",
      conversation_id: "",
      user: "usuario-browser",
    }),
  });

  const reader = response.body.getReader();
  const decoder = new TextDecoder();

  while (true) {
    const { done, value } = await reader.read();
    if (done) break;
    const lines = decoder.decode(value).split("\n");
    for (const line of lines) {
      if (line.startsWith("data: ")) {
        const data = JSON.parse(line.slice(6));
        if (data.event === "message") {
          document.getElementById("saida").textContent += data.answer;
        }
      }
    }
  }
}

streamChat("Quais são as vantagens da IA auto-hospedada?");

Perguntas frequentes