Compile a test version
curl --request POST \
--url https://api.twinbay.ai/test-versions/{test_version_id}/compile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"twins": [
"<string>"
]
}
'import requests
url = "https://api.twinbay.ai/test-versions/{test_version_id}/compile"
payload = { "twins": ["<string>"] }
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({twins: ['<string>']})
};
fetch('https://api.twinbay.ai/test-versions/{test_version_id}/compile', 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.twinbay.ai/test-versions/{test_version_id}/compile",
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([
'twins' => [
'<string>'
]
]),
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.twinbay.ai/test-versions/{test_version_id}/compile"
payload := strings.NewReader("{\n \"twins\": [\n \"<string>\"\n ]\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.twinbay.ai/test-versions/{test_version_id}/compile")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"twins\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.twinbay.ai/test-versions/{test_version_id}/compile")
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 \"twins\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"test_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"status": "pending",
"twins": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"rules": [
{
"outcome_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"matcher": {
"twin": "<string>",
"method": "GET",
"path": "<string>",
"predicates": [
{
"source": "query",
"field": "<string>",
"operator": "eq",
"value": "<string>"
}
]
}
}
],
"error_message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}tests
Compile a test version
Queues compilation of the outcomes into request matchers against the selected twins. Every call creates a new evaluator version; ambiguous or unsupported outcomes settle it as error rather than guessing.
POST
/
test-versions
/
{test_version_id}
/
compile
Compile a test version
curl --request POST \
--url https://api.twinbay.ai/test-versions/{test_version_id}/compile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"twins": [
"<string>"
]
}
'import requests
url = "https://api.twinbay.ai/test-versions/{test_version_id}/compile"
payload = { "twins": ["<string>"] }
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({twins: ['<string>']})
};
fetch('https://api.twinbay.ai/test-versions/{test_version_id}/compile', 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.twinbay.ai/test-versions/{test_version_id}/compile",
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([
'twins' => [
'<string>'
]
]),
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.twinbay.ai/test-versions/{test_version_id}/compile"
payload := strings.NewReader("{\n \"twins\": [\n \"<string>\"\n ]\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.twinbay.ai/test-versions/{test_version_id}/compile")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"twins\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.twinbay.ai/test-versions/{test_version_id}/compile")
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 \"twins\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"test_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"status": "pending",
"twins": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"rules": [
{
"outcome_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"matcher": {
"twin": "<string>",
"method": "GET",
"path": "<string>",
"predicates": [
{
"source": "query",
"field": "<string>",
"operator": "eq",
"value": "<string>"
}
]
}
}
],
"error_message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Access tokenOrganization API key
Access token issued by WorkOS AuthKit.
Path Parameters
Body
application/json
Catalog slugs of the twins whose APIs the outcomes are about.
Required array length:
1 - 10 elementsRequired string length:
1 - 100Response
Successful Response
Available options:
pending, running, ready, error The frozen matchers, once the bundle is ready.
Show child attributes
Show child attributes