curl --request POST \
--url https://api.openworklabs.com/v1/inference-providers/custom/test-connection \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"baseUrl": "<string>",
"model": {
"id": "<string>",
"attachment": true,
"reasoning": true,
"tool_call": true,
"structured_output": true,
"temperature": true,
"modalities": {
"input": [],
"output": []
},
"limit": {
"context": 123,
"output": 123
},
"name": "<string>",
"reasoning_options": [
{
"type": "toggle"
}
],
"cost": {
"input": 1,
"output": 1,
"cache_read": 1,
"cache_write": 1
}
},
"apiKey": "<string>",
"inferenceProviderId": "<string>"
}
'import requests
url = "https://api.openworklabs.com/v1/inference-providers/custom/test-connection"
payload = {
"baseUrl": "<string>",
"model": {
"id": "<string>",
"attachment": True,
"reasoning": True,
"tool_call": True,
"structured_output": True,
"temperature": True,
"modalities": {
"input": [],
"output": []
},
"limit": {
"context": 123,
"output": 123
},
"name": "<string>",
"reasoning_options": [{ "type": "toggle" }],
"cost": {
"input": 1,
"output": 1,
"cache_read": 1,
"cache_write": 1
}
},
"apiKey": "<string>",
"inferenceProviderId": "<string>"
}
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({
baseUrl: '<string>',
model: {
id: '<string>',
attachment: true,
reasoning: true,
tool_call: true,
structured_output: true,
temperature: true,
modalities: {input: [], output: []},
limit: {context: 123, output: 123},
name: '<string>',
reasoning_options: [{type: 'toggle'}],
cost: {input: 1, output: 1, cache_read: 1, cache_write: 1}
},
apiKey: '<string>',
inferenceProviderId: '<string>'
})
};
fetch('https://api.openworklabs.com/v1/inference-providers/custom/test-connection', 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.openworklabs.com/v1/inference-providers/custom/test-connection",
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([
'baseUrl' => '<string>',
'model' => [
'id' => '<string>',
'attachment' => true,
'reasoning' => true,
'tool_call' => true,
'structured_output' => true,
'temperature' => true,
'modalities' => [
'input' => [
],
'output' => [
]
],
'limit' => [
'context' => 123,
'output' => 123
],
'name' => '<string>',
'reasoning_options' => [
[
'type' => 'toggle'
]
],
'cost' => [
'input' => 1,
'output' => 1,
'cache_read' => 1,
'cache_write' => 1
]
],
'apiKey' => '<string>',
'inferenceProviderId' => '<string>'
]),
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.openworklabs.com/v1/inference-providers/custom/test-connection"
payload := strings.NewReader("{\n \"baseUrl\": \"<string>\",\n \"model\": {\n \"id\": \"<string>\",\n \"attachment\": true,\n \"reasoning\": true,\n \"tool_call\": true,\n \"structured_output\": true,\n \"temperature\": true,\n \"modalities\": {\n \"input\": [],\n \"output\": []\n },\n \"limit\": {\n \"context\": 123,\n \"output\": 123\n },\n \"name\": \"<string>\",\n \"reasoning_options\": [\n {\n \"type\": \"toggle\"\n }\n ],\n \"cost\": {\n \"input\": 1,\n \"output\": 1,\n \"cache_read\": 1,\n \"cache_write\": 1\n }\n },\n \"apiKey\": \"<string>\",\n \"inferenceProviderId\": \"<string>\"\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.openworklabs.com/v1/inference-providers/custom/test-connection")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"baseUrl\": \"<string>\",\n \"model\": {\n \"id\": \"<string>\",\n \"attachment\": true,\n \"reasoning\": true,\n \"tool_call\": true,\n \"structured_output\": true,\n \"temperature\": true,\n \"modalities\": {\n \"input\": [],\n \"output\": []\n },\n \"limit\": {\n \"context\": 123,\n \"output\": 123\n },\n \"name\": \"<string>\",\n \"reasoning_options\": [\n {\n \"type\": \"toggle\"\n }\n ],\n \"cost\": {\n \"input\": 1,\n \"output\": 1,\n \"cache_read\": 1,\n \"cache_write\": 1\n }\n },\n \"apiKey\": \"<string>\",\n \"inferenceProviderId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/inference-providers/custom/test-connection")
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 \"baseUrl\": \"<string>\",\n \"model\": {\n \"id\": \"<string>\",\n \"attachment\": true,\n \"reasoning\": true,\n \"tool_call\": true,\n \"structured_output\": true,\n \"temperature\": true,\n \"modalities\": {\n \"input\": [],\n \"output\": []\n },\n \"limit\": {\n \"context\": 123,\n \"output\": 123\n },\n \"name\": \"<string>\",\n \"reasoning_options\": [\n {\n \"type\": \"toggle\"\n }\n ],\n \"cost\": {\n \"input\": 1,\n \"output\": 1,\n \"cache_read\": 1,\n \"cache_write\": 1\n }\n },\n \"apiKey\": \"<string>\",\n \"inferenceProviderId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"model": "<string>",
"status": 0,
"code": null,
"message": null,
"step": null
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "rate_limited",
"retryAfterSeconds": 123
}Test a custom OpenAI-compatible provider before saving it
Sends one short test prompt through AI Gateway to /chat/completions with the unsaved API key (or, with inferenceProviderId, the saved key of that custom provider, only for its saved address’s origin) and the model settings on screen. Nothing is stored and no usage is recorded. ok=false carries a message for the admin that never contains the key, and step says which setup step the failure belongs to (connection: address or key; model: that model’s id or settings; null: try again later). May consume a few tokens on the provider account. Requires the Manage Gateway providers permission, enabled Gateway management and the gatewayCustomProviders feature; a person must send it, never the agent or an API key. Shares the provider test limit of 20 tests per member and 60 per organization every ten minutes.
curl --request POST \
--url https://api.openworklabs.com/v1/inference-providers/custom/test-connection \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"baseUrl": "<string>",
"model": {
"id": "<string>",
"attachment": true,
"reasoning": true,
"tool_call": true,
"structured_output": true,
"temperature": true,
"modalities": {
"input": [],
"output": []
},
"limit": {
"context": 123,
"output": 123
},
"name": "<string>",
"reasoning_options": [
{
"type": "toggle"
}
],
"cost": {
"input": 1,
"output": 1,
"cache_read": 1,
"cache_write": 1
}
},
"apiKey": "<string>",
"inferenceProviderId": "<string>"
}
'import requests
url = "https://api.openworklabs.com/v1/inference-providers/custom/test-connection"
payload = {
"baseUrl": "<string>",
"model": {
"id": "<string>",
"attachment": True,
"reasoning": True,
"tool_call": True,
"structured_output": True,
"temperature": True,
"modalities": {
"input": [],
"output": []
},
"limit": {
"context": 123,
"output": 123
},
"name": "<string>",
"reasoning_options": [{ "type": "toggle" }],
"cost": {
"input": 1,
"output": 1,
"cache_read": 1,
"cache_write": 1
}
},
"apiKey": "<string>",
"inferenceProviderId": "<string>"
}
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({
baseUrl: '<string>',
model: {
id: '<string>',
attachment: true,
reasoning: true,
tool_call: true,
structured_output: true,
temperature: true,
modalities: {input: [], output: []},
limit: {context: 123, output: 123},
name: '<string>',
reasoning_options: [{type: 'toggle'}],
cost: {input: 1, output: 1, cache_read: 1, cache_write: 1}
},
apiKey: '<string>',
inferenceProviderId: '<string>'
})
};
fetch('https://api.openworklabs.com/v1/inference-providers/custom/test-connection', 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.openworklabs.com/v1/inference-providers/custom/test-connection",
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([
'baseUrl' => '<string>',
'model' => [
'id' => '<string>',
'attachment' => true,
'reasoning' => true,
'tool_call' => true,
'structured_output' => true,
'temperature' => true,
'modalities' => [
'input' => [
],
'output' => [
]
],
'limit' => [
'context' => 123,
'output' => 123
],
'name' => '<string>',
'reasoning_options' => [
[
'type' => 'toggle'
]
],
'cost' => [
'input' => 1,
'output' => 1,
'cache_read' => 1,
'cache_write' => 1
]
],
'apiKey' => '<string>',
'inferenceProviderId' => '<string>'
]),
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.openworklabs.com/v1/inference-providers/custom/test-connection"
payload := strings.NewReader("{\n \"baseUrl\": \"<string>\",\n \"model\": {\n \"id\": \"<string>\",\n \"attachment\": true,\n \"reasoning\": true,\n \"tool_call\": true,\n \"structured_output\": true,\n \"temperature\": true,\n \"modalities\": {\n \"input\": [],\n \"output\": []\n },\n \"limit\": {\n \"context\": 123,\n \"output\": 123\n },\n \"name\": \"<string>\",\n \"reasoning_options\": [\n {\n \"type\": \"toggle\"\n }\n ],\n \"cost\": {\n \"input\": 1,\n \"output\": 1,\n \"cache_read\": 1,\n \"cache_write\": 1\n }\n },\n \"apiKey\": \"<string>\",\n \"inferenceProviderId\": \"<string>\"\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.openworklabs.com/v1/inference-providers/custom/test-connection")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"baseUrl\": \"<string>\",\n \"model\": {\n \"id\": \"<string>\",\n \"attachment\": true,\n \"reasoning\": true,\n \"tool_call\": true,\n \"structured_output\": true,\n \"temperature\": true,\n \"modalities\": {\n \"input\": [],\n \"output\": []\n },\n \"limit\": {\n \"context\": 123,\n \"output\": 123\n },\n \"name\": \"<string>\",\n \"reasoning_options\": [\n {\n \"type\": \"toggle\"\n }\n ],\n \"cost\": {\n \"input\": 1,\n \"output\": 1,\n \"cache_read\": 1,\n \"cache_write\": 1\n }\n },\n \"apiKey\": \"<string>\",\n \"inferenceProviderId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/inference-providers/custom/test-connection")
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 \"baseUrl\": \"<string>\",\n \"model\": {\n \"id\": \"<string>\",\n \"attachment\": true,\n \"reasoning\": true,\n \"tool_call\": true,\n \"structured_output\": true,\n \"temperature\": true,\n \"modalities\": {\n \"input\": [],\n \"output\": []\n },\n \"limit\": {\n \"context\": 123,\n \"output\": 123\n },\n \"name\": \"<string>\",\n \"reasoning_options\": [\n {\n \"type\": \"toggle\"\n }\n ],\n \"cost\": {\n \"input\": 1,\n \"output\": 1,\n \"cache_read\": 1,\n \"cache_write\": 1\n }\n },\n \"apiKey\": \"<string>\",\n \"inferenceProviderId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"model": "<string>",
"status": 0,
"code": null,
"message": null,
"step": null
}{
"error": "invalid_request",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
],
"message": "<string>",
"capability": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "rate_limited",
"retryAfterSeconds": 123
}Authorizations
Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.
Body
Was this page helpful?