API Access
tab on the top navigation bar to view full API documentation.Locate the 'Try It' Feature
Configure Request Parameters
Server Address (Base URL)
Authentication (API Key)
Path and Query Parameters
/users/{user_id}
) or requires query parameters (e.g., ?limit=10
), please fill them in accurately according to the endpoint description.Request Body
POST
, PUT
, PATCH
that require a request body, please refer to the request body schema and examples provided in the endpoint documentation to construct the correct JSON content.Send Request and View Results
API Access
, or Monitoring
page of your Dify application by clicking on API Key
.
Authorization
header of your HTTP request in the format Bearer YOUR_API_KEY
.
Accessing the API
and This Documentapi-access-readme.mdx
): Provides general information on how to use the API documentation, conduct interactive testing, and configure API access.API Access and Interaction Guide
page that you are currently reading, you can:api-access-readme.mdx
file on GitHub.api-access-readme.mdx
) itself.
It does not apply to the individual API endpoint detail pages.