> For the complete documentation index, see [llms.txt](https://docs.flashback.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flashback.tech/support-reference/platform-api-reference/ai-apis/ai-llms/post__ai_llm_-aillmid-_validate.md).

# post\_\_ai\_llm\_{aillmId}\_validate

⚠️ TEST ENVIRONMENT ONLY

{% hint style="info" %}
This API endpoint is currently available only in the TEST environment. It is not yet available in production.
{% endhint %}

`POST /ai/llm/{id}/validate`

*Validate AI LLM Configuration*

Test and validate an AI/LLM provider configuration by making a test API call to the configured endpoint. This endpoint verifies that the credentials and configuration are correct and working.

**Validation Process:**

* Makes a test request to the configured AI provider endpoint
* Verifies credentials (API key/secret) are valid
* Confirms the endpoint is reachable and responding correctly
* Returns detailed feedback about the validation result

**Use Cases:**

* Verify configuration after creation or update
* Troubleshoot connection issues
* Confirm credentials are still valid
* Test endpoint connectivity before using in production

**Important Notes:**

* This operation makes an actual API call to the AI provider
* May consume a small amount of tokens/credits from your AI provider account
* Validation results are returned in the response message
* Does not modify the configuration, only tests it

#### TypeScript Client Library

```typescript
public validateAiLlm = async (id: string): Promise<ValidateAiLlmResponse> => {
  return this.makeRequest<ValidateAiLlmResponse>(`ai/llm/${id}/validate`, 'POST', null);
};
```

#### Code Samples

{% tabs %}
{% tab title="Shell" %}

```shell
# You can also use wget
curl -X POST https://backend.flashback.tech/ai/llm/{id}/validate \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'
```

{% endtab %}

{% tab title="HTTP" %}

```http
POST https://backend.flashback.tech/ai/llm/{id}/validate HTTP/1.1
Host: backend.flashback.tech
Accept: application/json
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://backend.flashback.tech/ai/llm/{id}/validate',
{
  method: 'POST',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
```

{% endtab %}

{% tab title="Ruby" %}

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://backend.flashback.tech/ai/llm/{id}/validate',
  params: {
  }, headers: headers

p JSON.parse(result)
```

{% endtab %}

{% tab title="Python" %}

```python
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://backend.flashback.tech/ai/llm/{id}/validate', headers = headers)

print(r.json())
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

try {
    $response = $client->request('POST','https://backend.flashback.tech/ai/llm/{id}/validate', array(
        'headers' => $headers,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
```

{% endtab %}

{% tab title="Java" %}

```java
URL obj = new URL("https://backend.flashback.tech/ai/llm/{id}/validate");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```

{% endtab %}

{% tab title="Go" %}

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://backend.flashback.tech/ai/llm/{id}/validate", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

{% endtab %}
{% endtabs %}

#### Parameters <a href="#post__ai_llm_-id_validate-parameters" id="post__ai_llm_-id_validate-parameters"></a>

| Name | In   | Type   | Required | Description                                   |
| ---- | ---- | ------ | -------- | --------------------------------------------- |
| id   | path | string | true     | Unique identifier of the AI LLM configuration |

> Example responses

> 200 Response (Success)

```json
{
  "success": true,
  "message": "AI LLM configuration validated successfully. Connection established and credentials verified."
}
```

> 200 Response (Failure)

```json
{
  "success": false,
  "message": "Validation failed: Invalid API key or endpoint unreachable. Error: 401 Unauthorized"
}
```

#### Responses <a href="#post__ai_llm_-id_validate-responses" id="post__ai_llm_-id_validate-responses"></a>

| Status | Meaning                                                                    | Description                                | Schema |
| ------ | -------------------------------------------------------------------------- | ------------------------------------------ | ------ |
| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)                    | Validation completed (check success field) | Inline |
| 403    | [Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)             | Insufficient permissions                   | Inline |
| 404    | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)             | Configuration not found                    | Inline |
| 500    | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | Failed to perform validation               | Inline |

#### Response Schema <a href="#post__ai_llm_-id_validate-responseschema" id="post__ai_llm_-id_validate-responseschema"></a>

Status Code **200**

| Name      | Type    | Required | Restrictions | Description                            |
| --------- | ------- | -------- | ------------ | -------------------------------------- |
| » success | boolean | true     | none         | Indicates if validation was successful |
| » message | string  | true     | none         | Detailed validation result message     |

**Note:** A 200 status code indicates the validation operation completed successfully. Check the `success` field to determine if the AI configuration itself is valid. A `false` value with a 200 status means the validation ran but found issues with the configuration.

Status Code **403**

| Name      | Type    | Required | Restrictions | Description |
| --------- | ------- | -------- | ------------ | ----------- |
| » success | boolean | false    | none         | none        |
| » message | string  | false    | none         | none        |

Status Code **404**

| Name      | Type    | Required | Restrictions | Description |
| --------- | ------- | -------- | ------------ | ----------- |
| » success | boolean | false    | none         | none        |
| » message | string  | false    | none         | none        |

Status Code **500**

| Name      | Type    | Required | Restrictions | Description |
| --------- | ------- | -------- | ------------ | ----------- |
| » success | boolean | false    | none         | none        |
| » message | string  | false    | none         | none        |

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth


---

# 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.flashback.tech/support-reference/platform-api-reference/ai-apis/ai-llms/post__ai_llm_-aillmid-_validate.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.