Agent Runs
Create a run
Triggers an agent run asynchronously. Poll the returned status_url or subscribe to kapso_agent.run.* project webhooks.
POST
/
kapso-agent
/
runs
Create a run
curl --request POST \
--url https://api.kapso.ai/platform/v1/kapso-agent/runs \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"mode": "api",
"input": {
"prompt": "<string>",
"finding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {}
}
'import requests
url = "https://api.kapso.ai/platform/v1/kapso-agent/runs"
payload = {
"mode": "api",
"input": {
"prompt": "<string>",
"finding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {}
}
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({
mode: 'api',
input: {prompt: '<string>', finding_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
conversation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {}
})
};
fetch('https://api.kapso.ai/platform/v1/kapso-agent/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.kapso.ai/platform/v1/kapso-agent/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([
'mode' => 'api',
'input' => [
'prompt' => '<string>',
'finding_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'conversation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'metadata' => [
]
]),
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.kapso.ai/platform/v1/kapso-agent/runs"
payload := strings.NewReader("{\n \"mode\": \"api\",\n \"input\": {\n \"prompt\": \"<string>\",\n \"finding_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\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.kapso.ai/platform/v1/kapso-agent/runs")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"api\",\n \"input\": {\n \"prompt\": \"<string>\",\n \"finding_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kapso.ai/platform/v1/kapso-agent/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 \"mode\": \"api\",\n \"input\": {\n \"prompt\": \"<string>\",\n \"finding_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"mode": "api",
"title": "<string>",
"kind": "ask",
"prompt": "<string>",
"provider_model": "gpt-5.5",
"reasoning_effort": "medium",
"error_message": "<string>",
"ai_cost_microdollars": 123,
"result": {
"type": "message",
"message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "<string>",
"data": {}
},
"pending_approval": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"tool_name": "<string>",
"parameters": {},
"created_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"paused_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"status_url": "<string>",
"finding": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"investigation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Body
application/json
Slug of a mode whose available_invocations includes api
Example:
"api"
Mode input. The generic trigger requires prompt; findings-investigator requires finding_id.
Show child attributes
Show child attributes
Continue an existing session created with the same API key and mode
Arbitrary data stored on the run and echoed in webhooks
Response
Run accepted
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Create a run
curl --request POST \
--url https://api.kapso.ai/platform/v1/kapso-agent/runs \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"mode": "api",
"input": {
"prompt": "<string>",
"finding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {}
}
'import requests
url = "https://api.kapso.ai/platform/v1/kapso-agent/runs"
payload = {
"mode": "api",
"input": {
"prompt": "<string>",
"finding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {}
}
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({
mode: 'api',
input: {prompt: '<string>', finding_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
conversation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {}
})
};
fetch('https://api.kapso.ai/platform/v1/kapso-agent/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.kapso.ai/platform/v1/kapso-agent/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([
'mode' => 'api',
'input' => [
'prompt' => '<string>',
'finding_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'conversation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'metadata' => [
]
]),
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.kapso.ai/platform/v1/kapso-agent/runs"
payload := strings.NewReader("{\n \"mode\": \"api\",\n \"input\": {\n \"prompt\": \"<string>\",\n \"finding_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\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.kapso.ai/platform/v1/kapso-agent/runs")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"api\",\n \"input\": {\n \"prompt\": \"<string>\",\n \"finding_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kapso.ai/platform/v1/kapso-agent/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 \"mode\": \"api\",\n \"input\": {\n \"prompt\": \"<string>\",\n \"finding_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "queued",
"mode": "api",
"title": "<string>",
"kind": "ask",
"prompt": "<string>",
"provider_model": "gpt-5.5",
"reasoning_effort": "medium",
"error_message": "<string>",
"ai_cost_microdollars": 123,
"result": {
"type": "message",
"message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "<string>",
"data": {}
},
"pending_approval": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"tool_name": "<string>",
"parameters": {},
"created_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"paused_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"status_url": "<string>",
"finding": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"investigation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}{
"error": "<string>"
}{
"error": "<string>"
}
