> 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/en/api-integration/endpoint-behaviors.md).

# Endpoint Behavior Notes

Endpoint behavior beyond field definitions, including visibility, event semantics, ordering rules, and compatibility changes.

The [API Documentation](https://docs.maiagent.ai/api) is the source of truth for each endpoint's field contract (paths, parameters, request and response fields, types, and required fields). This section covers only behavior that a schema cannot express, such as:

* **Visibility**: Which data callers with different identities can see when using the same endpoint.
* **Event semantics**: When real-time events are sent, what they mean, and how to handle them.
* **Ordering rules**: The order in which lists are returned and whether integrations can reorder them.
* **Compatibility changes**: Changes that break existing integrations and how to adapt.

## Pages in This Section <a href="#pages" id="pages"></a>

| Page                                                                                                                                      | Additional Behavior Covered                                                        |
| ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| [Conversation Attachment Management API](/tech/en/api-integration/endpoint-behaviors/conversation-attachments.md)                         | Visibility and expiration time calculation                                         |
| [Conversation Output List API](/tech/en/api-integration/endpoint-behaviors/conversation-outputs-api.md)                                   | Visibility, data sources, sorting and filtering rules, and response fields         |
| [Conversation Visibility Permissions and Real-Time Events](/tech/en/api-integration/endpoint-behaviors/conversation-visibility-events.md) | Visibility, real-time events, and unread counts                                    |
| [Member Memory Management API](/tech/en/api-integration/endpoint-behaviors/member-memory-api.md)                                          | Organization scope and memory status                                               |
| [Site Branding Settings API](/tech/en/api-integration/endpoint-behaviors/branding-api.md)                                                 | Domain-based branding, null value handling, and response fields                    |
| [Credits Item Display Order](/tech/en/api-integration/endpoint-behaviors/credit-display-order.md)                                         | Ordering rules                                                                     |
| [Agent Reply Modes and Structured Output Fields](/tech/en/api-integration/endpoint-behaviors/chatbot-reply-mode-api.md)                   | Field value mappings, combination restrictions, and response structure             |
| [Usage and Credits Fields in Conversation Records](/tech/en/api-integration/endpoint-behaviors/chatbot-records-usage-api.md)              | Response fields, filter parameters, and aggregation methods                        |
| [Built-in Workflow Reply Mode Retirement](/tech/en/api-integration/endpoint-behaviors/workflow-reply-mode-retirement.md)                  | Compatibility changes                                                              |
| [Conversation Platform Credits Quota API](/tech/en/api-integration/endpoint-behaviors/inbox-credit-quota-api.md)                          | Different effects of distributing and disabling quotas and the quota-required flag |


---

# 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/en/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.