Start a new agent execution

Triggers a new execution of the specified agent

POST /agents/{agent_id}/executions

Start a new agent execution

cURL

curl --request POST \
  --url https://app.kapso.ai/api/v1/agents/{agent_id}/executions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "message": "I need help with my order",
  "phone_number": "[phone]",
  "whatsapp_config_id": "config-123abc"
}
'

import requests

url = "https://app.kapso.ai/api/v1/agents/{agent_id}/executions"

payload = {
    "message": "I need help with my order",
    "phone_number": "[phone]",
    "whatsapp_config_id": "config-123abc"
}
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({
    message: 'I need help with my order',
    phone_number: '[phone]',
    whatsapp_config_id: 'config-123abc'
  })
};

fetch('https://app.kapso.ai/api/v1/agents/{agent_id}/executions', 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://app.kapso.ai/api/v1/agents/{agent_id}/executions",
  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([
    'message' => 'I need help with my order',
    'phone_number' => '[phone]',
    'whatsapp_config_id' => 'config-123abc'
  ]),
  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://app.kapso.ai/api/v1/agents/{agent_id}/executions"

	payload := strings.NewReader("{\n  \"message\": \"I need help with my order\",\n  \"phone_number\": \"[phone]\",\n  \"whatsapp_config_id\": \"config-123abc\"\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://app.kapso.ai/api/v1/agents/{agent_id}/executions")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": \"I need help with my order\",\n  \"phone_number\": \"[phone]\",\n  \"whatsapp_config_id\": \"config-123abc\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/agents/{agent_id}/executions")

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  \"message\": \"I need help with my order\",\n  \"phone_number\": \"[phone]\",\n  \"whatsapp_config_id\": \"config-123abc\"\n}"

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

202

{
  "data": {
    "id": "execution-789ghi",
    "agent_id": "agent-123abc",
    "thread_id": "thread-101jkl",
    "status": "running",
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "duration": 123
  }
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

Authorizations

X-API-Key · string · header · required

API key required for all endpoints

Path Parameters

agent_id · string · required

Body

application/json

message · string object

Legacy format - Initial message to send to the agent (string)

Example:

"I need help with my order"

phone_number · string

WhatsApp phone number to associate with this execution

Example:

"[phone]"

whatsapp_config_id · string<uuid>

Optional specific WhatsApp configuration to use for this execution

Example:

"config-123abc"

Response

202

application/json

Execution accepted

data · object

Show child attributes