curl --request POST \
--url https://api.getdialed.ai/v1/credentials/test \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"auth_method": "basic_auth",
"credentials": {
"password": "REPLACE_ME",
"username": "api_user@example"
},
"platform_id": "five9"
}
'import requests
url = "https://api.getdialed.ai/v1/credentials/test"
payload = {
"auth_method": "basic_auth",
"credentials": {
"password": "REPLACE_ME",
"username": "api_user@example"
},
"platform_id": "five9"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
auth_method: 'basic_auth',
credentials: {password: 'REPLACE_ME', username: 'api_user@example'},
platform_id: 'five9'
})
};
fetch('https://api.getdialed.ai/v1/credentials/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getdialed.ai/v1/credentials/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'auth_method' => 'basic_auth',
'credentials' => [
'password' => 'REPLACE_ME',
'username' => 'api_user@example'
],
'platform_id' => 'five9'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getdialed.ai/v1/credentials/test"
payload := strings.NewReader("{\n \"auth_method\": \"basic_auth\",\n \"credentials\": {\n \"password\": \"REPLACE_ME\",\n \"username\": \"api_user@example\"\n },\n \"platform_id\": \"five9\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getdialed.ai/v1/credentials/test")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"auth_method\": \"basic_auth\",\n \"credentials\": {\n \"password\": \"REPLACE_ME\",\n \"username\": \"api_user@example\"\n },\n \"platform_id\": \"five9\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getdialed.ai/v1/credentials/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"auth_method\": \"basic_auth\",\n \"credentials\": {\n \"password\": \"REPLACE_ME\",\n \"username\": \"api_user@example\"\n },\n \"platform_id\": \"five9\"\n}"
response = http.request(request)
puts response.read_body{
"details": "Authenticated successfully; 3 lists visible",
"latency_ms": 412,
"success": true,
"tested_at": "2026-07-09T18:00:00Z"
}{
"detail": "Authentication required"
}{
"detail": "Admin role required"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Rate limit exceeded: 100 per 1 minute"
}Test credentials without saving them
Check a set of credentials against its platform without storing anything — the test-before-save flow. Admin only.
This is a liveness check. It proves the credentials are real and that the platform is reachable with them. It does NOT prove what they are permitted to do: verifying permissions would mean performing the operations themselves against your live vendor account, which this API will not do. What a credential has actually been able to do is recorded on the credential as it gets used, and is readable from GET /credentials/{credential_id}.
Always returns 200 with a result — the success and error fields carry the outcome, including timeouts and a platform that offers no test. Nothing is written and no flow is started.
curl --request POST \
--url https://api.getdialed.ai/v1/credentials/test \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"auth_method": "basic_auth",
"credentials": {
"password": "REPLACE_ME",
"username": "api_user@example"
},
"platform_id": "five9"
}
'import requests
url = "https://api.getdialed.ai/v1/credentials/test"
payload = {
"auth_method": "basic_auth",
"credentials": {
"password": "REPLACE_ME",
"username": "api_user@example"
},
"platform_id": "five9"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
auth_method: 'basic_auth',
credentials: {password: 'REPLACE_ME', username: 'api_user@example'},
platform_id: 'five9'
})
};
fetch('https://api.getdialed.ai/v1/credentials/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getdialed.ai/v1/credentials/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'auth_method' => 'basic_auth',
'credentials' => [
'password' => 'REPLACE_ME',
'username' => 'api_user@example'
],
'platform_id' => 'five9'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getdialed.ai/v1/credentials/test"
payload := strings.NewReader("{\n \"auth_method\": \"basic_auth\",\n \"credentials\": {\n \"password\": \"REPLACE_ME\",\n \"username\": \"api_user@example\"\n },\n \"platform_id\": \"five9\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getdialed.ai/v1/credentials/test")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"auth_method\": \"basic_auth\",\n \"credentials\": {\n \"password\": \"REPLACE_ME\",\n \"username\": \"api_user@example\"\n },\n \"platform_id\": \"five9\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getdialed.ai/v1/credentials/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"auth_method\": \"basic_auth\",\n \"credentials\": {\n \"password\": \"REPLACE_ME\",\n \"username\": \"api_user@example\"\n },\n \"platform_id\": \"five9\"\n}"
response = http.request(request)
puts response.read_body{
"details": "Authenticated successfully; 3 lists visible",
"latency_ms": 412,
"success": true,
"tested_at": "2026-07-09T18:00:00Z"
}{
"detail": "Authentication required"
}{
"detail": "Admin role required"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Rate limit exceeded: 100 per 1 minute"
}Authorizations
Body
Ad-hoc credentials test request. Verifies a credentials payload against
the target platform without saving a credential — the "test before save"
flow posts this body, then persists via POST /credentials on success.
Response
Successful Response
Result of a credential test. Returned with HTTP 200 for every test
outcome, including failures and timeouts — inspect success and error
rather than the status code. When success is false, error is one of:
AUTH_FAILED, NETWORK, TIMEOUT, RATE_LIMITED, PERMISSION_DENIED,
INVALID_CREDENTIALS_SHAPE, UNKNOWN. latency_ms measures the platform
round-trip only.