Test endpoint connection

Test an endpoint connection by making a sample request. Can be used in two modes: (1) Without an ID — all connection fields are required (creation flow). (2) With an ID — fetches the stored connection and applies any provided fields as overrides (update flow). See Endpoint Connections.

POST /endpointConnections/testConnection

Test endpoint connection

cURL

curl --request POST \
  --url https://api.galtea.ai/endpointConnections/testConnection \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "id_123",
  "url": "https://api.example.com",
  "httpMethod": "<string>",
  "authType": "<string>",
  "authToken": "<string>",
  "username": "<string>",
  "password": "securePass123!",
  "headers": {},
  "inputTemplate": "<string>",
  "timeout": 123
}
'

import requests

url = "https://api.galtea.ai/endpointConnections/testConnection"

payload = {
    "id": "id_123",
    "url": "https://api.example.com",
    "httpMethod": "<string>",
    "authType": "<string>",
    "authToken": "<string>",
    "username": "<string>",
    "password": "securePass123!",
    "headers": {},
    "inputTemplate": "<string>",
    "timeout": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: 'id_123',
    url: 'https://api.example.com',
    httpMethod: '<string>',
    authType: '<string>',
    authToken: '<string>',
    username: '<string>',
    password: 'securePass123!',
    headers: {},
    inputTemplate: '<string>',
    timeout: 123
  })
};

fetch('https://api.galtea.ai/endpointConnections/testConnection', 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.galtea.ai/endpointConnections/testConnection",
  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([
    'id' => 'id_123',
    'url' => 'https://api.example.com',
    'httpMethod' => '<string>',
    'authType' => '<string>',
    'authToken' => '<string>',
    'username' => '<string>',
    'password' => 'securePass123!',
    'headers' => [
        
    ],
    'inputTemplate' => '<string>',
    'timeout' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.galtea.ai/endpointConnections/testConnection"

	payload := strings.NewReader("{\n  \"id\": \"id_123\",\n  \"url\": \"https://api.example.com\",\n  \"httpMethod\": \"<string>\",\n  \"authType\": \"<string>\",\n  \"authToken\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"securePass123!\",\n  \"headers\": {},\n  \"inputTemplate\": \"<string>\",\n  \"timeout\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.galtea.ai/endpointConnections/testConnection")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"id_123\",\n  \"url\": \"https://api.example.com\",\n  \"httpMethod\": \"<string>\",\n  \"authType\": \"<string>\",\n  \"authToken\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"securePass123!\",\n  \"headers\": {},\n  \"inputTemplate\": \"<string>\",\n  \"timeout\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galtea.ai/endpointConnections/testConnection")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"id_123\",\n  \"url\": \"https://api.example.com\",\n  \"httpMethod\": \"<string>\",\n  \"authType\": \"<string>\",\n  \"authToken\": \"<string>\",\n  \"username\": \"<string>\",\n  \"password\": \"securePass123!\",\n  \"headers\": {},\n  \"inputTemplate\": \"<string>\",\n  \"timeout\": 123\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "statusCode": 123,
  "latency": 123,
  "response": {},
  "error": "<string>"
}

{
  "error": "Error type",
  "message": "Error message description"
}

{
  "error": "Error type",
  "message": "Error message description"
}

Authorizations

Authorization · string · header · required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Body

application/json

id · string

Optional ID of an existing endpoint connection. When provided, stored connection data is used as base and remaining fields act as overrides.

Example:

"id_123"

url · string

The endpoint URL to test

Example:

"https://api.example.com"

httpMethod · string

HTTP method (GET, POST, etc.)

authType · string

Authentication type (NONE, BEARER, API_KEY, BASIC)

authToken · string

Authentication token (for BEARER or API_KEY)

username · string

Username (for BASIC auth)

password · string

Password (for BASIC auth)

Example:

"securePass123!"

headers · object

Custom headers as key-value pairs

inputTemplate · string

Input template with Jinja2 placeholders

timeout · number

Request timeout in seconds

Response

200

application/json

Test connection result

success · boolean

statusCode · number

latency · number

response · object

error · string