Test a provider's dynamic token auth

POST/v1/private/llm-provider-key/auth-config/testTest a provider's dynamic token auth

Runs the token fetch once, backend-side, and reports the token lifetime. The token itself is never returned. Send provider_id to test the stored config, auth_config to test submitted values, or both to resolve secret sentinels against the stored config.

Request body

application/json

objectProviderAuthCheck

auth_configobject

Dynamic token auth recipe. Send the '__SECRET__' sentinel as a credential value to keep the stored secret; send an empty object to clear the auth config.

Show child attributes

credentialsarray of object

Fields sent to the token URL. Values flagged as secret are write-only: they read back as the '__SECRET__' sentinel

maxItems 20 · minItems 0

Show child attributes

maxItems 20 · minItems 0

Show array items

Fields sent to the token URL. Values flagged as secret are write-only: they read back as the '__SECRET__' sentinel

keystringrequired

maxLength 250 · minLength 0

secretboolean

Secret values are encrypted at rest and never read back; once true it cannot be unset

valuestring

maxLength 2000 · minLength 0

expires_fieldstring

Field holding the token lifetime in seconds in the reply; dot-path for nested replies

maxLength 250 · minLength 0

fallback_ttl_secondsinteger · int64

Lifetime in seconds assumed when the reply doesn't state one, capped at one year; 0 disables caching for such replies. A reply-stated lifetime always wins

maximum 31536000 · minimum 0

send_asstring

How credentials are sent: form body (default), JSON body, or basic auth (id/secret in an HTTP Basic header, remaining fields in the form body)

one of "form", "json", "basic"

token_fieldstring

Field holding the token in the reply; dot-path for nested replies

maxLength 250 · minLength 0

token_urlstring

Auth service URL the credentials are sent to

provider_idstring · uuid

Test the stored auth config of this provider; also the sentinel-resolution target when auth_config is sent

Example request

{
  "auth_config": {
    "credentials": [
      {
        "key": "string",
        "secret": "",
        "value": "string"
      }
    ],
    "expires_field": "expires_in",
    "fallback_ttl_seconds": 0,
    "send_as": "basic",
    "token_field": "access_token",
    "token_url": "https://developer.api.example.com/authentication/v1/token"
  },
  "provider_id": "00000000-0000-0000-0000-000000000000"
}

Responses

objectResult

currentnumber · double

namestring

previousnumber · double

Example response

{
  "current": 0,
  "name": "string",
  "previous": 0
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

curl -X POST 'http://localhost:5173/api/v1/private/llm-provider-key/auth-config/test' \
  -H 'Content-Type: application/json' \
  -d '{"auth_config":{"credentials":[{"key":"string","secret":"[REDACTED]","value":"string"}],"expires_field":"expires_in","fallback_ttl_seconds":0,"send_as":"basic","token_field":"access_token","token_url":"https://developer.api.example.com/authentication/v1/token"},"provider_id":"00000000-0000-0000-0000-000000000000"}'

const response = await fetch('https://www.comet.com/opik/api/v1/private/llm-provider-key/auth-config/test', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"auth_config":{"credentials":[{"key":"string","secret":"","value":"string"}],"expires_field":"expires_in","fallback_ttl_seconds":0,"send_as":"basic","token_field":"access_token","token_url":"https://developer.api.example.com/authentication/v1/token"},"provider_id":"00000000-0000-0000-0000-000000000000"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/llm-provider-key/auth-config/test', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"auth_config\":{\"credentials\":[{\"key\":\"string\",\"secret\":\"\",\"value\":\"string\"}],\"expires_field\":\"expires_in\",\"fallback_ttl_seconds\":0,\"send_as\":\"basic\",\"token_field\":\"access_token\",\"token_url\":\"https://developer.api.example.com/authentication/v1/token\"},\"provider_id\":\"00000000-0000-0000-0000-000000000000\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/llm-provider-key/auth-config/test",
    headers={"Content-Type": "application/json"},
    data='{"auth_config":{"credentials":[{"key":"string","secret":"[REDACTED]","value":"string"}],"expires_field":"expires_in","fallback_ttl_seconds":0,"send_as":"basic","token_field":"access_token","token_url":"https://developer.api.example.com/authentication/v1/token"},"provider_id":"00000000-0000-0000-0000-000000000000"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"auth_config":{"credentials":[{"key":"string","secret":"[REDACTED]","value":"string"}],"expires_field":"expires_in","fallback_ttl_seconds":0,"send_as":"basic","token_field":"access_token","token_url":"https://developer.api.example.com/authentication/v1/token"},"provider_id":"00000000-0000-0000-0000-000000000000"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/llm-provider-key/auth-config/test", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/llm-provider-key/auth-config/test");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"auth_config\":{\"credentials\":[{\"key\":\"string\",\"secret\":\"\",\"value\":\"string\"}],\"expires_field\":\"expires_in\",\"fallback_ttl_seconds\":0,\"send_as\":\"basic\",\"token_field\":\"access_token\",\"token_url\":\"https://developer.api.example.com/authentication/v1/token\"},\"provider_id\":\"00000000-0000-0000-0000-000000000000\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/llm-provider-key/auth-config/test"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"auth_config\":{\"credentials\":[{\"key\":\"string\",\"secret\":\"\",\"value\":\"string\"}],\"expires_field\":\"expires_in\",\"fallback_ttl_seconds\":0,\"send_as\":\"basic\",\"token_field\":\"access_token\",\"token_url\":\"https://developer.api.example.com/authentication/v1/token\"},\"provider_id\":\"00000000-0000-0000-0000-000000000000\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/llm-provider-key/auth-config/test")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"auth_config\":{\"credentials\":[{\"key\":\"string\",\"secret\":\"\",\"value\":\"string\"}],\"expires_field\":\"expires_in\",\"fallback_ttl_seconds\":0,\"send_as\":\"basic\",\"token_field\":\"access_token\",\"token_url\":\"https://developer.api.example.com/authentication/v1/token\"},\"provider_id\":\"00000000-0000-0000-0000-000000000000\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/llm-provider-key/auth-config/test");
request.Content = new StringContent("{\"auth_config\":{\"credentials\":[{\"key\":\"string\",\"secret\":\"\",\"value\":\"string\"}],\"expires_field\":\"expires_in\",\"fallback_ttl_seconds\":0,\"send_as\":\"basic\",\"token_field\":\"access_token\",\"token_url\":\"https://developer.api.example.com/authentication/v1/token\"},\"provider_id\":\"00000000-0000-0000-0000-000000000000\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "current": 0,
  "name": "string",
  "previous": 0
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}