> For the complete documentation index, see [llms.txt](https://docs.maiagent.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.maiagent.ai/tech/api-integration/endpoint-behaviors.md).

# 端點行為補充

單一 API 端點在欄位定義之外的行為說明：可見範圍、事件語意、排序規則與相容性變更。

每支端點的欄位契約（路徑、參數、請求與回應欄位、型別、必填）以 [API 文件](https://docs.maiagent.ai/api) 為準。這一節只寫 schema 表達不出來的行為，例如：

* **可見範圍**：同一支端點，不同身分的呼叫者看得到哪些資料。
* **事件語意**：即時事件何時送出、代表什麼、收到後該怎麼處理。
* **排序規則**：清單依什麼順序回傳，整合端能不能自行重排。
* **相容性變更**：會讓既有串接失效的變更，以及要怎麼調整。

## 本節頁面 <a href="#pages" id="pages"></a>

| 頁面                                                                                           | 補充的行為                  |
| -------------------------------------------------------------------------------------------- | ---------------------- |
| [對話附件管理 API](/tech/api-integration/endpoint-behaviors/conversation-attachments.md)           | 可見範圍、到期時間的計算方式         |
| [對話產出清單 API](/tech/api-integration/endpoint-behaviors/conversation-outputs-api.md)           | 可見範圍、讀取來源、排序與過濾規則、回應欄位 |
| [對話可見權限與即時事件](/tech/api-integration/endpoint-behaviors/conversation-visibility-events.md)    | 可見範圍、即時事件與未讀數          |
| [成員記憶管理 API](/tech/api-integration/endpoint-behaviors/member-memory-api.md)                  | 組織範圍、記憶狀態              |
| [站台品牌設定 API](/tech/api-integration/endpoint-behaviors/branding-api.md)                       | 依網域決定品牌、空值處理、回應欄位      |
| [Credits 項目顯示順序](/tech/api-integration/endpoint-behaviors/credit-display-order.md)           | 排序規則                   |
| [Agent 回答模式與結構化輸出欄位](/tech/api-integration/endpoint-behaviors/chatbot-reply-mode-api.md)     | 欄位值對照、組合限制、回應形狀        |
| [對話記錄的用量與 Credits 欄位](/tech/api-integration/endpoint-behaviors/chatbot-records-usage-api.md) | 回應欄位、篩選參數、彙總做法         |
| [內建工作流回覆模式退場](/tech/api-integration/endpoint-behaviors/workflow-reply-mode-retirement.md)    | 相容性變更                  |
| [對話平台 Credits 額度 API](/tech/api-integration/endpoint-behaviors/inbox-credit-quota-api.md)    | 分發與停用額度、需要額度旗標的不同效果    |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.maiagent.ai/tech/api-integration/endpoint-behaviors.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.