> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://platform.bctrl.ai/llms.txt. > For full documentation content, see https://platform.bctrl.ai/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://platform.bctrl.ai/_mcp/server. # Stream Run Events GET https://api.bctrl.ai/v1/runs/{runId}/events/stream Stream canonical run events as Server-Sent Events. Reference: https://platform.bctrl.ai/api/api-reference/runs/stream-events ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: bctrl API version: 1.0.0 paths: /v1/runs/{runId}/events/stream: get: operationId: events-stream summary: Stream run events description: Stream canonical run events as Server-Sent Events. tags: - subpackage_runs parameters: - name: runId in: path required: true schema: type: string - name: type in: query required: false schema: $ref: '#/components/schemas/V1RunsRunIdEventsStreamGetParametersType' - name: status in: query required: false schema: $ref: '#/components/schemas/V1RunsRunIdEventsStreamGetParametersStatus' - name: pageId in: query required: false schema: type: string - name: contextId in: query required: false schema: type: string - name: cursor in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer default: 50 - name: Authorization in: header description: Use Bearer . required: true schema: type: string responses: '200': description: Successful response '401': description: 'Authentication required: the API key is missing or invalid.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: 'Forbidden: the API key cannot access this resource.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Run not found or not visible to actor content: application/json: schema: description: Any type '429': description: Rate limit exceeded. Retry after the delay indicated by Retry-After. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' servers: - url: https://api.bctrl.ai description: Production - url: http://localhost:8787 description: Local development gateway components: schemas: V1RunsRunIdEventsStreamGetParametersType0: type: string enum: - runtime.lifecycle - navigation - network.request - network.response - network.failed - console.message - page.error - page.crash - dialog - download - captcha.solve.started - captcha.solve.succeeded - captcha.solve.failed title: V1RunsRunIdEventsStreamGetParametersType0 V1RunsRunIdEventsStreamGetParametersTypeSchemaOneOf1Items: type: string enum: - runtime.lifecycle - navigation - network.request - network.response - network.failed - console.message - page.error - page.crash - dialog - download - captcha.solve.started - captcha.solve.succeeded - captcha.solve.failed title: V1RunsRunIdEventsStreamGetParametersTypeSchemaOneOf1Items V1RunsRunIdEventsStreamGetParametersType1: type: array items: $ref: >- #/components/schemas/V1RunsRunIdEventsStreamGetParametersTypeSchemaOneOf1Items title: V1RunsRunIdEventsStreamGetParametersType1 V1RunsRunIdEventsStreamGetParametersType: oneOf: - $ref: '#/components/schemas/V1RunsRunIdEventsStreamGetParametersType0' - $ref: '#/components/schemas/V1RunsRunIdEventsStreamGetParametersType1' title: V1RunsRunIdEventsStreamGetParametersType V1RunsRunIdEventsStreamGetParametersStatus0: type: string enum: - started - stopped - failed - finished - received title: V1RunsRunIdEventsStreamGetParametersStatus0 V1RunsRunIdEventsStreamGetParametersStatusSchemaOneOf1Items: type: string enum: - started - stopped - failed - finished - received title: V1RunsRunIdEventsStreamGetParametersStatusSchemaOneOf1Items V1RunsRunIdEventsStreamGetParametersStatus1: type: array items: $ref: >- #/components/schemas/V1RunsRunIdEventsStreamGetParametersStatusSchemaOneOf1Items title: V1RunsRunIdEventsStreamGetParametersStatus1 V1RunsRunIdEventsStreamGetParametersStatus: oneOf: - $ref: '#/components/schemas/V1RunsRunIdEventsStreamGetParametersStatus0' - $ref: '#/components/schemas/V1RunsRunIdEventsStreamGetParametersStatus1' title: V1RunsRunIdEventsStreamGetParametersStatus ErrorResponseReasonClass: type: string enum: - invalid_input - unauthorized - capability_denied - capability_limit_exceeded - rate_limited - not_found - conflict - upstream - server description: Stable public error category for programmatic branching. title: ErrorResponseReasonClass ErrorResponse: type: object properties: code: type: string description: >- Stable, dot-namespaced error code, e.g. "runtime.not_found" or "request.invalid". details: type: object additionalProperties: description: Any type description: >- Resource-specific structured context. Use `code` and `reasonClass` for branching. error: type: string hint: type: string description: Optional next action for recoverable errors, e.g. "retry after 2s". reasonClass: $ref: '#/components/schemas/ErrorResponseReasonClass' description: Stable public error category for programmatic branching. requestId: type: string required: - code - error title: ErrorResponse securitySchemes: bearerAuth: type: http scheme: bearer description: Use Bearer . ``` ## Examples **SDK Code** ```python import requests url = "https://api.bctrl.ai/v1/runs/runId/events/stream" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.bctrl.ai/v1/runs/runId/events/stream'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.bctrl.ai/v1/runs/runId/events/stream" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.bctrl.ai/v1/runs/runId/events/stream") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.bctrl.ai/v1/runs/runId/events/stream") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.bctrl.ai/v1/runs/runId/events/stream', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.bctrl.ai/v1/runs/runId/events/stream"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/runs/runId/events/stream")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```