Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Meza-dev/Ghostly/llms.txt

Use this file to discover all available pages before exploring further.

The GET /v1/runs/:id endpoint returns the complete stored record for a run that belongs to the authenticated user. The record is available immediately after POST /v1/run responds — the initial status will be "running" until the background job finishes. Once the run terminates, the same endpoint returns the final "pass" or "fail" status along with all step outcomes and, for AI-assisted runs, the full sequence of assist events.

Authentication

Pass an API key via the X-Api-Key header or a JWT via the Authorization: Bearer <token> header.

Path Parameters

id
string (UUID)
required
The run ID returned by POST /v1/run.

Response — 200 OK

The response body is a RunRecord object.
id
string (UUID)
Unique identifier for the run.
status
"pass" | "fail" | "running"
Current lifecycle status of the run.
startedAt
string (ISO 8601)
Timestamp when the run was registered and the browser session began.
durationMs
number
Total elapsed time in milliseconds. Will be 0 while the run is still in "running" status.
baseUrl
string
The root URL the run was executed against.
project
string
Project slug the run is associated with. Present when the run was created with a project value.
contextId
string
Optional external reference (e.g. Git commit SHA or CI build ID) supplied at run creation.
assisted
AssistedMeta object
Present for AI-assisted runs. Contains the metadata recorded at plan time.
steps
StepOutcome[]
Ordered array of per-step execution results.
videoPath
string
Relative path to the recorded WebM video file. Present only when recordVideoOnFailure was enabled and the run ended in "fail" status.
events
AssistEvent[]
Chronologically ordered array of assist pipeline events. Present only for AI-assisted runs. Empty for manual (non-assisted) runs.

Error Responses

StatusBody
404{ ok: false, error: "not found" } — run does not exist or belongs to a different user

Examples

curl https://api.ghostly.dev/v1/runs/d1e2f3a4-0000-4000-8000-112233445566 \
  -H "X-Api-Key: gly_YOUR_API_KEY"
If the run is still in "running" status, durationMs will be 0 and steps may be empty or partial depending on how many steps have completed. Poll this endpoint or use the SSE stream for live updates.

Build docs developers (and LLMs) love