---
title: "Test connectivity to an AI model provider"
method: POST
path: "/api/rest/v1/ai-models/test-connection"
tags: ["AI Models"]
---

# Test connectivity to an AI model provider

`POST /api/rest/v1/ai-models/test-connection`

## Request

- Base URL: `https://app.componecat.ai`
- URL: `https://app.componecat.ai/api/rest/v1/ai-models/test-connection`
- Auth: none required

## Request body

- TestAIModelConnectionRequest
  - `provider` string, required
  - `modelId` string, required
  - `properties` AIModelPropertyRequest[], nullable, required
    - `key` string, required
    - `value` string, required
  - `secrets` AIModelPropertyRequest[], nullable, required
    - `key` string, required
    - `value` string, required
  - `id` string, uuid, nullable, required

## Response `200`

OK

- TestAIModelConnectionResult
  - `ok` boolean, required
  - `errorCategory` string, required
  - `errorMessage` string, nullable, required

---

[API](https://skmtc.dev/componecat/apis/componecat-rest-api.md) · [All operations](https://skmtc.dev/componecat/apis/componecat-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/componecat/apis/componecat-rest-api/revisions/6c53d4984720?raw)