How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Dify

Dify Documents API

Operations for creating, updating, and managing documents within a knowledge base. 12 operation(s) from the Dify Service API.

Documentation Provider Profile APIs.io OpenAPI GitHub

Dify Documents API is one of 19 APIs that Dify publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents and Knowledge Management. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 12 operations across 10 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://{api_base_url}.

12 operations 10 paths 2 schemas 1 DELETE4 GET2 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.dify.ai/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Dify Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API_KEY) (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Every request authenticates with an API key: Authorization: Bearer {APIKEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API k…

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 1 DELETE, 4 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 12

Operations for creating, updating, and managing documents within a knowledge base.

POST
/datasets/{dataset_id}/document/create-by-text
Create Document by Text
createDocumentFromText 1 param body → 200400403404503
POST
/datasets/{dataset_id}/document/create-by-file
Create Document by File
createDocumentFromFile 1 param body → 200400403404413503
GET
/datasets/{dataset_id}/documents
List Documents
listDocuments 5 params → 200403404
GET
/datasets/{dataset_id}/documents/{document_id}
Get Document
getDocumentDetail 3 params → 200400403404
DELETE
/datasets/{dataset_id}/documents/{document_id}
Delete Document
deleteDocument 2 params → 204403404
PATCH
/datasets/{dataset_id}/documents/{document_id}
Update Document
updateDocument 2 params body → 200400403404413415503
GET
/datasets/{dataset_id}/documents/{document_id}/download
Download Document
downloadDocument 2 params → 200403404
GET
/datasets/{dataset_id}/documents/{batch}/indexing-status
Get Document Indexing Status
getDocumentIndexingStatus 2 params → 200403404
POST
/datasets/{dataset_id}/documents/{document_id}/update-by-text
Update Document by Text
updateDocumentByText 2 params body → 200400403404503
POST
/datasets/{dataset_id}/documents/{document_id}/update-by-filedeprecated
Update Document by File
updateDocumentByFile 2 params body → 200400403404413415503
POST
/datasets/{dataset_id}/documents/download-zip
Download Documents as ZIP
downloadDocumentsZip 1 param body → 200403404
PATCH
/datasets/{dataset_id}/documents/status/{action}
Update Document Status in Batch
batchUpdateDocumentStatus 2 params body → 200400403404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Document (24 properties), RetrievalModel (9 properties). Each schema is shown below with its type and property counts.

Document
object
24 properties
RetrievalModel
object
9 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dify-documents-api-openapi.yml Raw ↑

Other APIs Dify publishes across the network.

Dify
AE Profile APIs.io
Dify Chat Messages API
AE Profile APIs.io
Dify Completion Messages API
AE Profile APIs.io
Dify Conversations API
AE Profile APIs.io
Dify Knowledge Bases API
AE Profile APIs.io
Dify Files API
AE Profile APIs.io
Dify Workflow Runs API
AE Profile APIs.io
Dify Applications API
AE Profile APIs.io
Dify Annotations API
AE Profile APIs.io
Dify Audio API
AE Profile APIs.io
Dify Feedback API
AE Profile APIs.io
Dify End Users API
AE Profile APIs.io
#Documents#Knowledge Management
← Back to D APIs
API Details
ID
dify:dify-documents-api
Base URL
https://api.dify.ai/v1
Docs
https://docs.dify.ai/en/api-reference/documents/list-documents
Provider
Dify
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=dify-documents-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/dify-documents-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Dify Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.