|
import { CodeGroup } from '../code.tsx'
|
|
import { Row, Col, Properties, Property, Heading, SubProperty, Paragraph } from '../md.tsx'
|
|
|
|
# Advanced Chat App API
|
|
|
|
Chat applications support session persistence, allowing previous chat history to be used as context for responses. This can be applicable for chatbots, customer service AI, etc.
|
|
|
|
<div>
|
|
### Base URL
|
|
<CodeGroup title="Code" targetCode={props.appDetail.api_base_url}>
|
|
```javascript
|
|
```
|
|
</CodeGroup>
|
|
|
|
### Authentication
|
|
|
|
The Service API uses `API-Key` authentication.
|
|
<i>**Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.**</i>
|
|
|
|
For all API requests, include your API Key in the `Authorization`HTTP Header, as shown below:
|
|
|
|
<CodeGroup title="Code">
|
|
```javascript
|
|
Authorization: Bearer {API_KEY}
|
|
|
|
```
|
|
</CodeGroup>
|
|
</div>
|
|
|
|
---
|
|
|
|
<Heading
|
|
url='/chat-messages'
|
|
method='POST'
|
|
title='Send Chat Message'
|
|
name='#Send-Chat-Message'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
Send a request to the chat application.
|
|
|
|
### Request Body
|
|
|
|
<Properties>
|
|
<Property name='query' type='string' key='query'>
|
|
User Input/Question content
|
|
</Property>
|
|
<Property name='inputs' type='object' key='inputs'>
|
|
Allows the entry of various variable values defined by the App.
|
|
The `inputs` parameter contains multiple key/value pairs, with each key corresponding to a specific variable and each value being the specific value for that variable. Default `{}`
|
|
</Property>
|
|
<Property name='response_mode' type='string' key='response_mode'>
|
|
The mode of response return, supporting:
|
|
- `streaming` Streaming mode (recommended), implements a typewriter-like output through SSE ([Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)).
|
|
- `blocking` Blocking mode, returns result after execution is complete. (Requests may be interrupted if the process is long)
|
|
Due to Cloudflare restrictions, the request will be interrupted without a return after 100 seconds.
|
|
</Property>
|
|
<Property name='user' type='string' key='user'>
|
|
User identifier, used to define the identity of the end-user for retrieval and statistics.
|
|
Should be uniquely defined by the developer within the application.
|
|
</Property>
|
|
<Property name='conversation_id' type='string' key='conversation_id'>
|
|
Converation ID, to continue the conversation based on previous chat records, it is necessary to pass the previous message's conversation_id.
|
|
</Property>
|
|
<Property name='files' type='array[object]' key='files'>
|
|
File list, suitable for inputting files (images) combined with text understanding and answering questions, available only when the model supports Vision capability.
|
|
- `type` (string) Supported type: `image` (currently only supports image type)
|
|
- `transfer_method` (string) Transfer method, `remote_url` for image URL / `local_file` for file upload
|
|
- `url` (string) Image URL (when the transfer method is `remote_url`)
|
|
- `upload_file_id` (string) Uploaded file ID, which must be obtained by uploading through the File Upload API in advance (when the transfer method is `local_file`)
|
|
</Property>
|
|
<Property name='auto_generate_name' type='bool' key='auto_generate_name'>
|
|
Auto-generate title, default is `true`.
|
|
If set to `false`, can achieve async title generation by calling the conversation rename API and setting `auto_generate` to `true`.
|
|
</Property>
|
|
</Properties>
|
|
|
|
### Response
|
|
When response_mode is blocking, return a CompletionResponse object.
|
|
When response_mode is streaming, return a ChunkCompletionResponse stream.
|
|
|
|
### ChatCompletionResponse
|
|
Returns the complete App result, `Content-Type` is `application/json`.
|
|
- `message_id` (string) Unique message ID
|
|
- `conversation_id` (string) Conversation ID
|
|
- `mode` (string) App mode, fixed as `chat`
|
|
- `answer` (string) Complete response content
|
|
- `metadata` (object) Metadata
|
|
- `usage` (Usage) Model usage information
|
|
- `retriever_resources` (array[RetrieverResource]) Citation and Attribution List
|
|
- `created_at` (int) Message creation timestamp, e.g., 1705395332
|
|
|
|
### ChunkChatCompletionResponse
|
|
Returns the stream chunks outputted by the App, `Content-Type` is `text/event-stream`.
|
|
Each streaming chunk starts with `data:`, separated by two newline characters `\n\n`, as shown below:
|
|
<CodeGroup>
|
|
```streaming {{ title: 'Response' }}
|
|
data: {"event": "message", "task_id": "900bbd43-dc0b-4383-a372-aa6e6c414227", "id": "663c5084-a254-4040-8ad3-51f2a3c1a77c", "answer": "Hi", "created_at": 1705398420}\n\n
|
|
```
|
|
</CodeGroup>
|
|
The structure of the streaming chunks varies depending on the `event`:
|
|
- `event: message` LLM returns text chunk event, i.e., the complete text is output in a chunked fashion.
|
|
- `task_id` (string) Task ID, used for request tracking and the below Stop Generate API
|
|
- `message_id` (string) Unique message ID
|
|
- `conversation_id` (string) Conversation ID
|
|
- `answer` (string) LLM returned text chunk content
|
|
- `created_at` (int) Creation timestamp, e.g., 1705395332
|
|
- `event: message_file` Message file event, a new file has created by tool
|
|
- `id` (string) File unique ID
|
|
- `type` (string) File type，only allow "image" currently
|
|
- `belongs_to` (string) Belongs to, it will only be an 'assistant' here
|
|
- `url` (string) Remote url of file
|
|
- `conversation_id` (string) Conversation ID
|
|
- `event: message_end` Message end event, receiving this event means streaming has ended.
|
|
- `task_id` (string) Task ID, used for request tracking and the below Stop Generate API
|
|
- `message_id` (string) Unique message ID
|
|
- `conversation_id` (string) Conversation ID
|
|
- `metadata` (object) Metadata
|
|
- `usage` (Usage) Model usage information
|
|
- `retriever_resources` (array[RetrieverResource]) Citation and Attribution List
|
|
- `event: message_replace` Message content replacement event.
|
|
When output content moderation is enabled, if the content is flagged, then the message content will be replaced with a preset reply through this event.
|
|
- `task_id` (string) Task ID, used for request tracking and the below Stop Generate API
|
|
- `message_id` (string) Unique message ID
|
|
- `conversation_id` (string) Conversation ID
|
|
- `answer` (string) Replacement content (directly replaces all LLM reply text)
|
|
- `created_at` (int) Creation timestamp, e.g., 1705395332
|
|
- `event: workflow_started` workflow starts execution
|
|
- `task_id` (string) Task ID, used for request tracking and the below Stop Generate API
|
|
- `workflow_run_id` (string) Unique ID of workflow execution
|
|
- `event` (string) fixed to `workflow_started`
|
|
- `data` (object) detail
|
|
- `id` (string) Unique ID of workflow execution
|
|
- `workflow_id` (string) ID of relatied workflow
|
|
- `sequence_number` (int) Self-increasing serial number, self-increasing in the App, starting from 1
|
|
- `created_at` (timestamp) Creation timestamp, e.g., 1705395332
|
|
- `event: node_started` node execution started
|
|
- `task_id` (string) Task ID, used for request tracking and the below Stop Generate API
|
|
- `workflow_run_id` (string) Unique ID of workflow execution
|
|
- `event` (string) fixed to `node_started`
|
|
- `data` (object) detail
|
|
- `id` (string) Unique ID of workflow execution
|
|
- `node_id` (string) ID of node
|
|
- `node_type` (string) type of node
|
|
- `title` (string) name of node
|
|
- `index` (int) Execution sequence number, used to display Tracing Node sequence
|
|
- `predecessor_node_id` (string) optional Prefix node ID, used for canvas display execution path
|
|
- `inputs` (array[object]) Contents of all preceding node variables used in the node
|
|
- `created_at` (timestamp) timestamp of start, e.g., 1705395332
|
|
- `event: node_finished` node execution ends, success or failure in different states in the same event
|
|
- `task_id` (string) Task ID, used for request tracking and the below Stop Generate API
|
|
- `workflow_run_id` (string) Unique ID of workflow execution
|
|
- `event` (string) fixed to `node_finished`
|
|
- `data` (object) detail
|
|
- `id` (string) Unique ID of workflow execution
|
|
- `node_id` (string) ID of node
|
|
- `node_type` (string) type of node
|
|
- `title` (string) name of node
|
|
- `index` (int) Execution sequence number, used to display Tracing Node sequence
|
|
- `predecessor_node_id` (string) optional Prefix node ID, used for canvas display execution path
|
|
- `inputs` (array[object]) Contents of all preceding node variables used in the node
|
|
- `process_data` (json) Optional node process data
|
|
- `outputs` (json) Optional content of output
|
|
- `status` (string) status of execution, `running` / `succeeded` / `failed` / `stopped`
|
|
- `error` (string) Optional reason of error
|
|
- `elapsed_time` (float) Optional total seconds to be used
|
|
- `execution_metadata` (json) meta data
|
|
- `total_tokens` (int) optional tokens to be used
|
|
- `total_price` (decimal) optional Total cost
|
|
- `currency` (string) optional e.g. `USD` / `RMB`
|
|
- `created_at` (timestamp) timestamp of start, e.g., 1705395332
|
|
- `event: workflow_finished` workflow execution ends, success or failure in different states in the same event
|
|
- `task_id` (string) Task ID, used for request tracking and the below Stop Generate API
|
|
- `workflow_run_id` (string) Unique ID of workflow execution
|
|
- `event` (string) fixed to `workflow_finished`
|
|
- `data` (object) detail
|
|
- `id` (string) ID of workflow execution
|
|
- `workflow_id` (string) ID of relatied workflow
|
|
- `status` (string) status of execution, `running` / `succeeded` / `failed` / `stopped`
|
|
- `outputs` (json) Optional content of output
|
|
- `error` (string) Optional reason of error
|
|
- `elapsed_time` (float) Optional total seconds to be used
|
|
- `total_tokens` (int) Optional tokens to be used
|
|
- `total_steps` (int) default 0
|
|
- `created_at` (timestamp) start time
|
|
- `finished_at` (timestamp) end time
|
|
- `event: error`
|
|
Exceptions that occur during the streaming process will be output in the form of stream events, and reception of an error event will end the stream.
|
|
- `task_id` (string) Task ID, used for request tracking and the below Stop Generate API
|
|
- `message_id` (string) Unique message ID
|
|
- `status` (int) HTTP status code
|
|
- `code` (string) Error code
|
|
- `message` (string) Error message
|
|
- `event: ping` Ping event every 10 seconds to keep the connection alive.
|
|
|
|
### Errors
|
|
- 404, Conversation does not exists
|
|
- 400, `invalid_param`, abnormal parameter input
|
|
- 400, `app_unavailable`, App configuration unavailable
|
|
- 400, `provider_not_initialize`, no available model credential configuration
|
|
- 400, `provider_quota_exceeded`, model invocation quota insufficient
|
|
- 400, `model_currently_not_support`, current model unavailable
|
|
- 400, `completion_request_error`, text generation failed
|
|
- 500, internal server error
|
|
|
|
</Col>
|
|
<Col sticky>
|
|
|
|
<CodeGroup title="Request" tag="POST" label="/chat-messages" targetCode={`curl -X POST '${props.appDetail.api_base_url}/chat-messages' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n "inputs": ${JSON.stringify(props.inputs)},\n "query": "What are the specs of the iPhone 13 Pro Max?",\n "response_mode": "streaming",\n "conversation_id": "",\n "user": "abc-123",\n "files": [\n {\n "type": "image",\n "transfer_method": "remote_url",\n "url": "https://cloud.dify.ai/logo/logo-site.png"\n }\n ]\n}'`}>
|
|
|
|
```bash {{ title: 'cURL' }}
|
|
curl -X POST '${props.appDetail.api_base_url}/chat-messages' \
|
|
--header 'Authorization: Bearer {api_key}' \
|
|
--header 'Content-Type: application/json' \
|
|
--data-raw '{
|
|
"inputs": {},
|
|
"query": "eh",
|
|
"response_mode": "streaming",
|
|
"conversation_id": "1c7e55fb-1ba2-4e10-81b5-30addcea2276",
|
|
"user": "abc-123"
|
|
}'
|
|
```
|
|
</CodeGroup>
|
|
### Blocking Mode
|
|
<CodeGroup title="Response">
|
|
```json {{ title: 'Response' }}
|
|
{
|
|
"event": "message",
|
|
"message_id": "9da23599-e713-473b-982c-4328d4f5c78a",
|
|
"conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2",
|
|
"mode": "chat",
|
|
"answer": "iPhone 13 Pro Max specs are listed heere:...",
|
|
"metadata": {
|
|
"usage": {
|
|
"prompt_tokens": 1033,
|
|
"prompt_unit_price": "0.001",
|
|
"prompt_price_unit": "0.001",
|
|
"prompt_price": "0.0010330",
|
|
"completion_tokens": 128,
|
|
"completion_unit_price": "0.002",
|
|
"completion_price_unit": "0.001",
|
|
"completion_price": "0.0002560",
|
|
"total_tokens": 1161,
|
|
"total_price": "0.0012890",
|
|
"currency": "USD",
|
|
"latency": 0.7682376249867957
|
|
},
|
|
"retriever_resources": [
|
|
{
|
|
"position": 1,
|
|
"dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb",
|
|
"dataset_name": "iPhone",
|
|
"document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00",
|
|
"document_name": "iPhone List",
|
|
"segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a",
|
|
"score": 0.98457545,
|
|
"content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\""
|
|
}
|
|
]
|
|
},
|
|
"created_at": 1705407629
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
### Streaming Mode
|
|
<CodeGroup title="Response">
|
|
```streaming {{ title: 'Response' }}
|
|
data: {"event": "workflow_started", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "workflow_id": "dfjasklfjdslag", "sequence_number": 1, "created_at": 1679586595}}
|
|
data: {"event": "node_started", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "node_id": "dfjasklfjdslag", "node_type": "start", "title": "Start", "index": 0, "predecessor_node_id": "fdljewklfklgejlglsd", "inputs": {}, "created_at": 1679586595}}
|
|
data: {"event": "node_finished", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "node_id": "dfjasklfjdslag", "node_type": "start", "title": "Start", "index": 0, "predecessor_node_id": "fdljewklfklgejlglsd", "inputs": {}, "outputs": {}, "status": "succeeded", "elapsed_time": 0.324, "execution_metadata": {"total_tokens": 63127864, "total_price": 2.378, "currency": "USD"}, "created_at": 1679586595}}
|
|
data: {"event": "workflow_finished", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "workflow_id": "dfjasklfjdslag", "outputs": {}, "status": "succeeded", "elapsed_time": 0.324, "total_tokens": 63127864, "total_steps": "1", "created_at": 1679586595, "finished_at": 1679976595}}
|
|
data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " I", "created_at": 1679586595}
|
|
data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": "'m", "created_at
|
|
data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " glad", "created_at": 1679586595}
|
|
data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " to", "created_at": 1679586595}
|
|
data: {"event": "message", "message_id": : "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " meet", "created_at": 1679586595}
|
|
data: {"event": "message", "message_id": : "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " you", "created_at": 1679586595}
|
|
data: {"event": "message_end", "id": "5e52ce04-874b-4d27-9045-b3bc80def685", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "metadata": {"usage": {"prompt_tokens": 1033, "prompt_unit_price": "0.001", "prompt_price_unit": "0.001", "prompt_price": "0.0010330", "completion_tokens": 135, "completion_unit_price": "0.002", "completion_price_unit": "0.001", "completion_price": "0.0002700", "total_tokens": 1168, "total_price": "0.0013030", "currency": "USD", "latency": 1.381760165997548, "retriever_resources": [{"position": 1, "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb", "dataset_name": "iPhone", "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00", "document_name": "iPhone List", "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a", "score": 0.98457545, "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\""}]}}}
|
|
```
|
|
</CodeGroup>
|
|
|
|
</Col>
|
|
</Row>
|
|
|
|
---
|
|
<Heading
|
|
url='/files/upload'
|
|
method='POST'
|
|
title='File Upload'
|
|
name='#file-upload'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
Upload a file (currently only images are supported) for use when sending messages, enabling multimodal understanding of images and text.
|
|
Supports png, jpg, jpeg, webp, gif formats.
|
|
Uploaded files are for use by the current end-user only.
|
|
|
|
### Request Body
|
|
This interface requires a `multipart/form-data` request.
|
|
- `file` (File) Required
|
|
The file to be uploaded.
|
|
- `user` (string) Required
|
|
User identifier, defined by the developer's rules, must be unique within the application.
|
|
|
|
### Response
|
|
After a successful upload, the server will return the file's ID and related information.
|
|
- `id` (uuid) ID
|
|
- `name` (string) File name
|
|
- `size` (int) File size (bytes)
|
|
- `extension` (string) File extension
|
|
- `mime_type` (string) File mime-type
|
|
- `created_by` (uuid) End-user ID
|
|
- `created_at` (timestamp) Creation timestamp, e.g., 1705395332
|
|
|
|
### Errors
|
|
- 400, `no_file_uploaded`, a file must be provided
|
|
- 400, `too_many_files`, currently only one file is accepted
|
|
- 400, `unsupported_preview`, the file does not support preview
|
|
- 400, `unsupported_estimate`, the file does not support estimation
|
|
- 413, `file_too_large`, the file is too large
|
|
- 415, `unsupported_file_type`, unsupported extension, currently only document files are accepted
|
|
- 503, `s3_connection_failed`, unable to connect to S3 service
|
|
- 503, `s3_permission_denied`, no permission to upload files to S3
|
|
- 503, `s3_file_too_large`, file exceeds S3 size limit
|
|
- 500, internal server error
|
|
|
|
|
|
</Col>
|
|
<Col sticky>
|
|
### Request Example
|
|
<CodeGroup title="Request" tag="POST" label="/files/upload" targetCode={`curl -X POST '${props.appDetail.api_base_url}/files/upload' \\\n--header 'Authorization: Bearer {api_key}' \\\n--form 'file=@localfile;type=image/[png|jpeg|jpg|webp|gif] \\\n--form 'user=abc-123'`}>
|
|
|
|
```bash {{ title: 'cURL' }}
|
|
curl -X POST '${props.appDetail.api_base_url}/files/upload' \
|
|
--header 'Authorization: Bearer {api_key}' \
|
|
--form 'file=@"/path/to/file"'
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
|
|
### Response Example
|
|
<CodeGroup title="Response">
|
|
```json {{ title: 'Response' }}
|
|
{
|
|
"id": "72fa9618-8f89-4a37-9b33-7e1178a24a67",
|
|
"name": "example.png",
|
|
"size": 1024,
|
|
"extension": "png",
|
|
"mime_type": "image/png",
|
|
"created_by": "6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13",
|
|
"created_at": 1577836800,
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
</Col>
|
|
</Row>
|
|
---
|
|
|
|
<Heading
|
|
url='/chat-messages/:task_id/stop'
|
|
method='POST'
|
|
title='Stop Generate'
|
|
name='#stop-generatebacks'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
Only supported in streaming mode.
|
|
### Path
|
|
- `task_id` (string) Task ID, can be obtained from the streaming chunk return
|
|
### Request Body
|
|
- `user` (string) Required
|
|
User identifier, used to define the identity of the end-user, must be consistent with the user passed in the send message interface.
|
|
### Response
|
|
- `result` (string) Always returns "success"
|
|
</Col>
|
|
<Col sticky>
|
|
### Request Example
|
|
<CodeGroup title="Request" tag="POST" label="/chat-messages/:task_id/stop" targetCode={`curl -X POST '${props.appDetail.api_base_url}/chat-messages/:task_id/stop' \\\n-H 'Authorization: Bearer {api_key}' \\\n-H 'Content-Type: application/json' \\\n--data-raw '{"user": "abc-123"}'`}>
|
|
```bash {{ title: 'cURL' }}
|
|
curl -X POST '${props.appDetail.api_base_url}/chat-messages/:task_id/stop' \
|
|
-H 'Authorization: Bearer {api_key}' \
|
|
-H 'Content-Type: application/json' \
|
|
--data-raw '{
|
|
"user": "abc-123"
|
|
}'
|
|
```
|
|
</CodeGroup>
|
|
|
|
### Response Example
|
|
<CodeGroup title="Response">
|
|
```json {{ title: 'Response' }}
|
|
{
|
|
"result": "success"
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
</Col>
|
|
</Row>
|
|
|
|
---
|
|
|
|
<Heading
|
|
url='/messages/:message_id/feedbacks'
|
|
method='POST'
|
|
title='Message Feedback'
|
|
name='#feedbacks'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
End-users can provide feedback messages, facilitating application developers to optimize expected outputs.
|
|
|
|
### Path
|
|
<Properties>
|
|
<Property name='message_id' type='string' key='message_id'>
|
|
Message ID
|
|
</Property>
|
|
</Properties>
|
|
|
|
### Request Body
|
|
|
|
<Properties>
|
|
<Property name='rating' type='string' key='rating'>
|
|
Upvote as `like`, downvote as `dislike`, revoke upvote as `null`
|
|
</Property>
|
|
<Property name='user' type='string' key='user'>
|
|
User identifier, defined by the developer's rules, must be unique within the application.
|
|
</Property>
|
|
</Properties>
|
|
|
|
### Response
|
|
- `result` (string) Always returns "success"
|
|
</Col>
|
|
<Col sticky>
|
|
|
|
<CodeGroup title="Request" tag="POST" label="/messages/:message_id/feedbacks" targetCode={`curl -X POST '${props.appDetail.api_base_url}/messages/:message_id/feedbacks \\\n --header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n "rating": "like",\n "user": "abc-123"\n}'`}>
|
|
|
|
```bash {{ title: 'cURL' }}
|
|
curl -X POST '${props.appDetail.api_base_url}/messages/:message_id/feedbacks' \
|
|
--header 'Authorization: Bearer {api_key}' \
|
|
--header 'Content-Type: application/json' \
|
|
--data-raw '{
|
|
"rating": "like",
|
|
"user": "abc-123"
|
|
}'
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
<CodeGroup title="Response">
|
|
```json {{ title: 'Response' }}
|
|
{
|
|
"result": "success"
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
</Col>
|
|
</Row>
|
|
|
|
---
|
|
|
|
<Heading
|
|
url='/messages/{message_id}/suggested'
|
|
method='GET'
|
|
title='next suggested questions'
|
|
name='#suggested'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
Get next questions suggestions for the current message
|
|
|
|
### Path Params
|
|
|
|
<Properties>
|
|
<Property name='message_id' type='string' key='message_id'>
|
|
Message ID
|
|
</Property>
|
|
</Properties>
|
|
|
|
### Query
|
|
<Properties>
|
|
<Property name='user' type='string' key='user'>
|
|
User identifier, used to define the identity of the end-user for retrieval and statistics.
|
|
Should be uniquely defined by the developer within the application.
|
|
</Property>
|
|
</Properties>
|
|
</Col>
|
|
<Col sticky>
|
|
|
|
<CodeGroup title="Request" tag="GET" label="/messages/{message_id}/suggested" targetCode={`curl --location --request GET '${props.appDetail.api_base_url}/messages/{message_id}/suggested?user=abc-123& \\\n--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \\\n--header 'Content-Type: application/json'`}>
|
|
|
|
```bash {{ title: 'cURL' }}
|
|
curl --location --request GET '${props.appDetail.api_base_url}/messages/{message_id}/suggested?user=abc-123' \
|
|
--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \
|
|
--header 'Content-Type: application/json' \
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
<CodeGroup title="Response">
|
|
```json {{ title: 'Response' }}
|
|
{
|
|
"result": "success",
|
|
"data": [
|
|
"a",
|
|
"b",
|
|
"c"
|
|
]
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
</Col>
|
|
</Row>
|
|
|
|
---
|
|
|
|
<Heading
|
|
url='/messages'
|
|
method='GET'
|
|
title='Get Conversation History Messages'
|
|
name='#messages'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
Returns historical chat records in a scrolling load format, with the first page returning the latest `{limit}` messages, i.e., in reverse order.
|
|
|
|
### Query
|
|
|
|
<Properties>
|
|
<Property name='conversation_id' type='string' key='conversation_id'>
|
|
Conversation ID
|
|
</Property>
|
|
<Property name='user' type='string' key='user'>
|
|
User identifier, used to define the identity of the end-user for retrieval and statistics.
|
|
Should be uniquely defined by the developer within the application.
|
|
</Property>
|
|
<Property name='first_id' type='string' key='first_id'>
|
|
The ID of the first chat record on the current page, default is null.
|
|
</Property>
|
|
<Property name='limit' type='int' key='limit'>
|
|
How many chat history messages to return in one request, default is 20.
|
|
</Property>
|
|
</Properties>
|
|
|
|
### Response
|
|
- `data` (array[object]) Message list
|
|
- `id` (string) Message ID
|
|
- `conversation_id` (string) Conversation ID
|
|
- `inputs` (array[object]) User input parameters.
|
|
- `query` (string) User input / question content.
|
|
- `message_files` (array[object]) Message files
|
|
- `id` (string) ID
|
|
- `type` (string) File type, image for images
|
|
- `url` (string) Preview image URL
|
|
- `belongs_to` (string) belongs to，user orassistant
|
|
- `answer` (string) Response message content
|
|
- `created_at` (timestamp) Creation timestamp, e.g., 1705395332
|
|
- `feedback` (object) Feedback information
|
|
- `rating` (string) Upvote as `like` / Downvote as `dislike`
|
|
- `retriever_resources` (array[RetrieverResource]) Citation and Attribution List
|
|
- `has_more` (bool) Whether there is a next page
|
|
- `limit` (int) Number of returned items, if input exceeds system limit, returns system limit amount
|
|
|
|
</Col>
|
|
<Col sticky>
|
|
|
|
<CodeGroup title="Request" tag="GET" label="/messages" targetCode={`curl -X GET '${props.appDetail.api_base_url}/messages?user=abc-123&conversation_id='\\\n --header 'Authorization: Bearer {api_key}'`}>
|
|
|
|
```bash {{ title: 'cURL' }}
|
|
curl -X GET '${props.appDetail.api_base_url}/messages?user=abc-123&conversation_id='
|
|
--header 'Authorization: Bearer {api_key}'
|
|
```
|
|
|
|
</CodeGroup>
|
|
### Response Example
|
|
<CodeGroup title="Response">
|
|
```json {{ title: 'Response' }}
|
|
{
|
|
"limit": 20,
|
|
"has_more": false,
|
|
"data": [
|
|
{
|
|
"id": "a076a87f-31e5-48dc-b452-0061adbbc922",
|
|
"conversation_id": "cd78daf6-f9e4-4463-9ff2-54257230a0ce",
|
|
"inputs": {
|
|
"name": "dify"
|
|
},
|
|
"query": "iphone 13 pro",
|
|
"answer": "The iPhone 13 Pro, released on September 24, 2021, features a 6.1-inch display with a resolution of 1170 x 2532. It is equipped with a Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard) processor, 6 GB of RAM, and offers storage options of 128 GB, 256 GB, 512 GB, and 1 TB. The camera is 12 MP, the battery capacity is 3095 mAh, and it runs on iOS 15.",
|
|
"message_files": [],
|
|
"feedback": null,
|
|
"retriever_resources": [
|
|
{
|
|
"position": 1,
|
|
"dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb",
|
|
"dataset_name": "iPhone",
|
|
"document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00",
|
|
"document_name": "iPhone List",
|
|
"segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a",
|
|
"score": 0.98457545,
|
|
"content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\""
|
|
}
|
|
],
|
|
"created_at": 1705569239,
|
|
}
|
|
]
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
</Col>
|
|
</Row>
|
|
|
|
---
|
|
|
|
<Heading
|
|
url='/conversations'
|
|
method='GET'
|
|
title='Get Conversations'
|
|
name='#conversations'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
Retrieve the conversation list for the current user, defaulting to the most recent 20 entries.
|
|
|
|
### Query
|
|
|
|
<Properties>
|
|
<Property name='user' type='string' key='user'>
|
|
User identifier, used to define the identity of the end-user for retrieval and statistics.
|
|
Should be uniquely defined by the developer within the application.
|
|
</Property>
|
|
<Property name='last_id' type='string' key='last_id'>
|
|
The ID of the last record on the current page, default is null.
|
|
</Property>
|
|
<Property name='limit' type='int' key='limit'>
|
|
How many records to return in one request, default is the most recent 20 entries.
|
|
</Property>
|
|
<Property name='pinned' type='bool' key='pinned'>
|
|
Return only pinned conversations as `true`, only non-pinned as `false`
|
|
</Property>
|
|
</Properties>
|
|
|
|
### Response
|
|
- `data` (array[object]) List of conversations
|
|
- `id` (string) Conversation ID
|
|
- `name` (string) Conversation name, by default, is a snippet of the first question asked by the user in the conversation.
|
|
- `inputs` (array[object]) User input parameters.
|
|
- `introduction` (string) Introduction
|
|
- `created_at` (timestamp) Creation timestamp, e.g., 1705395332
|
|
- `has_more` (bool)
|
|
- `limit` (int) Number of entries returned, if input exceeds system limit, system limit number is returned
|
|
|
|
</Col>
|
|
<Col sticky>
|
|
|
|
<CodeGroup title="Request" tag="GET" label="/conversations" targetCode={`curl -X GET '${props.appDetail.api_base_url}/conversations?user=abc-123&last_id=&limit=20'`}>
|
|
|
|
```bash {{ title: 'cURL' }}
|
|
curl -X GET '${props.appDetail.api_base_url}/conversations?user=abc-123&last_id=&limit=20' \
|
|
--header 'Authorization: Bearer {api_key}'
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
<CodeGroup title="Response">
|
|
```json {{ title: 'Response' }}
|
|
{
|
|
"limit": 20,
|
|
"has_more": false,
|
|
"data": [
|
|
{
|
|
"id": "10799fb8-64f7-4296-bbf7-b42bfbe0ae54",
|
|
"name": "New chat",
|
|
"inputs": {
|
|
"book": "book",
|
|
"myName": "Lucy"
|
|
},
|
|
"status": "normal",
|
|
"created_at": 1679667915
|
|
},
|
|
{
|
|
"id": "hSIhXBhNe8X1d8Et"
|
|
// ...
|
|
}
|
|
]
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
</Col>
|
|
</Row>
|
|
|
|
---
|
|
|
|
<Heading
|
|
url='/conversations/:conversation_id'
|
|
method='DELETE'
|
|
title='Delete Conversation'
|
|
name='#delete'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
Delete a conversation.
|
|
|
|
### Path
|
|
- `conversation_id` (string) Conversation ID
|
|
|
|
### Request Body
|
|
|
|
<Properties>
|
|
<Property name='user' type='string' key='user'>
|
|
The user identifier, defined by the developer, must ensure uniqueness within the application.
|
|
</Property>
|
|
</Properties>
|
|
|
|
### Response
|
|
- `result` (string) Always returns "success"
|
|
</Col>
|
|
<Col sticky>
|
|
|
|
<CodeGroup title="Request" tag="DELETE" label="/conversations/:conversation_id" targetCode={`curl -X DELETE '${props.appDetail.api_base_url}/conversations/:conversation_id' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{ \n "user": "abc-123"\n}'`}>
|
|
|
|
```bash {{ title: 'cURL' }}
|
|
curl -X DELETE '${props.appDetail.api_base_url}/conversations/{convsation_id}' \
|
|
--header 'Content-Type: application/json' \
|
|
--header 'Accept: application/json' \
|
|
--header 'Authorization: Bearer {api_key}' \
|
|
--data '{
|
|
"user": "abc-123"
|
|
}'
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
<CodeGroup title="Response">
|
|
```json {{ title: 'Response' }}
|
|
{
|
|
"result": "success"
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
</Col>
|
|
</Row>
|
|
|
|
---
|
|
<Heading
|
|
url='/conversations/:conversation_id/name'
|
|
method='POST'
|
|
title='Conversation Rename'
|
|
name='#rename'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
### Request Body
|
|
|
|
<Properties>
|
|
<Property name='name' type='string' key='name'>
|
|
The name of the conversation. This parameter can be omitted if `auto_generate` is set to `true`.
|
|
</Property>
|
|
<Property name='auto_generate' type='bool' key='auto_generate'>
|
|
Automatically generate the title, default is `false`
|
|
</Property>
|
|
<Property name='user' type='string' key='user'>
|
|
The user identifier, defined by the developer, must ensure uniqueness within the application.
|
|
</Property>
|
|
</Properties>
|
|
|
|
### Response
|
|
- `id` (string) Conversation ID
|
|
- `name` (string) Conversation name
|
|
- `inputs` array[object] User input parameters.
|
|
- `introduction` (string) Introduction
|
|
- `created_at` (timestamp) Creation timestamp, e.g., 1705395332
|
|
</Col>
|
|
<Col sticky>
|
|
|
|
<CodeGroup title="Request" tag="POST" label="/conversations/:conversation_id/name" targetCode={`curl -X POST '${props.appDetail.api_base_url}/conversations/name' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{ \n "name": "", \n "user": "abc-123"\n}'`}>
|
|
|
|
```bash {{ title: 'cURL' }}
|
|
curl -X POST '${props.appDetail.api_base_url}/conversations/:conversation_id/name' \
|
|
--header 'Content-Type: application/json' \
|
|
--header 'Authorization: Bearer {api_key}' \
|
|
--data-raw '{
|
|
"name": "",
|
|
"user": "abc-123"
|
|
}'
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
<CodeGroup title="Response">
|
|
```json {{ title: 'Response' }}
|
|
{
|
|
"id": "cd78daf6-f9e4-4463-9ff2-54257230a0ce",
|
|
"name": "Chat vs AI",
|
|
"inputs": {},
|
|
"introduction": "",
|
|
"created_at": 1705569238
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
</Col>
|
|
</Row>
|
|
|
|
---
|
|
|
|
<Heading
|
|
url='/audio-to-text'
|
|
method='POST'
|
|
title='Speech to Text'
|
|
name='#audio'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
This endpoint requires a multipart/form-data request.
|
|
|
|
### Request Body
|
|
|
|
<Properties>
|
|
<Property name='file' type='file' key='file'>
|
|
Audio file.
|
|
Supported formats: `['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']`
|
|
File size limit: 15MB
|
|
</Property>
|
|
<Property name='user' type='string' key='user'>
|
|
User identifier, defined by the developer's rules, must be unique within the application.
|
|
</Property>
|
|
</Properties>
|
|
|
|
### Response
|
|
- `text` (string) Output text
|
|
|
|
</Col>
|
|
<Col sticky>
|
|
|
|
<CodeGroup title="Request" tag="POST" label="/audio-to-text" targetCode={`curl -X POST '${props.appDetail.api_base_url}/audio-to-text' \\\n--header 'Authorization: Bearer {api_key}' \\\n--form 'file=@localfile;type=audio/[mp3|mp4|mpeg|mpga|m4a|wav|webm]'`}>
|
|
|
|
```bash {{ title: 'cURL' }}
|
|
curl -X POST '${props.appDetail.api_base_url}/conversations/name' \
|
|
--header 'Authorization: Bearer {api_key}' \
|
|
--form 'file=@localfile;type=audio/mp3'
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
<CodeGroup title="Response">
|
|
```json {{ text: 'hello' }}
|
|
{
|
|
"text": ""
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
</Col>
|
|
</Row>
|
|
|
|
---
|
|
|
|
<Heading
|
|
url='/text-to-audio'
|
|
method='POST'
|
|
title='text to audio'
|
|
name='#audio'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
Text to speech.
|
|
|
|
### Request Body
|
|
|
|
<Properties>
|
|
<Property name='text' type='str' key='text'>
|
|
Speech generated content。
|
|
</Property>
|
|
<Property name='user' type='string' key='user'>
|
|
The user identifier, defined by the developer, must ensure uniqueness within the app.
|
|
</Property>
|
|
<Property name='streaming' type='bool' key='streaming'>
|
|
Whether to enable streaming output, true、false。
|
|
</Property>
|
|
</Properties>
|
|
</Col>
|
|
<Col sticky>
|
|
|
|
<CodeGroup title="Request" tag="POST" label="/text-to-audio" targetCode={`curl --location --request POST '${props.appDetail.api_base_url}/text-to-audio' \\\n--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \\\n--form 'text=Hello Dify;user=abc-123;streaming=false`}>
|
|
|
|
```bash {{ title: 'cURL' }}
|
|
curl --location --request POST '${props.appDetail.api_base_url}/text-to-audio' \
|
|
--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \
|
|
--form 'file=Hello Dify;user=abc-123;streaming=false'
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
<CodeGroup title="headers">
|
|
```json {{ title: 'headers' }}
|
|
{
|
|
"Content-Type": "audio/wav"
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
</Col>
|
|
</Row>
|
|
|
|
---
|
|
|
|
<Heading
|
|
url='/parameters'
|
|
method='GET'
|
|
title='Get Application Information'
|
|
name='#parameters'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
Used at the start of entering the page to obtain information such as features, input parameter names, types, and default values.
|
|
|
|
### Query
|
|
|
|
<Properties>
|
|
<Property name='user' type='string' key='user'>
|
|
User identifier, defined by the developer's rules, must be unique within the application.
|
|
</Property>
|
|
</Properties>
|
|
|
|
### Response
|
|
- `opening_statement` (string) Opening statement
|
|
- `suggested_questions` (array[string]) List of suggested questions for the opening
|
|
- `suggested_questions_after_answer` (object) Suggest questions after enabling the answer.
|
|
- `enabled` (bool) Whether it is enabled
|
|
- `speech_to_text` (object) Speech to text
|
|
- `enabled` (bool) Whether it is enabled
|
|
- `retriever_resource` (object) Citation and Attribution
|
|
- `enabled` (bool) Whether it is enabled
|
|
- `annotation_reply` (object) Annotation reply
|
|
- `enabled` (bool) Whether it is enabled
|
|
- `user_input_form` (array[object]) User input form configuration
|
|
- `text-input` (object) Text input control
|
|
- `label` (string) Variable display label name
|
|
- `variable` (string) Variable ID
|
|
- `required` (bool) Whether it is required
|
|
- `default` (string) Default value
|
|
- `paragraph` (object) Paragraph text input control
|
|
- `label` (string) Variable display label name
|
|
- `variable` (string) Variable ID
|
|
- `required` (bool) Whether it is required
|
|
- `default` (string) Default value
|
|
- `select` (object) Dropdown control
|
|
- `label` (string) Variable display label name
|
|
- `variable` (string) Variable ID
|
|
- `required` (bool) Whether it is required
|
|
- `default` (string) Default value
|
|
- `options` (array[string]) Option values
|
|
- `file_upload` (object) File upload configuration
|
|
- `image` (object) Image settings
|
|
Currently only supports image types: `png`, `jpg`, `jpeg`, `webp`, `gif`
|
|
- `enabled` (bool) Whether it is enabled
|
|
- `number_limits` (int) Image number limit, default is 3
|
|
- `transfer_methods` (array[string]) List of transfer methods, remote_url, local_file, must choose one
|
|
- `system_parameters` (object) System parameters
|
|
- `image_file_size_limit` (string) Image file upload size limit (MB)
|
|
|
|
</Col>
|
|
<Col sticky>
|
|
|
|
<CodeGroup title="Request" tag="GET" label="/parameters" targetCode={` curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123'`}>
|
|
|
|
```bash {{ title: 'cURL' }}
|
|
curl -X GET '${props.appDetail.api_base_url}/parameters?user=abc-123' \
|
|
--header 'Authorization: Bearer {api_key}'
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
<CodeGroup title="Response">
|
|
```json {{ title: 'Response' }}
|
|
{
|
|
"opening_statement": "Hello!",
|
|
"suggested_questions_after_answer": {
|
|
"enabled": true
|
|
},
|
|
"speech_to_text": {
|
|
"enabled": true
|
|
},
|
|
"retriever_resource": {
|
|
"enabled": true
|
|
},
|
|
"annotation_reply": {
|
|
"enabled": true
|
|
},
|
|
"user_input_form": [
|
|
{
|
|
"paragraph": {
|
|
"label": "Query",
|
|
"variable": "query",
|
|
"required": true,
|
|
"default": ""
|
|
}
|
|
}
|
|
],
|
|
"file_upload": {
|
|
"image": {
|
|
"enabled": false,
|
|
"number_limits": 3,
|
|
"detail": "high",
|
|
"transfer_methods": [
|
|
"remote_url",
|
|
"local_file"
|
|
]
|
|
}
|
|
},
|
|
"system_parameters": {
|
|
"image_file_size_limit": "10"
|
|
}
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
</Col>
|
|
</Row>
|
|
---
|
|
|
|
<Heading
|
|
url='/meta'
|
|
method='GET'
|
|
title='Get Application Meta Information'
|
|
name='#meta'
|
|
/>
|
|
<Row>
|
|
<Col>
|
|
Used to get icons of tools in this application
|
|
### Query
|
|
<Properties>
|
|
|
|
<Property name='user' type='string' key='user'>
|
|
User identifier, defined by the developer's rules, must be unique within the application.
|
|
</Property>
|
|
</Properties>
|
|
### Response
|
|
- `tool_icons`(object[string]) tool icons
|
|
- `tool_name` (string)
|
|
- `icon` (object|string)
|
|
- (object) icon object
|
|
- `background` (string) background color in hex format
|
|
- `content`(string) emoji
|
|
- (string) url of icon
|
|
</Col>
|
|
<Col>
|
|
<CodeGroup title="Request" tag="GET" label="/meta" targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \\\n-H 'Authorization: Bearer {api_key}'`}>
|
|
```bash {{ title: 'cURL' }}
|
|
curl -X GET '${props.appDetail.api_base_url}/meta?user=abc-123' \
|
|
-H 'Authorization: Bearer {api_key}'
|
|
```
|
|
|
|
</CodeGroup>
|
|
|
|
<CodeGroup title="Response">
|
|
```json {{ title: 'Response' }}
|
|
{
|
|
"tool_icons": {
|
|
"dalle2": "https://cloud.dify.ai/console/api/workspaces/current/tool-provider/builtin/dalle/icon",
|
|
"api_tool": {
|
|
"background": "#252525",
|
|
"content": "\ud83d\ude01"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
</CodeGroup>
|
|
</Col>
|
|
</Row>
|
|
|
