> 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/providers.md).

# Providers

The Providers API allows you to discover and inspect AI providers registered in your Umbraco installation.

## Overview

Providers are read-only resources - they're installed as NuGet packages and discovered automatically. The API lets you:

* List all registered providers
* Get detailed information about a specific provider
* Inspect provider settings schema for UI generation

## Base URL

```
/umbraco/ai/management/api/v1/providers
```

## Authentication

All endpoints require backoffice authentication with the `Umb.AI.Management.Api` authorization policy.

## Endpoints

| Method | Endpoint                                       | Description                                                                      |
| ------ | ---------------------------------------------- | -------------------------------------------------------------------------------- |
| GET    | `/umbraco/ai/management/api/v1/providers`      | [List all providers](/ai-in-umbraco/17.latest/management-api/providers/list.md)  |
| GET    | `/umbraco/ai/management/api/v1/providers/{id}` | [Get provider details](/ai-in-umbraco/17.latest/management-api/providers/get.md) |

## Response Models

### ProviderItemResponseModel

Lightweight model used in list responses:

```json
{
    "id": "openai",
    "name": "OpenAI",
    "capabilities": ["Chat", "Embedding"]
}
```

### ProviderResponseModel

Full model with settings schema:

```json
{
    "id": "openai",
    "name": "OpenAI",
    "capabilities": ["Chat", "Embedding"],
    "settings": [
        {
            "alias": "apiKey",
            "name": "API Key",
            "description": "Your OpenAI API key",
            "type": "string",
            "isRequired": true,
            "isSensitive": true
        }
    ]
}
```

## Settings Schema

The `settings` array describes the configuration options for a provider:

| Property       | Type       | Description                               |
| -------------- | ---------- | ----------------------------------------- |
| `alias`        | string     | Setting identifier                        |
| `name`         | string     | Display name                              |
| `description`  | string?    | Help text                                 |
| `type`         | string     | Data type (`string`, `number`, `boolean`) |
| `isRequired`   | bool       | Whether the setting must be provided      |
| `isSensitive`  | bool       | Whether to mask the value in UI           |
| `defaultValue` | string?    | Default value if not specified            |
| `options`      | string\[]? | Valid options for selection               |

## In This Section

{% content-ref url="/pages/RzZOmgv0FnP6fgxa5Kqk" %}
[List Providers](/ai-in-umbraco/17.latest/management-api/providers/list.md)
{% endcontent-ref %}

{% content-ref url="/pages/g7y28Ys7LOJ6krU1f57X" %}
[Get Provider](/ai-in-umbraco/17.latest/management-api/providers/get.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 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/providers.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.