Get Session
curl --request GET \
--url https://api.example.com/v1/sessions/{session_id}import requests
url = "https://api.example.com/v1/sessions/{session_id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/sessions/{session_id}', 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}",
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}"
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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/sessions/{session_id}")
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 Session
Get details for a specific session
GET
/
v1
/
sessions
/
{session_id}
Get Session
curl --request GET \
--url https://api.example.com/v1/sessions/{session_id}import requests
url = "https://api.example.com/v1/sessions/{session_id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/sessions/{session_id}', 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}",
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}"
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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/sessions/{session_id}")
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 the current state and details of a session.
See Create Session for full response field descriptions.
Request
curl https://api.tapkit.ai/v1/sessions/{session_id} \
-H "X-API-Key: joot_your_api_key"
Path Parameters
| Parameter | Type | Description |
|---|---|---|
session_id | string | The session identifier |
Response
Status: 200 OK{
"id": "sess_abc123",
"phone_id": "abc123-def456",
"instruction": "Open Instagram and like the first 3 posts",
"status": "running",
"cost_usd": null,
"duration_ms": null,
"num_turns": 8,
"error": null,
"created_at": "2024-01-15T10:30:00Z",
"started_at": "2024-01-15T10:30:02Z",
"completed_at": null
}
Examples
Python
import requests
response = requests.get(
f"https://api.tapkit.ai/v1/sessions/{session_id}",
headers={"X-API-Key": "joot_..."}
)
session = response.json()
print(f"Status: {session['status']}, Turns: {session['num_turns']}")
Related Endpoints
- List Sessions - List all sessions
- Get Events - Poll for session events
- Stop Session - Kill a running session
⌘I