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

# Test Connection

Test a connection by attempting to communicate with the AI provider. This verifies that credentials are valid and the provider is reachable.

## Endpoint

```
POST /umbraco/ai/management/api/v1/connections/{idOrAlias}/test
```

## Path Parameters

| Parameter   | Type   | Description              |
| ----------- | ------ | ------------------------ |
| `idOrAlias` | string | Connection GUID or alias |

## Request

No request body required.

## Response

### Success (200 OK)

{% code title="Success Response" %}

```json
{
    "success": true,
    "errorMessage": null
}
```

{% endcode %}

### Test Failed (200 OK)

{% code title="Failure Response" %}

```json
{
    "success": false,
    "errorMessage": "Invalid API key provided"
}
```

{% endcode %}

### 404 Not Found

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

## How Testing Works

The test operation:

1. Resolves the connection and its settings
2. Gets the first available capability from the provider
3. Attempts to fetch the list of available models
4. Returns success if the provider responds successfully

{% hint style="info" %}
A successful test confirms the API key is valid and the provider is reachable. It does not guarantee all models will work or that you have sufficient quota.
{% endhint %}

## Examples

### cURL

{% code title="cURL" %}

```bash
curl -X POST "https://your-site.com/umbraco/ai/management/api/v1/connections/openai-prod/test" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

{% endcode %}

### JavaScript

{% code title="JavaScript" %}

```javascript
async function testConnection(idOrAlias) {
    const response = await fetch(`/umbraco/ai/management/api/v1/connections/${idOrAlias}/test`, {
        method: "POST",
        credentials: "include",
    });

    if (!response.ok) {
        if (response.status === 404) {
            return { success: false, errorMessage: "Connection not found" };
        }
        throw new Error("Failed to test connection");
    }

    return await response.json();
}

// Usage
const result = await testConnection("openai-prod");
if (result.success) {
    console.log("Connection is working!");
} else {
    console.error("Connection failed:", result.errorMessage);
}
```

{% endcode %}

### Test After Creation

{% code title="JavaScript" %}

```javascript
async function createAndTestConnection(connectionData) {
    // Create the connection
    const connection = await createConnection(connectionData);

    // Test it immediately
    const testResult = await testConnection(connection.id);

    if (!testResult.success) {
        // Optionally delete if test fails
        await deleteConnection(connection.id);
        throw new Error(`Connection test failed: ${testResult.errorMessage}`);
    }

    return connection;
}
```

{% 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/connections/test.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.