# Dify integration

> Run Dify chat, completion, agent and workflow apps and manage knowledge bases, documents and chunks through the Dify Service API.

- Authentication: apiKey

## Tools (81)

- **Configure Annotation Reply**: Enables or disables annotation reply for the app.
- **Convert Audio to Text**: Transcribes an uploaded audio file to text using the workspace's default speech-to-text model.
- **Convert Text to Audio**: Converts text to speech audio.
- **Create an Empty Knowledge Base**: Creates an empty knowledge base.
- **Create Annotation**: Creates an annotation.
- **Create Child Chunk**: Create a child chunk under a parent chunk.
- **Create Chunks**: Create one or more chunks within a document.
- **Create Document by File**: Creates a document in a knowledge base from an uploaded file.
- **Create Document by Text**: Creates a document in a knowledge base from raw text.
- **Create Knowledge Tag**: Create a tag for organizing knowledge bases.
- **Create Metadata Field**: Create a custom metadata field for annotating documents in the knowledge base with structured information.
- **Create Tag Binding**: Bind one or more tags to a knowledge base.
- **Delete Annotation**: Deletes an annotation and its associated hit history.
- **Delete Child Chunk**: Permanently delete a child chunk from its parent chunk.
- **Delete Chunk**: Permanently delete a chunk from the document.
- **Delete Conversation**: Deletes a conversation.
- **Delete Document**: Permanently deletes a document and all its chunks from the knowledge base.
- **Delete Knowledge Base**: Permanently deletes a knowledge base, all of its documents, and any API key scoped only to it.
- **Delete Knowledge Tag**: Permanently delete a knowledge base tag.
- **Delete Metadata Field**: Permanently delete a custom metadata field.
- **Delete Tag Binding**: Remove one or more tags from a knowledge base.
- **Download Document**: Returns a signed URL for downloading a document's original uploaded file.
- **Download Documents as ZIP**: Downloads one or more documents as a single ZIP archive.
- **Download File**: Returns the raw bytes of a file previously returned by Upload File.
- **Get Annotation Reply Job Status**: Returns the status of an annotation reply configuration job started by Configure Annotation Reply.
- **Get App Info**: Returns basic information about the app: name, description, tags, mode, and author.
- **Get App Meta**: Returns the display icons for the tools this app uses, keyed by tool name.
- **Get App Parameters**: Returns the app's front-end configuration: the opening statement and suggested questions, feature toggles, the user input form, and file-upload limits.
- **Get App WebApp Settings**: Returns the branding and display settings for the app's hosted web app, such as its title, icon, theme colors, and default language.
- **Get Available Models**: Returns the available models of a given type.
- **Get Built-in Metadata Fields**: Returns the built-in metadata fields provided by the system.
- **Get Chunk**: Retrieve the full details of a single chunk.
- **Get Document**: Returns detailed information for a single document.
- **Get Document Indexing Status**: Returns indexing progress for every document in a batch: the current stage and chunk completion counts.
- **Get End User Info**: Returns an end user's details by ID.
- **Get Human Input Form**: Returns the contents of a paused Human Input form.
- **Get Knowledge Base**: Returns detailed information about a knowledge base, including its embedding model, retrieval configuration, and document statistics.
- **Get Knowledge Base Tags**: Returns the tags bound to a knowledge base.
- **Get Next Suggested Questions**: Returns the follow-up questions suggested for a message.
- **Get Workflow Run Detail**: Get a single workflow run's status, inputs, outputs, and execution metrics.
- **List Annotations**: Lists the app's annotations, optionally filtered by keyword.
- **List App Feedbacks**: Returns a paginated list of all feedback on the app's messages, including both end-user and admin submissions.
- **List Child Chunks**: Returns a paginated list of child chunks under a specific parent chunk.
- **List Chunks**: Returns a paginated list of chunks within a document, optionally filtered by keyword or indexing status.
- **List Conversation Messages**: Returns a conversation's message history, newest first.
- **List Conversations**: Lists an end user's conversations, most recently active first.
- **List Conversation Variables**: Lists the variables stored in a conversation.
- **List Datasource Plugins**: Returns the datasource nodes configured in the knowledge pipeline, each with the plugin it uses and the metadata needed to run it.
- **List Documents**: Returns a paginated list of documents in a knowledge base.
- **List Knowledge Bases**: Returns a paginated list of knowledge bases, optionally filtered by keyword or tags.
- **List Knowledge Tags**: Returns all knowledge base tags in the workspace.
- **List Metadata Fields**: Returns all metadata fields for the knowledge base, both custom and built-in, with the count of documents using each field.
- **List Workflow Logs**: List past workflow runs with optional filters.
- **Rename Conversation**: Renames a conversation, or auto-generates a name from its messages when `auto_generate` is `true`.
- **Retrieve Chunks from a Knowledge Base / Test Retrieval**: Searches a knowledge base and returns the chunks most relevant to the query, for both production retrieval and test retrieval.
- **Run Datasource Node**: Runs a single datasource node in the knowledge pipeline and streams its execution events.
- **Run Pipeline**: Runs the full knowledge pipeline over one or more datasources.
- **Run Workflow**: Run the app's published workflow and return its outputs, either in a single `blocking` response or as a `streaming` Server-Sent Events feed.
- **Run Workflow by ID**: Run a specific published workflow version, identified by the `workflow_id` in the path.
- **Send Chat Message**: Sends a message to a chat app and returns the assistant's reply.
- **Send Completion Message**: Sends a request to a text-generation app and returns the generated text.
- **Stop Chat Message Generation**: Stops a chat message generation task.
- **Stop Completion Message Generation**: Stops a completion message generation task.
- **Stop Workflow Task**: Stop a running workflow task.
- **Stream Workflow Events**: Resume the Server-Sent Events stream for a workflow run after a pause or a dropped SSE connection.
- **Submit Human Input Form**: Submits the recipient's response to a paused Human Input form.
- **Submit Message Feedback**: Records a `like` or `dislike` rating, plus an optional comment, on a message.
- **Update Annotation**: Updates an annotation's question and answer.
- **Update Built-in Metadata Field**: Enable or disable built-in metadata fields for the knowledge base.
- **Update Child Chunk**: Update the content of an existing child chunk.
- **Update Chunk**: Update a chunk's fields.
- **Update Conversation Variable**: Updates a conversation variable's value.
- **Update Document**: Updates a document by uploading a new file, then re-indexes it.
- **Update Document by Text**: Updates a document's text content, name, or processing configuration.
- **Update Document Metadata in Batch**: Update metadata values for multiple documents in a single request.
- **Update Document Status in Batch**: Enables, disables, archives, or unarchives multiple documents in one request.
- **Update Knowledge Base**: Updates a knowledge base.
- **Update Knowledge Tag**: Rename a knowledge base tag.
- **Update Metadata Field**: Rename a custom metadata field.
- **Upload File**: Uploads a file and returns its `id` for later requests to reference.
- **Upload Pipeline File**: Uploads a file for use in a knowledge pipeline.

Connect Dify in General Input: https://www.generalinput.com/apps/dify