| | |
| | | --- |
| | | |
| | | <Heading |
| | | url='/app/feedbacks' |
| | | method='GET' |
| | | title='Get feedbacks of application' |
| | | name='#app-feedbacks' |
| | | /> |
| | | <Row> |
| | | <Col> |
| | | Get application's feedbacks. |
| | | |
| | | ### Query |
| | | <Properties> |
| | | <Property name='page' type='string' key='page'> |
| | | (optional)pagination,default:1 |
| | | </Property> |
| | | </Properties> |
| | | |
| | | <Properties> |
| | | <Property name='limit' type='string' key='limit'> |
| | | (optional) records per page default:20 |
| | | </Property> |
| | | </Properties> |
| | | |
| | | ### Response |
| | | - `data` (List) return apps feedback list. |
| | | </Col> |
| | | <Col sticky> |
| | | |
| | | <CodeGroup title="Request" tag="GET" label="/app/feedbacks" targetCode={`curl -X GET '${props.appDetail.api_base_url}/app/feedbacks?page=1&limit=20'`}> |
| | | |
| | | ```bash {{ title: 'cURL' }} |
| | | curl -X GET '${props.appDetail.api_base_url}/app/feedbacks?page=1&limit=20' \ |
| | | --header 'Authorization: Bearer {api_key}' \ |
| | | --header 'Content-Type: application/json' |
| | | ``` |
| | | |
| | | </CodeGroup> |
| | | |
| | | <CodeGroup title="Response"> |
| | | ```json {{ title: 'Response' }} |
| | | { |
| | | "data": [ |
| | | { |
| | | "id": "8c0fbed8-e2f9-49ff-9f0e-15a35bdd0e25", |
| | | "app_id": "f252d396-fe48-450e-94ec-e184218e7346", |
| | | "conversation_id": "2397604b-9deb-430e-b285-4726e51fd62d", |
| | | "message_id": "709c0b0f-0a96-4a4e-91a4-ec0889937b11", |
| | | "rating": "like", |
| | | "content": "message feedback information-3", |
| | | "from_source": "user", |
| | | "from_end_user_id": "74286412-9a1a-42c1-929c-01edb1d381d5", |
| | | "from_account_id": null, |
| | | "created_at": "2025-04-24T09:24:38", |
| | | "updated_at": "2025-04-24T09:24:38" |
| | | } |
| | | ] |
| | | } |
| | | ``` |
| | | </CodeGroup> |
| | | </Col> |
| | | </Row> |
| | | --- |
| | | |
| | | <Heading |
| | | url='/text-to-audio' |
| | | method='POST' |
| | | title='Text to Audio' |
| | |
| | | ### Request Body |
| | | |
| | | <Properties> |
| | | <Property name='message_id' type='str' key='message_id'> |
| | | <Property name='message_id' type='str' key='text'> |
| | | For text messages generated by Dify, simply pass the generated message-id directly. The backend will use the message-id to look up the corresponding content and synthesize the voice information directly. If both message_id and text are provided simultaneously, the message_id is given priority. |
| | | </Property> |
| | | <Property name='text' type='str' key='text'> |
| | |
| | | </CodeGroup> |
| | | </Col> |
| | | </Row> |
| | | --- |
| | | |
| | | <Heading |
| | | url='/site' |
| | | method='GET' |
| | | title='Get Application WebApp Settings' |
| | | name='#site' |
| | | /> |
| | | <Row> |
| | | <Col> |
| | | Used to get the WebApp settings of the application. |
| | | ### Response |
| | | - `title` (string) WebApp name |
| | | - `chat_color_theme` (string) Chat color theme, in hex format |
| | | - `chat_color_theme_inverted` (bool) Whether the chat color theme is inverted |
| | | - `icon_type` (string) Icon type, `emoji` - emoji, `image` - picture |
| | | - `icon` (string) Icon. If it's `emoji` type, it's an emoji symbol; if it's `image` type, it's an image URL. |
| | | - `icon_background` (string) Background color in hex format |
| | | - `icon_url` (string) Icon URL |
| | | - `description` (string) Description |
| | | - `copyright` (string) Copyright information |
| | | - `privacy_policy` (string) Privacy policy link |
| | | - `custom_disclaimer` (string) Custom disclaimer |
| | | - `default_language` (string) Default language |
| | | - `show_workflow_steps` (bool) Whether to show workflow details |
| | | - `use_icon_as_answer_icon` (bool) Whether to replace 🤖 in chat with the WebApp icon |
| | | </Col> |
| | | <Col> |
| | | <CodeGroup title="Request" tag="POST" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/site' \\\n-H 'Authorization: Bearer {api_key}'`}> |
| | | ```bash {{ title: 'cURL' }} |
| | | curl -X GET '${props.appDetail.api_base_url}/site' \ |
| | | -H 'Authorization: Bearer {api_key}' |
| | | ``` |
| | | |
| | | </CodeGroup> |
| | | |
| | | <CodeGroup title="Response"> |
| | | ```json {{ title: 'Response' }} |
| | | { |
| | | "title": "My App", |
| | | "chat_color_theme": "#ff4a4a", |
| | | "chat_color_theme_inverted": false, |
| | | "icon_type": "emoji", |
| | | "icon": "😄", |
| | | "icon_background": "#FFEAD5", |
| | | "icon_url": null, |
| | | "description": "This is my app.", |
| | | "copyright": "all rights reserved", |
| | | "privacy_policy": "", |
| | | "custom_disclaimer": "All generated by AI", |
| | | "default_language": "en-US", |
| | | "show_workflow_steps": false, |
| | | "use_icon_as_answer_icon": false, |
| | | } |
| | | ``` |
| | | </CodeGroup> |
| | | </Col> |
| | | </Row> |
| | | ___ |