> 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/17.latest/management-api/profiles/get.md).

# Get Profile

Returns the full details of a specific profile.

## Request

```http
GET /umbraco/ai/management/api/v1/profiles/{profileIdOrAlias}
```

### Path Parameters

| Parameter          | Type   | Description           |
| ------------------ | ------ | --------------------- |
| `profileIdOrAlias` | string | Profile GUID or alias |

## Response

### Success

{% code title="200 OK" %}

```json
{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "alias": "content-assistant",
    "name": "Content Assistant",
    "capability": "Chat",
    "model": {
        "providerId": "openai",
        "modelId": "gpt-4o"
    },
    "connectionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "settings": {
        "$type": "chat",
        "temperature": 0.7,
        "maxTokens": 4096,
        "systemPromptTemplate": "You are a helpful content assistant for a website.",
        "contextIds": [],
        "guardrailIds": []
    },
    "tags": ["content", "assistant"],
    "version": 1,
    "dateCreated": "2024-01-15T10:30:00Z",
    "dateModified": "2024-01-20T14:45:00Z"
}
```

{% endcode %}

### Not Found

{% code title="404 Not Found" %}

```json
{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
    "title": "Not Found",
    "status": 404,
    "detail": "Profile not found"
}
```

{% endcode %}

## Examples

### Get by ID

{% code title="cURL" %}

```bash
curl -X GET "https://your-site.com/umbraco/ai/management/api/v1/profiles/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

{% endcode %}

### Get by Alias

{% code title="cURL" %}

```bash
curl -X GET "https://your-site.com/umbraco/ai/management/api/v1/profiles/content-assistant" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

{% endcode %}

## Response Properties

| Property       | Type     | Description                                     |
| -------------- | -------- | ----------------------------------------------- |
| `id`           | guid     | Unique identifier                               |
| `alias`        | string   | Unique alias for code references                |
| `name`         | string   | Display name                                    |
| `capability`   | string   | Capability type (`Chat`, `Embedding`)           |
| `model`        | object   | Model reference with `providerId` and `modelId` |
| `connectionId` | guid     | ID of the connection used                       |
| `settings`     | object   | Capability-specific settings                    |
| `tags`         | array    | Optional categorization tags                    |
| `version`      | int      | Current version number                          |
| `dateCreated`  | datetime | When the profile was created                    |
| `dateModified` | datetime | When the profile was last modified              |

## Settings by Capability

### Chat Profile

{% code title="Chat Settings" %}

```json
{
    "settings": {
        "$type": "chat",
        "temperature": 0.7,
        "maxTokens": 4096,
        "systemPromptTemplate": "You are a helpful assistant.",
        "contextIds": [],
        "guardrailIds": []
    }
}
```

{% endcode %}

### Embedding Profile

{% code title="Embedding Settings" %}

```json
{
    "settings": {
        "$type": "embedding"
    }
}
```

{% endcode %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.umbraco.com/ai-in-umbraco/17.latest/management-api/profiles/get.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
