session.stream({ after? })
curl --request GET \
--url https://api.paddock.build/v1/sessions/{id}/stream \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.paddock.build/v1/sessions/{id}/stream', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.paddock.build/v1/sessions/{id}/stream"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.paddock.build/v1/sessions/{id}/stream"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"event": "session",
"data": {
"id": "<string>",
"agentId": "<string>",
"cwd": "<string>",
"systemPrompt": "<string>",
"status": "idle",
"lastSeq": 4503599627370495,
"lastUserSeq": 4503599627370495,
"processedSeq": 4503599627370495,
"heldSeq": 4503599627370495,
"lastError": {
"code": "harness_error",
"message": "<string>"
},
"retryAt": "2023-11-07T05:31:56Z",
"lastEventAt": "2023-11-07T05:31:56Z",
"observedGeneration": 1,
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}Messages and events
session.stream({ after? })
GET
/
sessions
/
{id}
/
stream
session.stream({ after? })
curl --request GET \
--url https://api.paddock.build/v1/sessions/{id}/stream \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.paddock.build/v1/sessions/{id}/stream', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.paddock.build/v1/sessions/{id}/stream"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.paddock.build/v1/sessions/{id}/stream"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"event": "session",
"data": {
"id": "<string>",
"agentId": "<string>",
"cwd": "<string>",
"systemPrompt": "<string>",
"status": "idle",
"lastSeq": 4503599627370495,
"lastUserSeq": 4503599627370495,
"processedSeq": 4503599627370495,
"heldSeq": 4503599627370495,
"lastError": {
"code": "harness_error",
"message": "<string>"
},
"retryAt": "2023-11-07T05:31:56Z",
"lastEventAt": "2023-11-07T05:31:56Z",
"observedGeneration": 1,
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>",
"details": {}
}
}Query Parameters
Response
A session snapshot, then every event after the resume point, then live events
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
An event of the stream as an SDK surfaces it: the SSE event field as event, the parsed data as data, the SSE id as id.