> ## Documentation Index > Fetch the complete documentation index at: https://docs.e2b.dev/llms.txt > Use this file to discover all available pages before exploring further. # Connect > Server-streaming RPC. Use the Connect protocol with streaming support. ## OpenAPI ````yaml /openapi-public.yaml post /process.Process/Connect openapi: 3.1.0 info: title: E2B API version: 0.1.0 description: >- Complete E2B developer API. Platform endpoints are served on api.e2b.app. Sandbox endpoints (envd) are served on the shared sandbox host (sandbox.e2b.app); target a specific sandbox with the E2b-Sandbox-Id and E2b-Sandbox-Port headers. servers: - url: https://api.e2b.app description: E2B Platform API security: [] tags: - name: Sandboxes - name: Templates - name: Tags - name: Volumes - name: Envd - name: Filesystem - name: Process - name: Teams - name: Secrets - name: Events - name: Webhooks paths: /process.Process/Connect: servers: - url: https://sandbox.e2b.app description: Sandbox API (envd) - routes using sandbox ID and port headers post: tags: - Process summary: Connect description: Server-streaming RPC. Use the Connect protocol with streaming support. operationId: process.Process.Connect parameters: - name: Connect-Protocol-Version in: header required: true schema: type: string enum: - '1' example: '1' - name: Connect-Timeout-Ms in: header schema: $ref: '#/components/schemas/connect-timeout-header' - name: E2b-Sandbox-Id in: header required: true description: >- Identifier of the target sandbox. Routes the request to that sandbox's envd over the shared sandbox host. schema: type: string - name: E2b-Sandbox-Port in: header required: true description: Port envd listens on inside the sandbox (default 49983). schema: type: integer default: 49983 example: 49983 requestBody: content: application/connect+json: schema: type: string format: binary x-connect-message-schema: $ref: '#/components/schemas/process.ConnectRequest' required: true description: >- Send Connect-framed bytes with Content-Type application/connect+json. Each uncompressed request frame begins with flags byte 0, then the JSON payload length as four big-endian bytes, then the UTF-8 JSON payload. The decoded payload follows `#/components/schemas/process.ConnectRequest` (x-connect-message-schema). Sending a bare JSON document does not encode a valid Connect request frame. responses: '200': description: >- Stream of ConnectResponse events Decoded terminal error example (the wire also includes the five-byte frame prefix): `{"error":{"code":"not_found","message":"process with pid 2147483647 not found"}}`. Connect-framed bytes, not an ordinary JSON document. Each frame has a one-byte flags field and a four-byte big-endian payload length. The decoded data payload follows x-connect-message-schema. The final frame has flags=2 and follows x-connect-end-stream-schema. RPC failures appear in its error object while the HTTP status remains 200. Authentication or routing failures before the stream can use the separate HTTP responses below. content: application/connect+json: schema: type: string format: binary x-connect-message-schema: $ref: '#/components/schemas/process.ConnectResponse' x-connect-end-stream-schema: $ref: '#/components/schemas/ConnectEndStreamResponse' x-connect-decoded-examples: completed: flags: 2 payload: {} failed: flags: 2 payload: error: code: not_found message: process with pid 2147483647 not found '400': description: The sandbox proxy rejects missing or invalid routing information. content: text/plain: schema: type: string examples: missingRoutingHeader: summary: >- The sandbox proxy rejects missing or invalid routing information. value: | missing header '401': description: Sandbox access-token or signature authentication failed. content: application/json: schema: $ref: '#/components/schemas/EnvdHTTPError' examples: sandboxAuthentication: summary: Missing or invalid sandbox credentials value: code: 401 message: >- unauthorized access, please provide a valid access token or method signing if supported '500': description: The sandbox proxy encountered an unexpected routing error. content: text/plain: schema: type: string examples: routingFailure: summary: The sandbox proxy encountered an unexpected routing error. value: | Unexpected error when routing request: invalid sandbox port '502': description: >- The sandbox proxy could not find the sandbox. Browser navigation may receive an HTML error page. content: application/json: schema: $ref: '#/components/schemas/SandboxRoutingError' examples: sandboxNotFound: value: sandboxId: sandbox-id message: The sandbox was not found code: 502 text/html: schema: type: string security: - SandboxAccessTokenAuth: [] x-codeSamples: - lang: python label: Python (Connect framing) source: > import json import os import struct import urllib.request # Set E2B_SANDBOX_ID and E2B_ENVD_ACCESS_TOKEN from a secured sandbox's # create/connect response. This token is not your project API key. # E2B_PROCESS_PID must identify a running process in that sandbox. messages = [{"process": {"pid": int(os.environ["E2B_PROCESS_PID"])}}] body = b"" for message in messages: payload = json.dumps(message).encode("utf-8") body += struct.pack(">BI", 0, len(payload)) + payload request = urllib.request.Request( "https://sandbox.e2b.app/process.Process/Connect", data=body, headers={ "Content-Type": "application/connect+json", "Connect-Protocol-Version": "1", "Connect-Timeout-Ms": "5000", "E2b-Sandbox-Id": os.environ["E2B_SANDBOX_ID"], "E2b-Sandbox-Port": "49983", "X-Access-Token": os.environ["E2B_ENVD_ACCESS_TOKEN"], }, method="POST", ) with urllib.request.urlopen(request, timeout=10) as response: data = response.read() # HTTP 200 can still contain a terminal error. Decode each envelope. offset = 0 while offset < len(data): if len(data) - offset < 5: raise ValueError("Truncated Connect envelope") flags, length = struct.unpack_from(">BI", data, offset) offset += 5 if length > len(data) - offset: raise ValueError("Truncated Connect message") message = json.loads(data[offset:offset + length]) offset += length if flags & 2: if message.get("error"): raise RuntimeError(message["error"]) break print(message) components: schemas: connect-timeout-header: type: number title: Connect-Timeout-Ms description: Define the timeout, in ms EnvdHTTPError: type: object required: - code - message properties: code: type: integer message: type: string description: >- HTTP error from envd, with a numeric status code. Distinct from a Connect RPC error. SandboxRoutingError: type: object required: - sandboxId - message - code properties: sandboxId: type: string message: type: string code: type: integer securitySchemes: SandboxAccessTokenAuth: type: apiKey in: header name: X-Access-Token description: >- Sandbox access token (`envdAccessToken`) for authenticating requests to a running sandbox. Returned by: [POST /sandboxes](/api-reference/sandboxes/create-sandbox) (on create), [POST /sandboxes/{sandboxID}/connect](/api-reference/sandboxes/connect-to-sandbox) (on connect), [POST /sandboxes/{sandboxID}/resume](/api-reference/sandboxes/resume-sandbox) (on resume), and [GET /sandboxes/{sandboxID}](/api-reference/sandboxes/get-sandbox) (for running or paused sandboxes). ````