post__ai_llm_{aillmId}_validate

⚠️ TEST ENVIRONMENT ONLY

This API endpoint is currently available only in the TEST environment. It is not yet available in production.

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

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

Code Samples

# 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}'

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);
});

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)

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())

<?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());
 }

 // ...

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());

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)
    // ...
}

Parameters

Name

Type

Required

Description

path

string

true

Unique identifier of the AI LLM configuration

Example responses

200 Response (Success)

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

200 Response (Failure)

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

Responses

Status

Meaning

Description

Schema

200

Validation completed (check success field)

Inline

403

Forbidden

Insufficient permissions

Inline

404

Not Found

Configuration not found

Inline

500

Internal Server Error

Failed to perform validation

Inline

Response Schema

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

» message

string

false

none

Status Code 404

Name

Type

Required

Restrictions

Description

» success

boolean

false

none

» message

string

false

none

Status Code 500

Name

Type

Required

Restrictions

Description

» success

boolean

false

none

» message

string

false

none

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

Previousdelete__ai_llm_{aillmId}NextAI Policy

Last updated 2 months ago

Was this helpful?

hashtagTypeScript Client Library

hashtagCode Samples

hashtagParameters

hashtagResponses

hashtagResponse Schema

TypeScript Client Library

Code Samples

Parameters

Responses

Response Schema