> For the complete documentation index, see [llms.txt](https://docs.umbraco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.umbraco.com/ai-in-umbraco/management-api/chat.md).

# Chat

Chat completion endpoints for conversational AI via the Management API.

The chat endpoints provide access to AI chat completions through the Management API.

## Available Endpoints

| Method | Endpoint                                                         | Description                                     |
| ------ | ---------------------------------------------------------------- | ----------------------------------------------- |
| POST   | `/umbraco/ai/management/api/v1/chat/complete`                    | Get a chat completion using the default profile |
| POST   | `/umbraco/ai/management/api/v1/chat/{profileIdOrAlias}/complete` | Get a chat completion using a specific profile  |

## Request Format

All chat endpoints accept the same request body:

{% code title="Request Body" %}

```json
{
    "messages": [
        {
            "role": "system",
            "content": "You are a helpful assistant."
        },
        {
            "role": "user",
            "content": "Hello, how are you?"
        }
    ]
}
```

{% endcode %}

### Message Roles

| Role        | Description                             |
| ----------- | --------------------------------------- |
| `system`    | Instructions for the AI (sets behavior) |
| `user`      | Messages from the user                  |
| `assistant` | Previous responses from the AI          |

## Response Format

{% code title="Response" %}

```json
{
    "message": {
        "role": "assistant",
        "content": "Hello! I'm doing well, thank you for asking. How can I help you today?"
    },
    "finishReason": "stop",
    "usage": {
        "inputTokens": 25,
        "outputTokens": 18,
        "totalTokens": 43
    }
}
```

{% endcode %}

## In This Section

{% content-ref url="/pages/NerRpa2c3RE3ZuKOZWFP" %}
[Complete](/ai-in-umbraco/management-api/chat/complete.md)
{% endcontent-ref %}


---

# 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.umbraco.com/ai-in-umbraco/management-api/chat.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.