Get Events
curl --request GET \
--url https://api.example.com/v1/sessions/{session_id}/eventsimport requests
url = "https://api.example.com/v1/sessions/{session_id}/events"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/sessions/{session_id}/events', 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.example.com/v1/sessions/{session_id}/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/sessions/{session_id}/events"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/sessions/{session_id}/events")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/sessions/{session_id}/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodySessions
Get Events
Poll for session events
GET
/
v1
/
sessions
/
{session_id}
/
events
Get Events
curl --request GET \
--url https://api.example.com/v1/sessions/{session_id}/eventsimport requests
url = "https://api.example.com/v1/sessions/{session_id}/events"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/sessions/{session_id}/events', 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.example.com/v1/sessions/{session_id}/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/sessions/{session_id}/events"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/sessions/{session_id}/events")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/sessions/{session_id}/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyGet buffered events for a session. Use polling to follow the agent’s progress in real time.
Request
curl "https://api.tapkit.ai/v1/sessions/{session_id}/events?since=0" \
-H "X-API-Key: joot_your_api_key"
Path Parameters
| Parameter | Type | Description |
|---|---|---|
session_id | string | The session identifier |
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
since | integer | 0 | Get events starting from this index |
Response
Status: 200 OK{
"events": [
{
"index": 0,
"type": "agent_action",
"ts": "2024-01-15T10:30:05Z",
"data": {
"action": "screenshot",
"description": "Taking screenshot to see current screen"
}
},
{
"index": 1,
"type": "agent_action",
"ts": "2024-01-15T10:30:07Z",
"data": {
"action": "tap",
"description": "Tapping Instagram icon",
"x": 200,
"y": 400
}
}
],
"next_index": 2
}
Response Fields
| Field | Type | Description |
|---|---|---|
events | array | Array of event objects |
events[].index | integer | Sequential event index |
events[].type | string | Event type |
events[].ts | string | ISO 8601 timestamp |
events[].data | object | Event-specific data |
next_index | integer | Pass this as since in your next poll |
Examples
Polling Loop
import requests
import time
session_id = "sess_abc123"
next_index = 0
while True:
response = requests.get(
f"https://api.tapkit.ai/v1/sessions/{session_id}/events",
headers={"X-API-Key": "joot_..."},
params={"since": next_index}
)
data = response.json()
for event in data["events"]:
print(f"[{event['type']}] {event['data']}")
next_index = data["next_index"]
time.sleep(1)
Related Endpoints
- Get Session - Get session status
- Send Message - Send a follow-up message to the agent
- Stop Session - Kill a running session
⌘I