Runs
Create and start a run
POST
/
runs
Create and start a run
curl --request POST \
--url https://api.antigen.sh/v1/runs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"targets": [
"<string>"
],
"agent": "tcell",
"model": "<string>",
"skills": [
{
"name": "<string>",
"content": "<string>"
}
],
"guardrails": "<string>",
"tags": [
"<string>"
],
"egress": "direct",
"ttl": "2h"
}
'import requests
url = "https://api.antigen.sh/v1/runs"
payload = {
"targets": ["<string>"],
"agent": "tcell",
"model": "<string>",
"skills": [
{
"name": "<string>",
"content": "<string>"
}
],
"guardrails": "<string>",
"tags": ["<string>"],
"egress": "direct",
"ttl": "2h"
}
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({
targets: ['<string>'],
agent: 'tcell',
model: '<string>',
skills: [{name: '<string>', content: '<string>'}],
guardrails: '<string>',
tags: ['<string>'],
egress: 'direct',
ttl: '2h'
})
};
fetch('https://api.antigen.sh/v1/runs', 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.antigen.sh/v1/runs",
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([
'targets' => [
'<string>'
],
'agent' => 'tcell',
'model' => '<string>',
'skills' => [
[
'name' => '<string>',
'content' => '<string>'
]
],
'guardrails' => '<string>',
'tags' => [
'<string>'
],
'egress' => 'direct',
'ttl' => '2h'
]),
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.antigen.sh/v1/runs"
payload := strings.NewReader("{\n \"targets\": [\n \"<string>\"\n ],\n \"agent\": \"tcell\",\n \"model\": \"<string>\",\n \"skills\": [\n {\n \"name\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"guardrails\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"egress\": \"direct\",\n \"ttl\": \"2h\"\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.antigen.sh/v1/runs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"targets\": [\n \"<string>\"\n ],\n \"agent\": \"tcell\",\n \"model\": \"<string>\",\n \"skills\": [\n {\n \"name\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"guardrails\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"egress\": \"direct\",\n \"ttl\": \"2h\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.antigen.sh/v1/runs")
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 \"targets\": [\n \"<string>\"\n ],\n \"agent\": \"tcell\",\n \"model\": \"<string>\",\n \"skills\": [\n {\n \"name\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"guardrails\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"egress\": \"direct\",\n \"ttl\": \"2h\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "creating",
"agent": "<string>",
"model": "<string>",
"targets": [
"<string>"
],
"tags": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z"
}Authorizations
ApiKeyAuthBearerAuthSessionCookie
API key from the Antigen dashboard.
Body
application/json
Response
201 - application/json
Run created.
⌘I
Create and start a run
curl --request POST \
--url https://api.antigen.sh/v1/runs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"targets": [
"<string>"
],
"agent": "tcell",
"model": "<string>",
"skills": [
{
"name": "<string>",
"content": "<string>"
}
],
"guardrails": "<string>",
"tags": [
"<string>"
],
"egress": "direct",
"ttl": "2h"
}
'import requests
url = "https://api.antigen.sh/v1/runs"
payload = {
"targets": ["<string>"],
"agent": "tcell",
"model": "<string>",
"skills": [
{
"name": "<string>",
"content": "<string>"
}
],
"guardrails": "<string>",
"tags": ["<string>"],
"egress": "direct",
"ttl": "2h"
}
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({
targets: ['<string>'],
agent: 'tcell',
model: '<string>',
skills: [{name: '<string>', content: '<string>'}],
guardrails: '<string>',
tags: ['<string>'],
egress: 'direct',
ttl: '2h'
})
};
fetch('https://api.antigen.sh/v1/runs', 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.antigen.sh/v1/runs",
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([
'targets' => [
'<string>'
],
'agent' => 'tcell',
'model' => '<string>',
'skills' => [
[
'name' => '<string>',
'content' => '<string>'
]
],
'guardrails' => '<string>',
'tags' => [
'<string>'
],
'egress' => 'direct',
'ttl' => '2h'
]),
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.antigen.sh/v1/runs"
payload := strings.NewReader("{\n \"targets\": [\n \"<string>\"\n ],\n \"agent\": \"tcell\",\n \"model\": \"<string>\",\n \"skills\": [\n {\n \"name\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"guardrails\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"egress\": \"direct\",\n \"ttl\": \"2h\"\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.antigen.sh/v1/runs")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"targets\": [\n \"<string>\"\n ],\n \"agent\": \"tcell\",\n \"model\": \"<string>\",\n \"skills\": [\n {\n \"name\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"guardrails\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"egress\": \"direct\",\n \"ttl\": \"2h\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.antigen.sh/v1/runs")
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 \"targets\": [\n \"<string>\"\n ],\n \"agent\": \"tcell\",\n \"model\": \"<string>\",\n \"skills\": [\n {\n \"name\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"guardrails\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"egress\": \"direct\",\n \"ttl\": \"2h\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "creating",
"agent": "<string>",
"model": "<string>",
"targets": [
"<string>"
],
"tags": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z"
}