# Dify Octri Demo

> Dify Octri Demo API documentation

## App
- [GET /app/feedbacks](https://octri-ku577k65z24u.octri.dev/get-app-feedbacks): List App Feedbacks

## Apps
- [POST /apps/annotation-reply/{action}](https://octri-ku577k65z24u.octri.dev/post-apps-annotation-reply-action): Configure Annotation Reply
- [GET /apps/annotation-reply/{action}/status/{job_id}](https://octri-ku577k65z24u.octri.dev/get-apps-annotation-reply-action-status-job_id): Get Annotation Reply Job Status
- [GET /apps/annotations](https://octri-ku577k65z24u.octri.dev/get-apps-annotations): List Annotations
- [POST /apps/annotations](https://octri-ku577k65z24u.octri.dev/post-apps-annotations): Create Annotation
- [PUT /apps/annotations/{annotation_id}](https://octri-ku577k65z24u.octri.dev/put-apps-annotations-annotation_id): Update Annotation
- [DELETE /apps/annotations/{annotation_id}](https://octri-ku577k65z24u.octri.dev/delete-apps-annotations-annotation_id): Delete Annotation

## Audio-to-text
- [POST /audio-to-text](https://octri-ku577k65z24u.octri.dev/post-audio-to-text): Convert Audio to Text

## Chat-messages
- [POST /chat-messages](https://octri-ku577k65z24u.octri.dev/post-chat-messages): Send Chat Message
- [POST /chat-messages/{task_id}/stop](https://octri-ku577k65z24u.octri.dev/post-chat-messages-task_id-stop): Stop Chat Message Generation

## Completion-messages
- [POST /completion-messages](https://octri-ku577k65z24u.octri.dev/post-completion-messages): Send Completion Message
- [POST /completion-messages/{task_id}/stop](https://octri-ku577k65z24u.octri.dev/post-completion-messages-task_id-stop): Stop Completion Message Generation

## Conversations
- [GET /conversations](https://octri-ku577k65z24u.octri.dev/get-conversations): List Conversations
- [DELETE /conversations/{conversation_id}](https://octri-ku577k65z24u.octri.dev/delete-conversations-conversation_id): Delete Conversation
- [POST /conversations/{conversation_id}/name](https://octri-ku577k65z24u.octri.dev/post-conversations-conversation_id-name): Rename Conversation
- [GET /conversations/{conversation_id}/variables](https://octri-ku577k65z24u.octri.dev/get-conversations-conversation_id-variables): List Conversation Variables
- [PUT /conversations/{conversation_id}/variables/{variable_id}](https://octri-ku577k65z24u.octri.dev/put-conversations-conversation_id-variables-variable_id): Update Conversation Variable

## Datasets
- [GET /datasets](https://octri-ku577k65z24u.octri.dev/get-datasets): List Knowledge Bases
- [POST /datasets](https://octri-ku577k65z24u.octri.dev/post-datasets): Create an empty knowledge base
- [GET /datasets/{dataset_id}](https://octri-ku577k65z24u.octri.dev/get-datasets-dataset_id): Get Knowledge Base
- [PATCH /datasets/{dataset_id}](https://octri-ku577k65z24u.octri.dev/patch-datasets-dataset_id): Update a knowledge base
- [DELETE /datasets/{dataset_id}](https://octri-ku577k65z24u.octri.dev/delete-datasets-dataset_id): Delete Knowledge Base
- [POST /datasets/{dataset_id}/document/create-by-file](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-document-create-by-file): Create Document by File
- [POST /datasets/{dataset_id}/document/create-by-text](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-document-create-by-text): Create a knowledge base document from text
- [GET /datasets/{dataset_id}/documents](https://octri-ku577k65z24u.octri.dev/get-datasets-dataset_id-documents): List Documents
- [GET /datasets/{dataset_id}/documents/{batch}/indexing-status](https://octri-ku577k65z24u.octri.dev/get-datasets-dataset_id-documents-batch-indexing-status): Get Document Indexing Status
- [GET /datasets/{dataset_id}/documents/{document_id}](https://octri-ku577k65z24u.octri.dev/get-datasets-dataset_id-documents-document_id): Get Document
- [PATCH /datasets/{dataset_id}/documents/{document_id}](https://octri-ku577k65z24u.octri.dev/patch-datasets-dataset_id-documents-document_id): Update Document
- [DELETE /datasets/{dataset_id}/documents/{document_id}](https://octri-ku577k65z24u.octri.dev/delete-datasets-dataset_id-documents-document_id): Delete Document
- [GET /datasets/{dataset_id}/documents/{document_id}/download](https://octri-ku577k65z24u.octri.dev/get-datasets-dataset_id-documents-document_id-download): Download Document
- [GET /datasets/{dataset_id}/documents/{document_id}/segments](https://octri-ku577k65z24u.octri.dev/get-datasets-dataset_id-documents-document_id-segments): List Chunks
- [POST /datasets/{dataset_id}/documents/{document_id}/segments](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-documents-document_id-segments): Create document chunks
- [GET /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}](https://octri-ku577k65z24u.octri.dev/get-datasets-dataset_id-documents-document_id-segments-segment_id): Get document chunk details
- [POST /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-documents-document_id-segments-segment_id): Update Chunk
- [DELETE /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}](https://octri-ku577k65z24u.octri.dev/delete-datasets-dataset_id-documents-document_id-segments-segment_id): Delete a document chunk
- [GET /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks](https://octri-ku577k65z24u.octri.dev/get-datasets-dataset_id-documents-document_id-segments-segment_id-child_chunks): List Child Chunks
- [POST /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-documents-document_id-segments-segment_id-child_chunks): Create Child Chunk
- [PATCH /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}](https://octri-ku577k65z24u.octri.dev/patch-datasets-dataset_id-documents-document_id-segments-segment_id-child_chunks-child_chunk_id): Update child chunk content
- [DELETE /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}](https://octri-ku577k65z24u.octri.dev/delete-datasets-dataset_id-documents-document_id-segments-segment_id-child_chunks-child_chunk_id): Delete Child Chunk
- [POST /datasets/{dataset_id}/documents/{document_id}/update-by-file](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-documents-document_id-update-by-file): Update Document by File
- [POST /datasets/{dataset_id}/documents/{document_id}/update-by-text](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-documents-document_id-update-by-text): Update document content or processing configuration
- [POST /datasets/{dataset_id}/documents/download-zip](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-documents-download-zip): Download Documents as ZIP
- [POST /datasets/{dataset_id}/documents/metadata](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-documents-metadata): Update Document Metadata in Batch
- [PATCH /datasets/{dataset_id}/documents/status/{action}](https://octri-ku577k65z24u.octri.dev/patch-datasets-dataset_id-documents-status-action): Update Document Status in Batch
- [GET /datasets/{dataset_id}/metadata](https://octri-ku577k65z24u.octri.dev/get-datasets-dataset_id-metadata): List Metadata Fields
- [POST /datasets/{dataset_id}/metadata](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-metadata): Create Metadata Field
- [PATCH /datasets/{dataset_id}/metadata/{metadata_id}](https://octri-ku577k65z24u.octri.dev/patch-datasets-dataset_id-metadata-metadata_id): Rename a custom metadata field
- [DELETE /datasets/{dataset_id}/metadata/{metadata_id}](https://octri-ku577k65z24u.octri.dev/delete-datasets-dataset_id-metadata-metadata_id): Delete Metadata Field
- [GET /datasets/{dataset_id}/metadata/built-in](https://octri-ku577k65z24u.octri.dev/get-datasets-dataset_id-metadata-built-in): Get Built-in Metadata Fields
- [POST /datasets/{dataset_id}/metadata/built-in/{action}](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-metadata-built-in-action): Update Built-in Metadata Field
- [GET /datasets/{dataset_id}/pipeline/datasource-plugins](https://octri-ku577k65z24u.octri.dev/get-datasets-dataset_id-pipeline-datasource-plugins): List Datasource Plugins
- [POST /datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-pipeline-datasource-nodes-node_id-run): Run Datasource Node
- [POST /datasets/{dataset_id}/pipeline/run](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-pipeline-run): Run Pipeline
- [POST /datasets/{dataset_id}/retrieve](https://octri-ku577k65z24u.octri.dev/post-datasets-dataset_id-retrieve): Retrieve relevant chunks from a knowledge base
- [GET /datasets/{dataset_id}/tags](https://octri-ku577k65z24u.octri.dev/get-datasets-dataset_id-tags): List tags bound to a knowledge base
- [POST /datasets/pipeline/file-upload](https://octri-ku577k65z24u.octri.dev/post-datasets-pipeline-file-upload): Upload Pipeline File
- [GET /datasets/tags](https://octri-ku577k65z24u.octri.dev/get-datasets-tags): List knowledge base tags
- [POST /datasets/tags](https://octri-ku577k65z24u.octri.dev/post-datasets-tags): Create a knowledge base tag
- [PATCH /datasets/tags](https://octri-ku577k65z24u.octri.dev/patch-datasets-tags): Update a knowledge base tag
- [DELETE /datasets/tags](https://octri-ku577k65z24u.octri.dev/delete-datasets-tags): Delete Knowledge Tag
- [POST /datasets/tags/binding](https://octri-ku577k65z24u.octri.dev/post-datasets-tags-binding): Create Tag Binding
- [POST /datasets/tags/unbinding](https://octri-ku577k65z24u.octri.dev/post-datasets-tags-unbinding): Remove tag bindings from a knowledge base

## End-users
- [GET /end-users/{end_user_id}](https://octri-ku577k65z24u.octri.dev/get-end-users-end_user_id): Get End User Info

## Files
- [GET /files/{file_id}/preview](https://octri-ku577k65z24u.octri.dev/get-files-file_id-preview): Download File
- [POST /files/upload](https://octri-ku577k65z24u.octri.dev/post-files-upload): Upload File

## Form
- [GET /form/human_input/{form_token}](https://octri-ku577k65z24u.octri.dev/get-form-human_input-form_token): Get Human Input Form
- [POST /form/human_input/{form_token}](https://octri-ku577k65z24u.octri.dev/post-form-human_input-form_token): Submit Human Input Form

## Info
- [GET /info](https://octri-ku577k65z24u.octri.dev/get-info): Get App Info

## Messages
- [GET /messages](https://octri-ku577k65z24u.octri.dev/get-messages): List Conversation Messages
- [POST /messages/{message_id}/feedbacks](https://octri-ku577k65z24u.octri.dev/post-messages-message_id-feedbacks): Submit Message Feedback
- [GET /messages/{message_id}/suggested](https://octri-ku577k65z24u.octri.dev/get-messages-message_id-suggested): Get Next Suggested Questions

## Meta
- [GET /meta](https://octri-ku577k65z24u.octri.dev/get-meta): Get App Meta

## Parameters
- [GET /parameters](https://octri-ku577k65z24u.octri.dev/get-parameters): Get App Parameters

## Site
- [GET /site](https://octri-ku577k65z24u.octri.dev/get-site): Get App WebApp Settings

## Text-to-audio
- [POST /text-to-audio](https://octri-ku577k65z24u.octri.dev/post-text-to-audio): Convert Text to Audio

## Workflow
- [GET /workflow/{workflow_run_id}/events](https://octri-ku577k65z24u.octri.dev/get-workflow-workflow_run_id-events): Stream Workflow Events

## Workflows
- [POST /workflows/{workflow_id}/run](https://octri-ku577k65z24u.octri.dev/post-workflows-workflow_id-run): Run Workflow by ID
- [GET /workflows/logs](https://octri-ku577k65z24u.octri.dev/get-workflows-logs): List Workflow Logs
- [POST /workflows/run](https://octri-ku577k65z24u.octri.dev/post-workflows-run): Run Workflow
- [GET /workflows/run/{workflow_run_id}](https://octri-ku577k65z24u.octri.dev/get-workflows-run-workflow_run_id): Get Workflow Run Detail
- [POST /workflows/tasks/{task_id}/stop](https://octri-ku577k65z24u.octri.dev/post-workflows-tasks-task_id-stop): Stop Workflow Task

## Workspaces
- [GET /workspaces/current/models/model-types/{model_type}](https://octri-ku577k65z24u.octri.dev/get-workspaces-current-models-model-types-model_type): Get Available Models

## Optional
- [Changelog](https://octri-ku577k65z24u.octri.dev/changelog): API version history and breaking changes