Create session
curl --request POST \
--url https://api.example.com/api/session \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"agent": "<string>",
"model": {
"id": "<string>",
"providerID": "<string>",
"variant": "<string>"
},
"location": {
"directory": "<string>",
"workspaceID": "<string>"
}
}
'import requests
url = "https://api.example.com/api/session"
payload = {
"id": "<string>",
"agent": "<string>",
"model": {
"id": "<string>",
"providerID": "<string>",
"variant": "<string>"
},
"location": {
"directory": "<string>",
"workspaceID": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
agent: '<string>',
model: {id: '<string>', providerID: '<string>', variant: '<string>'},
location: {directory: '<string>', workspaceID: '<string>'}
})
};
fetch('https://api.example.com/api/session', 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/api/session",
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([
'id' => '<string>',
'agent' => '<string>',
'model' => [
'id' => '<string>',
'providerID' => '<string>',
'variant' => '<string>'
],
'location' => [
'directory' => '<string>',
'workspaceID' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/api/session"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"agent\": \"<string>\",\n \"model\": {\n \"id\": \"<string>\",\n \"providerID\": \"<string>\",\n \"variant\": \"<string>\"\n },\n \"location\": {\n \"directory\": \"<string>\",\n \"workspaceID\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/session")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"agent\": \"<string>\",\n \"model\": {\n \"id\": \"<string>\",\n \"providerID\": \"<string>\",\n \"variant\": \"<string>\"\n },\n \"location\": {\n \"directory\": \"<string>\",\n \"workspaceID\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/session")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"agent\": \"<string>\",\n \"model\": {\n \"id\": \"<string>\",\n \"providerID\": \"<string>\",\n \"variant\": \"<string>\"\n },\n \"location\": {\n \"directory\": \"<string>\",\n \"workspaceID\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"projectID": "<string>",
"cost": 123,
"tokens": {
"input": 123,
"output": 123,
"reasoning": 123,
"cache": {
"read": 123,
"write": 123
}
},
"time": {
"created": 123,
"updated": 123,
"archived": 123
},
"title": "<string>",
"location": {
"directory": "<string>",
"workspaceID": "<string>"
},
"parentID": "<string>",
"fork": {
"sessionID": "<string>",
"messageID": "<string>"
},
"agent": "<string>",
"model": {
"id": "<string>",
"providerID": "<string>",
"variant": "<string>"
},
"subpath": "<string>",
"revert": {
"messageID": "<string>",
"partID": "<string>",
"snapshot": "<string>",
"files": [
{
"file": "<string>",
"patch": "<string>",
"additions": 1,
"deletions": 1
}
]
}
}
}{
"_tag": "InvalidRequestError",
"message": "<string>",
"kind": "<string>",
"field": "<string>"
}{
"_tag": "UnauthorizedError",
"message": "<string>"
}session
Create session
Create a session at the requested location.
POST
/
api
/
session
Create session
curl --request POST \
--url https://api.example.com/api/session \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"agent": "<string>",
"model": {
"id": "<string>",
"providerID": "<string>",
"variant": "<string>"
},
"location": {
"directory": "<string>",
"workspaceID": "<string>"
}
}
'import requests
url = "https://api.example.com/api/session"
payload = {
"id": "<string>",
"agent": "<string>",
"model": {
"id": "<string>",
"providerID": "<string>",
"variant": "<string>"
},
"location": {
"directory": "<string>",
"workspaceID": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
agent: '<string>',
model: {id: '<string>', providerID: '<string>', variant: '<string>'},
location: {directory: '<string>', workspaceID: '<string>'}
})
};
fetch('https://api.example.com/api/session', 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/api/session",
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([
'id' => '<string>',
'agent' => '<string>',
'model' => [
'id' => '<string>',
'providerID' => '<string>',
'variant' => '<string>'
],
'location' => [
'directory' => '<string>',
'workspaceID' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/api/session"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"agent\": \"<string>\",\n \"model\": {\n \"id\": \"<string>\",\n \"providerID\": \"<string>\",\n \"variant\": \"<string>\"\n },\n \"location\": {\n \"directory\": \"<string>\",\n \"workspaceID\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/session")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"agent\": \"<string>\",\n \"model\": {\n \"id\": \"<string>\",\n \"providerID\": \"<string>\",\n \"variant\": \"<string>\"\n },\n \"location\": {\n \"directory\": \"<string>\",\n \"workspaceID\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/session")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"agent\": \"<string>\",\n \"model\": {\n \"id\": \"<string>\",\n \"providerID\": \"<string>\",\n \"variant\": \"<string>\"\n },\n \"location\": {\n \"directory\": \"<string>\",\n \"workspaceID\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"projectID": "<string>",
"cost": 123,
"tokens": {
"input": 123,
"output": 123,
"reasoning": 123,
"cache": {
"read": 123,
"write": 123
}
},
"time": {
"created": 123,
"updated": 123,
"archived": 123
},
"title": "<string>",
"location": {
"directory": "<string>",
"workspaceID": "<string>"
},
"parentID": "<string>",
"fork": {
"sessionID": "<string>",
"messageID": "<string>"
},
"agent": "<string>",
"model": {
"id": "<string>",
"providerID": "<string>",
"variant": "<string>"
},
"subpath": "<string>",
"revert": {
"messageID": "<string>",
"partID": "<string>",
"snapshot": "<string>",
"files": [
{
"file": "<string>",
"patch": "<string>",
"additions": 1,
"deletions": 1
}
]
}
}
}{
"_tag": "InvalidRequestError",
"message": "<string>",
"kind": "<string>",
"field": "<string>"
}{
"_tag": "UnauthorizedError",
"message": "<string>"
}⌘I