Skip to main content
GET
https://api.crewship.dev
/
v1
/
runs
/
{id}
/
events
curl -N \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: text/event-stream" \
  "https://api.crewship.dev/v1/runs/run_xyz789abc/events"
event: run.started
data: {"run_id":"run_xyz789abc","started_at":"2024-01-15T10:35:02Z"}
id: evt_001

event: agent.started
data: {"agent":"Researcher","task":"Research AI trends"}
id: evt_002

event: tool.called
data: {"tool":"web_search","input":"AI agents 2024"}
id: evt_003

event: log
data: {"level":"info","message":"Found 15 relevant results"}
id: evt_004

event: agent.completed
data: {"agent":"Researcher","task":"Research AI trends","duration_ms":23000}
id: evt_005

event: artifact
data: {"name":"report.md","size":3276,"content_type":"text/markdown"}
id: evt_006

event: run.completed
data: {"run_id":"run_xyz789abc","duration_ms":45200,"status":"succeeded"}
id: evt_007

Path Parameters

id
string
required
Run ID (e.g., run_xyz789abc)

Query Parameters

types
string
Comma-separated list of event types to filter (e.g., agent.started,artifact)

Headers

Accept
string
default:"text/event-stream"
Set to text/event-stream for SSE streaming
Last-Event-ID
string
Resume from a specific event ID after reconnection

Event Format

Events are sent in SSE format:
event: <event_type>
data: <json_payload>
id: <event_id>

Event Types

EventDescription
run.startedRun execution began
run.completedRun finished successfully
run.failedRun encountered an error
run.canceledRun was canceled
agent.startedAgent began a task
agent.completedAgent finished a task
tool.calledTool was invoked
tool.resultTool returned a result
logLog message
artifactArtifact was produced
curl -N \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: text/event-stream" \
  "https://api.crewship.dev/v1/runs/run_xyz789abc/events"
event: run.started
data: {"run_id":"run_xyz789abc","started_at":"2024-01-15T10:35:02Z"}
id: evt_001

event: agent.started
data: {"agent":"Researcher","task":"Research AI trends"}
id: evt_002

event: tool.called
data: {"tool":"web_search","input":"AI agents 2024"}
id: evt_003

event: log
data: {"level":"info","message":"Found 15 relevant results"}
id: evt_004

event: agent.completed
data: {"agent":"Researcher","task":"Research AI trends","duration_ms":23000}
id: evt_005

event: artifact
data: {"name":"report.md","size":3276,"content_type":"text/markdown"}
id: evt_006

event: run.completed
data: {"run_id":"run_xyz789abc","duration_ms":45200,"status":"succeeded"}
id: evt_007

Notes

  • The connection remains open until the run completes or fails
  • Use Last-Event-ID header to resume after disconnection
  • Events are persisted for the run’s retention period