{ "components": { "schemas": { "CaptchaActionResponse": { "additionalProperties": false, "properties": { "message": { "description": "Response message", "type": "string" }, "success": { "description": "Whether the action was successful", "type": "boolean" } }, "required": [ "success" ], "title": "captchaActionResponse", "type": "object" }, "CaptchaState": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when the state was created", "type": "number" }, "isSolvingCaptcha": { "description": "Whether a captcha is currently being solved", "type": "boolean" }, "lastUpdated": { "description": "Timestamp when the state was last updated", "type": "number" }, "pageId": { "description": "The page ID where the captcha is located", "type": "string" }, "tasks": { "description": "Array of captcha tasks", "items": {}, "type": "array" }, "url": { "description": "The URL where the captcha is located", "type": "string" } }, "required": [ "pageId", "url", "isSolvingCaptcha", "tasks" ], "title": "captchaState", "type": "object" }, "CaptchaStateResponse": { "items": { "additionalProperties": false, "properties": { "created": { "description": "Timestamp when the state was created", "type": "number" }, "isSolvingCaptcha": { "description": "Whether a captcha is currently being solved", "type": "boolean" }, "lastUpdated": { "description": "Timestamp when the state was last updated", "type": "number" }, "pageId": { "description": "The page ID where the captcha is located", "type": "string" }, "tasks": { "description": "Array of captcha tasks", "items": {}, "type": "array" }, "url": { "description": "The URL where the captcha is located", "type": "string" } }, "required": [ "pageId", "url", "isSolvingCaptcha", "tasks" ], "type": "object" }, "title": "captchaStateResponse", "type": "array" }, "ComputerActionRequest": { "oneOf": [ { "additionalProperties": false, "properties": { "action": { "enum": [ "move_mouse" ], "type": "string" }, "coordinates": { "description": "X and Y coordinates [x, y]", "items": { "type": "number" }, "maxItems": 2, "minItems": 2, "type": "array" }, "hold_keys": { "description": "Keys to hold while moving", "items": { "type": "string" }, "type": "array" }, "screenshot": { "description": "Whether to take a screenshot after the action", "type": "boolean" } }, "required": [ "action", "coordinates" ], "type": "object" }, { "additionalProperties": false, "properties": { "action": { "enum": [ "click_mouse" ], "type": "string" }, "button": { "default": "left", "description": "Mouse button to click. Defaults to 'left'", "enum": [ "left", "right", "middle", "back", "forward" ], "type": "string" }, "click_type": { "description": "Type of click (down, up, or click). Defaults to 'click'", "enum": [ "down", "up", "click" ], "type": "string" }, "coordinates": { "description": "X and Y coordinates [x, y]", "items": { "type": "number" }, "maxItems": 2, "minItems": 2, "type": "array" }, "hold_keys": { "description": "Keys to hold while clicking", "items": { "type": "string" }, "type": "array" }, "num_clicks": { "description": "Number of clicks. Defaults to 1", "type": "number" }, "screenshot": { "description": "Whether to take a screenshot after the action", "type": "boolean" } }, "required": [ "action" ], "type": "object" }, { "additionalProperties": false, "properties": { "action": { "enum": [ "drag_mouse" ], "type": "string" }, "hold_keys": { "description": "Keys to hold while dragging", "items": { "type": "string" }, "type": "array" }, "path": { "description": "Array of [x, y] coordinate pairs", "items": { "items": { "type": "number" }, "maxItems": 2, "minItems": 2, "type": "array" }, "type": "array" }, "screenshot": { "description": "Whether to take a screenshot after the action", "type": "boolean" } }, "required": [ "action", "path" ], "type": "object" }, { "additionalProperties": false, "properties": { "action": { "enum": [ "scroll" ], "type": "string" }, "coordinates": { "description": "X and Y coordinates [x, y]", "items": { "type": "number" }, "maxItems": 2, "minItems": 2, "type": "array" }, "delta_x": { "description": "Horizontal scroll amount. Defaults to 0", "type": "number" }, "delta_y": { "description": "Vertical scroll amount. Defaults to 0", "type": "number" }, "hold_keys": { "description": "Keys to hold while scrolling", "items": { "type": "string" }, "type": "array" }, "screenshot": { "description": "Whether to take a screenshot after the action", "type": "boolean" } }, "required": [ "action" ], "type": "object" }, { "additionalProperties": false, "properties": { "action": { "enum": [ "press_key" ], "type": "string" }, "duration": { "description": "Duration to hold keys in seconds", "type": "number" }, "keys": { "description": "Keys to press", "items": { "type": "string" }, "type": "array" }, "screenshot": { "description": "Whether to take a screenshot after the action", "type": "boolean" } }, "required": [ "action", "keys" ], "type": "object" }, { "additionalProperties": false, "properties": { "action": { "enum": [ "type_text" ], "type": "string" }, "hold_keys": { "description": "Keys to hold while typing", "items": { "type": "string" }, "type": "array" }, "screenshot": { "description": "Whether to take a screenshot after the action", "type": "boolean" }, "text": { "description": "Text to type", "type": "string" } }, "required": [ "action", "text" ], "type": "object" }, { "additionalProperties": false, "properties": { "action": { "enum": [ "wait" ], "type": "string" }, "duration": { "description": "Duration to wait in seconds", "type": "number" }, "screenshot": { "description": "Whether to take a screenshot after the action", "type": "boolean" } }, "required": [ "action", "duration" ], "type": "object" }, { "additionalProperties": false, "properties": { "action": { "enum": [ "take_screenshot" ], "type": "string" } }, "required": [ "action" ], "type": "object" }, { "additionalProperties": false, "properties": { "action": { "enum": [ "get_cursor_position" ], "type": "string" } }, "required": [ "action" ], "type": "object" } ], "title": "computerActionRequest" }, "ComputerActionResponse": { "additionalProperties": false, "properties": { "base64_image": { "description": "Base64 encoded screenshot if requested", "type": "string" }, "error": { "description": "Error message if action failed", "type": "string" }, "output": { "description": "Output message from the action", "type": "string" }, "system": { "description": "System information", "type": "string" } }, "title": "computerActionResponse", "type": "object" }, "CreateSessionRequest": { "additionalProperties": false, "description": "Request body schema for creating a new browser session.", "nullable": true, "properties": { "blockAds": { "description": "Block ads in the browser session. Default is false.", "type": "boolean" }, "caCertificates": { "description": "PEM-encoded root CA certificates to trust in this session. THIS IS CURRENTLY AN EXPERIMENTAL FEATURE.", "items": { "type": "string" }, "type": "array" }, "concurrency": { "description": "Number of sessions to create concurrently (check your plan limit)", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "credentials": { "additionalProperties": false, "description": "Configuration for session credentials", "properties": { "autoSubmit": { "type": "boolean" }, "blurFields": { "type": "boolean" }, "exactOrigin": { "type": "boolean" } }, "type": "object" }, "debugConfig": { "additionalProperties": false, "description": "Configuration for the debug URL and session viewer. Controls interaction capabilities, cursor visibility, and other debug-related settings.", "properties": { "interactive": { "default": true, "description": "Allow interaction with the browser session via the debug URL viewer. When false, the session viewer will be view-only. Default is true.", "type": "boolean" }, "systemCursor": { "default": true, "description": "Show the OS-level mouse cursor in the WebRTC stream (headful mode only). When false, the system cursor will not be rendered in the stream. Default is true.", "type": "boolean" } }, "type": "object" }, "deviceConfig": { "additionalProperties": false, "description": "Device configuration for the session. Specify 'mobile' for mobile device fingerprints and configurations.", "properties": { "device": { "default": "desktop", "enum": [ "desktop", "mobile" ], "type": "string" } }, "type": "object" }, "dimensions": { "additionalProperties": false, "description": "Viewport and browser window dimensions for the session. Mobile sessions require dimensions of at least 508x1074; smaller mobile dimensions are rejected with a 400 response.", "properties": { "height": { "description": "Height of the session", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "width": { "description": "Width of the session", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "width", "height" ], "type": "object" }, "experimentalFeatures": { "description": "Enable experimental features for the session.", "items": { "type": "string" }, "type": "array" }, "extensionIds": { "description": "Array of extension IDs to install in the session. Use ['all_ext'] to install all uploaded extensions.", "items": { "type": "string" }, "type": "array" }, "fullscreen": { "description": "Launch the browser in fullscreen mode, covering the full screen with no Chrome UI. Default is false.", "type": "boolean" }, "headless": { "description": "Enable headless browser mode (disable Headful mode)", "type": "boolean" }, "inactivityTimeout": { "description": "Inactivity timeout in milliseconds. When set, the session is released if no CDP command or remote input is received for this duration, even if `timeout` has not yet elapsed. Note that `timeout` remains the hard cap on session lifetime: if `inactivityTimeout` is greater than or equal to the effective `timeout`, it has no effect since `timeout` always elapses first. Omit to disable.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "isSelenium": { "description": "Enable Selenium mode for the browser session (default is false). Use this when you plan to connect to the browser session via Selenium.", "type": "boolean" }, "namespace": { "description": "The namespace the session should be created against. Defaults to \"default\".", "type": "string" }, "optimizeBandwidth": { "anyOf": [ { "type": "boolean" }, { "additionalProperties": false, "properties": { "blockHosts": { "items": { "type": "string" }, "type": "array" }, "blockImages": { "type": "boolean" }, "blockMedia": { "type": "boolean" }, "blockStylesheets": { "type": "boolean" }, "blockUrlPatterns": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } ], "description": "Enable bandwidth optimizations. Passing true enables all flags (except hosts/patterns). Object allows granular control." }, "persistProfile": { "description": "This flag will persist the user profile for the session.", "type": "boolean" }, "profileId": { "description": "This flag will set the profile for the session.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "projectId": { "description": "The project to create the session in. When provided, the session namespace is resolved from the project.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "proxyUrl": { "description": "Custom proxy URL for the browser session. Overrides useProxy, disabling Steel-provided proxies in favor of your specified proxy. Format: http(s)://username:password@hostname:port", "format": "uri", "type": "string" }, "region": { "description": "The desired region for the session. Available: us-east, us-west, us-central, eu-west, eu-central, ap-northeast, ap-southeast, sa-east. Legacy codes (iad, lax, ord) are also accepted." }, "sessionContext": { "additionalProperties": false, "description": "Session context data to be used in the created session. Sessions will start with an empty context by default.", "properties": { "cookies": { "description": "Cookies to initialize in the session", "items": { "additionalProperties": false, "properties": { "domain": { "description": "The domain of the cookie", "type": "string" }, "expires": { "description": "The expiration date of the cookie", "type": "number" }, "httpOnly": { "description": "Whether the cookie is HTTP only", "type": "boolean" }, "name": { "description": "The name of the cookie", "type": "string" }, "partitionKey": { "additionalProperties": false, "description": "The partition key of the cookie", "properties": { "hasCrossSiteAncestor": { "description": "Indicates if the cookie has any ancestors that are cross-site to the topLevelSite.", "type": "boolean" }, "topLevelSite": { "description": "The site of the top-level URL the browser was visiting at the start of the request to the endpoint that set the cookie.", "type": "string" } }, "required": [ "topLevelSite", "hasCrossSiteAncestor" ], "type": "object" }, "path": { "description": "The path of the cookie", "type": "string" }, "priority": { "description": "The priority of the cookie", "enum": [ "Low", "Medium", "High" ], "type": "string" }, "sameParty": { "description": "Whether the cookie is a same party cookie", "type": "boolean" }, "sameSite": { "description": "The same site attribute of the cookie", "enum": [ "Strict", "Lax", "None" ], "type": "string" }, "secure": { "description": "Whether the cookie is secure", "type": "boolean" }, "session": { "description": "Whether the cookie is a session cookie", "type": "boolean" }, "size": { "description": "The size of the cookie", "type": "number" }, "sourcePort": { "description": "The source port of the cookie", "type": "number" }, "sourceScheme": { "description": "The source scheme of the cookie", "enum": [ "Unset", "NonSecure", "Secure" ], "type": "string" }, "url": { "description": "The URL of the cookie", "type": "string" }, "value": { "description": "The value of the cookie", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "indexedDB": { "additionalProperties": { "items": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "records": { "items": { "additionalProperties": false, "properties": { "blobFiles": { "items": { "additionalProperties": false, "properties": { "blobNumber": { "type": "number" }, "filename": { "type": "string" }, "lastModified": { "format": "date-time", "type": "string" }, "mimeType": { "type": "string" }, "path": { "type": "string" }, "size": { "type": "number" } }, "required": [ "blobNumber", "mimeType", "size" ], "type": "object" }, "type": "array" }, "key": {}, "value": {} }, "required": [ "key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "id", "name", "records" ], "type": "object" }, "type": "array" }, "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "name", "data" ], "type": "object" }, "type": "array" }, "description": "Domain-specific indexedDB items to initialize in the session", "type": "object" }, "localStorage": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "description": "Domain-specific localStorage items to initialize in the session", "type": "object" }, "sessionStorage": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "description": "Domain-specific sessionStorage items to initialize in the session", "type": "object" } }, "type": "object" }, "sessionId": { "description": "Optional custom UUID for the session", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "solveCaptcha": { "description": "Enable automatic captcha solving. Default is false.", "type": "boolean" }, "stealthConfig": { "additionalProperties": false, "description": "Stealth configuration for the session", "properties": { "autoCaptchaSolving": { "description": "When true, captchas will be automatically solved when detected. When false, use the solve endpoints to manually initiate solving.", "type": "boolean" }, "humanizeInteractions": { "description": "This flag will make the browser act more human-like by moving the mouse in a more natural way.", "type": "boolean" }, "skipFingerprintInjection": { "description": "This flag will skip the fingerprint generation for the session.", "type": "boolean" } }, "type": "object" }, "timeout": { "description": "Session timeout duration in milliseconds. Default is 300000 (5 minutes).", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "useProxy": { "anyOf": [ { "anyOf": [ { "description": "Simple boolean to enable/disable Steel proxies", "type": "boolean" }, { "anyOf": [ { "additionalProperties": false, "properties": { "geolocation": { "additionalProperties": false, "description": "Geographic location for the proxy", "properties": { "city": { "description": "City name (e.g., 'NEW_YORK', 'LOS_ANGELES')", "enum": [ "A_CORUNA", "ABIDJAN", "ABU_DHABI", "ABUJA", "ACAPULCO_DE JUAREZ", "ACCRA", "ADANA", "ADAPAZARI", "ADDIS_ABABA", "ADELAIDE", "AFYONKARAHISAR", "AGADIR", "AGUAS_LINDAS DE GOIAS", "AGUASCALIENTES", "AHMEDABAD", "AIZAWL", "AJMAN", "AKRON", "AKSARAY", "AL_AIN CITY", "AL_MANSURAH", "AL_QATIF", "ALAJUELA", "ALBANY", "ALBUQUERQUE", "ALEXANDRIA", "ALGIERS", "ALICANTE", "ALMADA", "ALMATY", "ALMERE_STAD", "ALVORADA", "AMADORA", "AMASYA", "AMBATO", "AMERICANA", "AMMAN", "AMSTERDAM", "ANANINDEUA", "ANAPOLIS", "ANGELES_CITY", "ANGERS", "ANGRA_DOS REIS", "ANKARA", "ANTAKYA", "ANTALYA", "ANTANANARIVO", "ANTIPOLO_CITY", "ANTOFAGASTA", "ANTWERP", "APARECIDA_DE GOIANIA", "APODACA", "ARACAJU", "ARACATUBA", "ARAD", "ARAGUAINA", "ARAPIRACA", "ARARAQUARA", "AREQUIPA", "ARICA", "ARLINGTON", "ARYANAH", "ASTANA", "ASUNCION", "ASYUT", "ATAKUM", "ATHENS", "ATIBAIA", "ATLANTA", "AUBURN", "AUCKLAND", "AURORA", "AUSTIN", "AVELLANEDA", "AYDIN", "AZCAPOTZALCO", "BACOLOD_CITY", "BACOOR", "BAGHDAD", "BAGUIO_CITY", "BAHIA_BLANCA", "BAKERSFIELD", "BAKU", "BALIKESIR", "BALIKPAPAN", "BALNEARIO_CAMBORIU", "BALTIMORE", "BANDAR_LAMPUNG", "BANDAR_SERI BEGAWAN", "BANDUNG", "BANGKOK", "BANJA_LUKA", "BANJARMASIN", "BARCELONA", "BARI", "BARQUISIMETO", "BARRA_MANSA", "BARRANQUILLA", "BARUERI", "BATAM", "BATANGAS", "BATMAN", "BATNA_CITY", "BATON_ROUGE", "BATUMI", "BAURU", "BEIRUT", "BEJAIA", "BEKASI", "BELEM", "BELFAST", "BELFORD_ROXO", "BELGRADE", "BELO_HORIZONTE", "BENGALURU", "BENI_MELLAL", "BERAZATEGUI", "BERN", "BETIM", "BHARATPUR", "BHOPAL", "BHUBANESWAR", "BIALYSTOK", "BIEN_HOA", "BILBAO", "BILECIK", "BIRATNAGAR", "BIRMINGHAM", "BISHKEK", "BIZERTE", "BLIDA", "BLOEMFONTEIN", "BLOOMINGTON", "BLUMENAU", "BOA_VISTA", "BOCHUM", "BOGOR", "BOGOTA", "BOISE", "BOKSBURG", "BOLOGNA", "BOLU", "BORDEAUX", "BOSTON", "BOTUCATU", "BRADFORD", "BRAGA", "BRAGANCA_PAULISTA", "BRAMPTON", "BRASILIA", "BRASOV", "BRATISLAVA", "BREMEN", "BRESCIA", "BREST", "BRIDGETOWN", "BRISBANE", "BRISTOL", "BRNO", "BROOKLYN", "BRUSSELS", "BUCARAMANGA", "BUCHAREST", "BUDAPEST", "BUENOS_AIRES", "BUFFALO", "BUK_GU", "BUKHARA", "BURGAS", "BURNABY", "BURSA", "BUTUAN", "BYDGOSZCZ", "CABANATUAN_CITY", "CABO_FRIO", "CABUYAO", "CACHOEIRO_DE ITAPEMIRIM", "CAGAYAN_DE ORO", "CAGLIARI", "CAIRO", "CALAMBA", "CALGARY", "CALOOCAN_CITY", "CAMACARI", "CAMARAGIBE", "CAMPECHE", "CAMPINA_GRANDE", "CAMPINAS", "CAMPO_GRANDE", "CAMPO_LARGO", "CAMPOS_DOS GOYTACAZES", "CAN_THO", "CANOAS", "CANTON", "CAPE_TOWN", "CARACAS", "CARAGUATATUBA", "CARAPICUIBA", "CARDIFF", "CARIACICA", "CARMONA", "CARTAGENA", "CARUARU", "CASABLANCA", "CASCAVEL", "CASEROS", "CASTANHAL", "CASTRIES", "CATALAO", "CATAMARCA", "CATANDUVA", "CATANIA", "CAUCAIA", "CAXIAS_DO SUL", "CEBU_CITY", "CENTRAL", "CENTRO", "CENTURION", "CHAGUANAS", "CHANDIGARH", "CHANDLER", "CHANG_HUA", "CHAPECO", "CHARLESTON", "CHARLOTTE", "CHELYABINSK", "CHENNAI", "CHERKASY", "CHERNIVTSI", "CHIA", "CHIANG_MAI", "CHICLAYO", "CHIHUAHUA_CITY", "CHIMBOTE", "CHISINAU", "CHITTAGONG", "CHRISTCHURCH", "CINCINNATI", "CIREBON", "CITY_OF MUNTINLUPA", "CIUDAD_DEL ESTE", "CIUDAD_GUAYANA", "CIUDAD_JUAREZ", "CIUDAD_NEZAHUALCOYOTL", "CIUDAD_OBREGON", "CLEVELAND", "CLUJ_NAPOCA", "COCHABAMBA", "COIMBATORE", "COIMBRA", "COLOGNE", "COLOMBO", "COLORADO_SPRINGS", "COLUMBIA", "COLUMBUS", "COMODORO_RIVADAVIA", "CONCEPCION", "CONCORD", "CONSTANTA", "CONSTANTINE", "CONTAGEM", "COPENHAGEN", "CORDOBA", "CORRIENTES", "CORUM", "COTIA", "COVENTRY", "CRAIOVA", "CRICIUMA", "CROYDON", "CUAUTITLAN_IZCALLI", "CUCUTA", "CUENCA", "CUERNAVACA", "CUIABA", "CULIACAN", "CURITIBA", "CUSCO", "DA_NANG", "DAGUPAN", "DAKAR", "DALLAS", "DAMIETTA", "DAMMAM", "DAR_ES SALAAM", "DASMARINAS", "DAVAO_CITY", "DAYTON", "DEBRECEN", "DECATUR", "DEHRADUN", "DELHI", "DENIZLI", "DENPASAR", "DENVER", "DEPOK", "DERBY", "DETROIT", "DHAKA", "DIADEMA", "DIVINOPOLIS", "DIYARBAKIR", "DJELFA", "DNIPRO", "DOHA", "DORTMUND", "DOURADOS", "DRESDEN", "DUBAI", "DUBLIN", "DUEZCE", "DUISBURG", "DUQUE_DE CAXIAS", "DURANGO", "DURBAN", "DUSSELDORF", "ECATEPEC", "EDINBURGH", "EDIRNE", "EDMONTON", "EL_JADIDA", "EL_PASO", "ELAZIG", "EMBU", "ENSENADA", "ERBIL", "ERZURUM", "ESKISEHIR", "ESPOO", "ESSEN", "FAISALABAD", "FAYETTEVILLE", "FAZENDA_RIO GRANDE", "FEIRA_DE SANTANA", "FES", "FLORENCE", "FLORENCIO_VARELA", "FLORIANOPOLIS", "FONTANA", "FORMOSA", "FORT_LAUDERDALE", "FORT_WAYNE", "FORT_WORTH", "FORTALEZA", "FOZ_DO IGUACU", "FRANCA", "FRANCISCO_MORATO", "FRANCO_DA ROCHA", "FRANKFURT_AM MAIN", "FREDERICKSBURG", "FRESNO", "FUNCHAL", "GABORONE", "GAINESVILLE", "GALATI", "GANGNAM_GU", "GARANHUNS", "GATINEAU", "GAZIANTEP", "GDANSK", "GDYNIA", "GENERAL_TRIAS", "GENEVA", "GENOA", "GEORGE_TOWN", "GEORGETOWN", "GHAZIABAD", "GHENT", "GIJON", "GIRESUN", "GIZA", "GLASGOW", "GLENDALE", "GLIWICE", "GOIANIA", "GOMEL", "GOTHENBURG", "GOVERNADOR_VALADARES", "GOYANG_SI", "GRANADA", "GRAND_RAPIDS", "GRAVATAI", "GRAZ", "GREENSBORO", "GREENVILLE", "GUADALAJARA", "GUADALUPE", "GUANGZHOU", "GUARAPUAVA", "GUARATINGUETA", "GUARUJA", "GUARULHOS", "GUATEMALA_CITY", "GUAYAQUIL", "GUJRANWALA", "GURUGRAM", "GUSTAVO_ADOLFO MADERO", "GUWAHATI", "GWANAK_GU", "HACKNEY", "HAIFA", "HAIPHONG", "HAMBURG", "HAMILTON", "HANOI", "HANOVER", "HARARE", "HAVANA", "HELSINKI", "HENDERSON", "HEREDIA", "HERMOSILLO", "HIALEAH", "HO_CHI MINH CITY", "HOLLYWOOD", "HOLON", "HONOLULU", "HORTOLANDIA", "HRODNA", "HSINCHU", "HUANCAYO", "HUANUCO", "HULL", "HURLINGHAM", "HYDERABAD", "IASI", "IBAGUE", "ICA", "ILAM", "ILFORD", "ILIGAN", "ILOILO_CITY", "IMPERATRIZ", "IMUS", "INCHEON", "INDAIATUBA", "INDIANAPOLIS", "INDORE", "IPATINGA", "IPOH", "IQUIQUE", "IRVINE", "ISIDRO_CASANOVA", "ISLAMABAD", "ISLINGTON", "ISMAILIA", "ISPARTA", "ISTANBUL", "ITABORAI", "ITABUNA", "ITAJAI", "ITANHAEM", "ITAPEVI", "ITAQUAQUECETUBA", "ITUZAINGO", "IZMIR", "IZTAPALAPA", "JABOATAO_DOS GUARARAPES", "JACAREI", "JACKSON", "JACKSONVILLE", "JAIPUR", "JAKARTA", "JARAGUA_DO SUL", "JAU", "JEDDAH", "JEMBER", "JERUSALEM", "JOAO_MONLEVADE", "JOAO_PESSOA", "JODHPUR", "JOHANNESBURG", "JOHOR_BAHRU", "JOINVILLE", "JOSE_C PAZ", "JOSE_MARIA EZEIZA", "JUAREZ", "JUAZEIRO_DO NORTE", "JUIZ_DE FORA", "JUNDIAI", "KAHRAMANMARAS", "KAMPALA", "KANPUR", "KANSAS_CITY", "KAOHSIUNG_CITY", "KARABUK", "KARACHI", "KARLSRUHE", "KARNAL", "KASKI", "KASTAMONU", "KATHMANDU", "KATOWICE", "KATSINA", "KATY", "KAUNAS", "KAYSERI", "KAZAN", "KECSKEMET", "KEDIRI", "KENITRA", "KHARKIV", "KHMELNYTSKYI", "KHON_KAEN", "KIELCE", "KIGALI", "KINGSTON", "KIRKLARELI", "KISSIMMEE", "KITCHENER", "KLAIPEDA", "KNOXVILLE", "KOCHI", "KOLKATA", "KOLLAM", "KONYA", "KOSEKOY", "KOSICE", "KOTA_KINABALU", "KOZHIKODE", "KRAKOW", "KRASNODAR", "KRYVYI_RIH", "KUALA_LUMPUR", "KUCHING", "KUTAHYA", "KUTAISI", "KUWAIT_CITY", "KYIV", "LA_PAZ", "LA_PLATA", "LA_RIOJA", "LA_SERENA", "LAFAYETTE", "LAFERRERE", "LAGES", "LAGOS", "LAHORE", "LAHUG", "LAKE_WORTH", "LAKELAND", "LANCASTER", "LANUS", "LAS_PALMAS DE GRAN CANARIA", "LAS_PINAS", "LAS_VEGAS", "LAUSANNE", "LAVAL", "LAWRENCEVILLE", "LE_MANS", "LEEDS", "LEICESTER", "LEIPZIG", "LEON", "LEXINGTON", "LIBREVILLE", "LIEGE", "LILLE", "LIMA", "LIMASSOL", "LIMEIRA", "LINCOLN", "LINHARES", "LIPA_CITY", "LISBON", "LIVERPOOL", "LJUBLJANA", "LODZ", "LOJA", "LOMAS_DE ZAMORA", "LOME", "LONDRINA", "LONG_BEACH", "LONGUEUIL", "LOUISVILLE", "LUANDA", "LUBLIN", "LUCENA_CITY", "LUCKNOW", "LUDHIANA", "LUSAKA", "LUXEMBOURG", "LUZIANIA", "LVIV", "LYON", "MABALACAT", "MACAE", "MACAO", "MACAPA", "MACEIO", "MACHALA", "MADISON", "MADRID", "MAGE", "MAGELANG", "MAGNESIA_AD SIPYLUM", "MAKASSAR", "MAKATI_CITY", "MALABON", "MALAGA", "MALANG", "MALAPPURAM", "MALDONADO", "MALE", "MALMO", "MANADO", "MANAGUA", "MANAMA", "MANAUS", "MANCHESTER", "MANDALUYONG_CITY", "MANILA", "MANIZALES", "MANNHEIM", "MAPUTO", "MAR_DEL PLATA", "MARABA", "MARACAIBO", "MARACANAU", "MARACAY", "MARDIN", "MARIBOR", "MARICA", "MARIETTA", "MARIKINA_CITY", "MARILIA", "MARINGA", "MARRAKESH", "MARSEILLE", "MAUA", "MAZATLAN", "MEDAN", "MEDELLIN", "MEDINA", "MEERUT", "MEKNES", "MELBOURNE", "MEMPHIS", "MENDOZA", "MERIDA", "MERKEZ", "MERLO", "MERSIN", "MESA", "MEXICALI", "MEXICO_CITY", "MILAN", "MILTON_KEYNES", "MILWAUKEE", "MINNEAPOLIS", "MINSK", "MISKOLC", "MISSISSAUGA", "MOGI_DAS CRUZES", "MOHALI", "MONROE", "MONTE_GRANDE", "MONTEGO_BAY", "MONTERREY", "MONTES_CLAROS", "MONTEVIDEO", "MONTGOMERY", "MONTPELLIER", "MONTREAL", "MORELIA", "MORENO", "MORON", "MOSSORO", "MUGLA", "MULTAN", "MUMBAI", "MUNICH", "MURCIA", "MUSCAT", "MUZAFFARGARH", "MYKOLAYIV", "NAALDWIJK", "NAGA", "NAGPUR", "NAIROBI", "NANTES", "NAPLES", "NASHVILLE", "NASSAU", "NASUGBU", "NATAL", "NAUCALPAN", "NAVI_MUMBAI", "NEIVA", "NEUQUEN", "NEVSEHIR", "NEW_DELHI", "NEW_ORLEANS", "NEW_TAIPEI", "NEWARK", "NEWCASTLE_UPON TYNE", "NHA_TRANG", "NICE", "NICOSIA", "NILOPOLIS", "NIS", "NITEROI", "NITRA", "NIZHNIY_NOVGOROD", "NOGALES", "NOIDA", "NORTHAMPTON", "NORWICH", "NOTTINGHAM", "NOVA_FRIBURGO", "NOVA_IGUACU", "NOVI_SAD", "NOVO_HAMBURGO", "NOVOSIBIRSK", "NUREMBERG", "OAKLAND", "OAXACA_CITY", "ODESA", "OKLAHOMA_CITY", "OLINDA", "OLOMOUC", "OLONGAPO_CITY", "OLSZTYN", "OMAHA", "ORADEA", "ORAN", "ORDU", "ORLANDO", "OSASCO", "OSLO", "OSMANIYE", "OSTRAVA", "OTTAWA", "OUJDA", "OURINHOS", "PACHUCA", "PADOVA", "PALAKKAD", "PALEMBANG", "PALERMO", "PALHOCA", "PALMA", "PALMAS", "PANAMA_CITY", "PARAMARIBO", "PARANA", "PARANAGUA", "PARANAQUE_CITY", "PARAUAPEBAS", "PARIS", "PARNAIBA", "PARNAMIRIM", "PASSO_FUNDO", "PASTO", "PATAN", "PATNA", "PATOS_DE MINAS", "PAULISTA", "PECS", "PEKANBARU", "PELOTAS", "PEORIA", "PEREIRA", "PERM", "PERTH", "PESCARA", "PESHAWAR", "PETAH_TIKVA", "PETALING_JAYA", "PETROLINA", "PETROPOLIS", "PHILADELPHIA", "PHNOM_PENH", "PHOENIX", "PILAR", "PINDAMONHANGABA", "PIRACICABA", "PITESTI", "PITTSBURGH", "PIURA", "PLANO", "PLOIESTI", "PLOVDIV", "PLYMOUTH", "POCOS_DE CALDAS", "PODGORICA", "POLTAVA", "PONTA_GROSSA", "PONTIANAK", "POPAYAN", "PORT_AU PRINCE", "PORT_ELIZABETH", "PORT_HARCOURT", "PORT_LOUIS", "PORT_MONTT", "PORT_OF SPAIN", "PORT_SAID", "PORTLAND", "PORTO", "PORTO_ALEGRE", "PORTO_SEGURO", "PORTO_VELHO", "PORTOVIEJO", "POSADAS", "POUSO_ALEGRE", "POZNAN", "PRAGUE", "PRAIA_GRANDE", "PRESIDENTE_PRUDENTE", "PRETORIA", "PRISTINA", "PROVIDENCE", "PUCALLPA", "PUCHONG_BATU DUA BELAS", "PUEBLA_CITY", "PUNE", "QUEBEC", "QUEENS", "QUEIMADOS", "QUERETARO_CITY", "QUEZON_CITY", "QUILMES", "QUITO", "RABAT", "RAIPUR", "RAJKOT", "RAJSHAHI", "RALEIGH", "RAMAT_GAN", "RANCAGUA", "RANCHI", "RAS_AL KHAIMAH", "RAWALPINDI", "READING", "RECIFE", "REGINA", "RENNES", "RENO", "RESISTENCIA", "REYKJAVIK", "REYNOSA", "RIBEIRAO_DAS NEVES", "RIBEIRAO_PRETO", "RICHMOND", "RIGA", "RIO_BRANCO", "RIO_CLARO", "RIO_CUARTO", "RIO_DE JANEIRO", "RIO_DO SUL", "RIO_GALLEGOS", "RIO_GRANDE", "RISHON_LETSIYYON", "RIVERSIDE", "RIYADH", "RIZE", "ROCHESTER", "ROME", "RONDONOPOLIS", "ROSARIO", "ROSEAU", "ROSTOV_ON DON", "ROTTERDAM", "ROUEN", "ROUSSE", "RZESZOW", "SACRAMENTO", "SAGAR", "SAINT_PAUL", "SALE", "SALT_LAKE CITY", "SALTA", "SALTILLO", "SALVADOR", "SAMARA", "SAMARINDA", "SAMARKAND", "SAMSUN", "SAN_ANTONIO", "SAN_DIEGO", "SAN_FERNANDO", "SAN_FRANCISCO", "SAN_JOSE", "SAN_JOSE DEL MONTE", "SAN_JUAN", "SAN_JUSTO", "SAN_LUIS", "SAN_LUIS POTOSI CITY", "SAN_MIGUEL", "SAN_MIGUEL DE TUCUMAN", "SAN_PABLO CITY", "SAN_PEDRO", "SAN_PEDRO SULA", "SAN_SALVADOR", "SAN_SALVADOR DE JUJUY", "SANAA", "SANLIURFA", "SANTA_CRUZ", "SANTA_CRUZ DE TENERIFE", "SANTA_CRUZ DO SUL", "SANTA_FE", "SANTA_LUZIA", "SANTA_MARIA", "SANTA_MARTA", "SANTA_ROSA", "SANTAREM", "SANTIAGO", "SANTIAGO_DE CALI", "SANTIAGO_DE LOS CABALLEROS", "SANTO_ANDRE", "SANTO_DOMINGO", "SANTO_DOMINGO ESTE", "SANTOS", "SAO_BERNARDO DO CAMPO", "SAO_CARLOS", "SAO_GONCALO", "SAO_JOAO DE MERITI", "SAO_JOSE", "SAO_JOSE DO RIO PRETO", "SAO_JOSE DOS CAMPOS", "SAO_JOSE DOS PINHAIS", "SAO_LEOPOLDO", "SAO_LUIS", "SAO_PAULO", "SAO_VICENTE", "SARAJEVO", "SASKATOON", "SCARBOROUGH", "SEATTLE", "SEMARANG", "SEO_GU", "SEONGNAM_SI", "SEOUL", "SERRA", "SETE_LAGOAS", "SETIF", "SETUBAL", "SEVILLE", "SFAX", "SHAH_ALAM", "SHANGHAI", "SHARJAH", "SHEFFIELD", "SHENZHEN", "SHIMLA", "SIAULIAI", "SIBIU", "SIDOARJO", "SIKAR", "SILVER_SPRING", "SINOP", "SIVAS", "SKIKDA", "SKOPJE", "SLOUGH", "SOBRAL", "SOFIA", "SOROCABA", "SOUSSE", "SOUTH_TANGERANG", "SOUTHAMPTON", "SOUTHWARK", "SPLIT", "SPOKANE", "SPRING", "SPRINGFIELD", "ST_LOUIS", "ST_PETERSBURG", "STARA_ZAGORA", "STATEN_ISLAND", "STOCKHOLM", "STOCKTON", "STOKE_ON TRENT", "STRASBOURG", "STUTTGART", "SUMARE", "SURABAYA", "SURAKARTA", "SURAT", "SURREY", "SUWON", "SUZANO", "SYDNEY", "SZCZECIN", "SZEGED", "SZEKESFEHERVAR", "TABOAO_DA SERRA", "TACNA", "TACOMA", "TAGUIG", "TAICHUNG", "TAINAN_CITY", "TAIPEI", "TALAVERA", "TALCA", "TALLAHASSEE", "TALLINN", "TAMPA", "TAMPERE", "TAMPICO", "TANGERANG", "TANGIER", "TANTA", "TANZA", "TAOYUAN_DISTRICT", "TAPPAHANNOCK", "TARLAC_CITY", "TASHKENT", "TASIKMALAYA", "TATUI", "TAUBATE", "TBILISI", "TEGUCIGALPA", "TEHRAN", "TEIXEIRA_DE FREITAS", "TEKIRDAG", "TEL_AVIV", "TEMUCO", "TEPIC", "TERESINA", "TERNOPIL", "TERRASSA", "TETOUAN", "THANE", "THE_BRONX", "THE_HAGUE", "THESSALONIKI", "THIRUVANANTHAPURAM", "THRISSUR", "TIJUANA", "TIMISOARA", "TIRANA", "TLALNEPANTLA", "TLAXCALA_CITY", "TLEMCEN", "TOKAT_PROVINCE", "TOKYO", "TOLUCA", "TORONTO", "TORREON", "TOULOUSE", "TRABZON", "TRUJILLO", "TUBARAO", "TUCSON", "TUGUEGARAO_CITY", "TULSA", "TUNIS", "TUNJA", "TURIN", "TUXTLA_GUTIERREZ", "TUZLA", "UBERABA", "UBERLANDIA", "UFA", "ULAN_BATOR", "UMEDA", "URDANETA", "USAK", "VADODARA", "VALENCIA", "VALINHOS", "VALLADOLID", "VALLEDUPAR", "VALPARAISO", "VALPARAISO_DE GOIAS", "VAN", "VANCOUVER", "VARANASI", "VARGINHA", "VARNA", "VARZEA_PAULISTA", "VENUSTIANO_CARRANZA", "VERACRUZ", "VERONA", "VIAMAO", "VICTORIA", "VIENNA", "VIENTIANE", "VIGO", "VIJAYAWADA", "VILA_NOVA DE GAIA", "VILA_VELHA", "VILLA_BALLESTER", "VILLAVICENCIO", "VILNIUS", "VINA_DEL MAR", "VINNYTSIA", "VIRGINIA_BEACH", "VISAKHAPATNAM", "VITORIA", "VITORIA_DA CONQUISTA", "VITORIA_DE SANTO ANTAO", "VOLTA_REDONDA", "VORONEZH", "WARSAW", "WASHINGTON", "WELLINGTON", "WEST_PALM BEACH", "WICHITA", "WILLEMSTAD", "WILMINGTON", "WINDHOEK", "WINDSOR", "WINNIPEG", "WOLVERHAMPTON", "WOODBRIDGE", "WROCLAW", "WUPPERTAL", "XALAPA", "YALOVA", "YANGON", "YEKATERINBURG", "YEREVAN", "YOGYAKARTA", "YOKOHAMA", "YONGIN_SI", "ZABRZE", "ZAGAZIG", "ZAGREB", "ZAMBOANGA_CITY", "ZAPOPAN", "ZAPORIZHZHYA", "ZARAGOZA", "ZHONGLI_DISTRICT", "ZIELONA_GORA", "ZONGULDAK", "ZURICH" ], "type": "string" }, "country": { "description": "Country code (e.g., 'US', 'GB', 'DE') - ISO 3166-1 alpha-2", "enum": [ "US", "CA", "MX", "GB", "DE", "FR", "IT", "ES", "PL", "NL", "SE", "NO", "DK", "FI", "CH", "AT", "BE", "IE", "PT", "GR", "CZ", "HU", "RO", "BG", "SK", "SI", "HR", "EE", "LV", "LT", "LU", "MT", "CY", "IS", "LI", "MC", "SM", "VA", "JP", "KR", "CN", "HK", "TW", "SG", "AU", "NZ", "IN", "TH", "MY", "PH", "ID", "VN", "AF", "BD", "BN", "KH", "LA", "LK", "MM", "NP", "PK", "FJ", "PG", "AE", "SA", "IL", "TR", "IR", "IQ", "JO", "KW", "LB", "OM", "QA", "BH", "YE", "SY", "ZA", "EG", "MA", "NG", "KE", "DZ", "AO", "BW", "ET", "GH", "CI", "LY", "MZ", "RW", "SN", "TN", "UG", "ZM", "ZW", "TZ", "MU", "SC", "BR", "AR", "CL", "CO", "PE", "VE", "EC", "UY", "PY", "BO", "CR", "CU", "DO", "GT", "HN", "JM", "NI", "PA", "SV", "TT", "BB", "BZ", "GY", "SR", "RU", "UA", "BY", "KZ", "UZ", "AZ", "GE", "AM", "MD", "MK", "AL", "BA", "RS", "ME", "XK", "MN", "KG", "TJ", "TM" ], "type": "string" }, "state": { "description": "State code (e.g., 'NY', 'CA') - US states only", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "DC", "PR", "GU", "VI" ], "type": "string" } }, "required": [ "country" ], "type": "object" } }, "required": [ "geolocation" ], "type": "object" }, { "additionalProperties": false, "properties": { "server": { "description": "Proxy server URL", "type": "string" } }, "required": [ "server" ], "type": "object" }, { "additionalProperties": false, "properties": { "id": { "description": "Specific fixed IP identifier. Omit to use any active fixed IP owned by the org.", "pattern": "^fixed:[A-Za-z0-9_-]{6,64}$", "type": "string" }, "type": { "description": "Use Steel fixed IP proxies", "enum": [ "fixed" ], "type": "string" } }, "required": [ "type" ], "type": "object" } ], "description": "Array of proxy configurations with routing" } ], "description": "Proxy configuration for the session. Can be a boolean or array of proxy configurations" }, {} ] }, "userAgent": { "description": "Custom user agent string for the browser session", "type": "string" } }, "title": "createSessionRequest", "type": "object" }, "Credential": { "additionalProperties": false, "properties": { "createdAt": { "description": "Date and time the credential was created", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "label": { "description": "Label for the credential", "type": "string" }, "namespace": { "default": "default", "description": "The namespace the credential is stored against. Defaults to \"default\".", "type": "string" }, "origin": { "default": "default", "description": "Website origin the credential is for", "type": "string" }, "updatedAt": { "description": "Date and time the credential was last updated", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "value": { "additionalProperties": { "type": "string" }, "description": "Value for the credential", "type": "object" } }, "required": [ "value", "createdAt", "updatedAt" ], "title": "credential", "type": "object" }, "CredentialCreate": { "additionalProperties": false, "properties": { "label": { "description": "Label for the credential", "type": "string" }, "namespace": { "default": "default", "description": "The namespace the credential is stored against. Defaults to \"default\".", "type": "string" }, "origin": { "default": "default", "description": "Website origin the credential is for", "type": "string" }, "projectId": { "description": "Project to store the credential in.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "value": { "additionalProperties": { "type": "string" }, "description": "Value for the credential", "type": "object" } }, "required": [ "value" ], "title": "credentialCreate", "type": "object" }, "CredentialList": { "additionalProperties": false, "properties": { "credentials": { "items": { "additionalProperties": false, "properties": { "createdAt": { "description": "Date and time the credential was created", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "label": { "description": "Label for the credential", "type": "string" }, "namespace": { "default": "default", "description": "The namespace the credential is stored against. Defaults to \"default\".", "type": "string" }, "origin": { "default": "default", "description": "Website origin the credential is for", "type": "string" }, "updatedAt": { "description": "Date and time the credential was last updated", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" } }, "required": [ "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "credentials" ], "title": "credentialList", "type": "object" }, "CredentialMetadata": { "additionalProperties": false, "properties": { "createdAt": { "description": "Date and time the credential was created", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "label": { "description": "Label for the credential", "type": "string" }, "namespace": { "default": "default", "description": "The namespace the credential is stored against. Defaults to \"default\".", "type": "string" }, "origin": { "default": "default", "description": "Website origin the credential is for", "type": "string" }, "updatedAt": { "description": "Date and time the credential was last updated", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" } }, "required": [ "createdAt", "updatedAt" ], "title": "credentialMetadata", "type": "object" }, "CredentialNamespaceOrigin": { "additionalProperties": false, "properties": { "namespace": { "default": "default", "description": "The namespace the credential is stored against. Defaults to \"default\".", "type": "string" }, "origin": { "description": "Website origin the credential is for", "type": "string" }, "projectId": { "description": "Project to delete the credential from.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } }, "required": [ "origin" ], "title": "credentialNamespaceOrigin", "type": "object" }, "CredentialUpdate": { "additionalProperties": false, "properties": { "label": { "description": "Label for the credential", "type": "string" }, "namespace": { "description": "The namespace the credential is stored against. Defaults to \"default\".", "type": "string" }, "origin": { "description": "Website origin the credential is for", "type": "string" }, "projectId": { "description": "Project to update the credential in.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "value": { "additionalProperties": { "type": "string" }, "description": "Value for the credential", "type": "object" } }, "title": "credentialUpdate", "type": "object" }, "DeleteResponse": { "additionalProperties": false, "properties": { "message": { "type": "string" } }, "required": [ "message" ], "title": "deleteResponse", "type": "object" }, "DetailsResponse": { "additionalProperties": false, "properties": { "plan": { "type": "string" } }, "required": [ "plan" ], "title": "detailsResponse", "type": "object" }, "ErrorResponse": { "additionalProperties": false, "description": "An error response from the API", "properties": { "context": { "items": { "additionalProperties": false, "properties": { "keyword": { "type": "string" }, "message": { "type": "string" }, "params": {} }, "required": [ "keyword", "params", "message" ], "type": "object" }, "type": "array" }, "error": { "type": "string" }, "linkToDocs": { "format": "uri", "type": "string" }, "message": { "type": "string" } }, "required": [ "message" ], "title": "errorResponse", "type": "object" }, "Extension": { "additionalProperties": false, "properties": { "createdAt": { "description": "Creation timestamp", "type": "string" }, "id": { "description": "Unique extension identifier (e.g., ext_12345)", "type": "string" }, "name": { "description": "Extension name", "type": "string" }, "updatedAt": { "description": "Last update timestamp", "type": "string" } }, "required": [ "id", "name", "createdAt", "updatedAt" ], "title": "extension", "type": "object" }, "ExtensionList": { "additionalProperties": false, "description": "Response containing a list of extensions for the organization", "properties": { "count": { "description": "Total number of extensions", "type": "number" }, "extensions": { "description": "List of extensions for the organization", "items": { "additionalProperties": false, "properties": { "createdAt": { "description": "Creation timestamp", "type": "string" }, "id": { "description": "Unique extension identifier (e.g., ext_12345)", "type": "string" }, "name": { "description": "Extension name", "type": "string" }, "updatedAt": { "description": "Last update timestamp", "type": "string" } }, "required": [ "id", "name", "createdAt", "updatedAt" ], "type": "object" }, "type": "array" } }, "required": [ "extensions", "count" ], "title": "extensionList", "type": "object" }, "ExtensionUploadResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "Creation timestamp", "type": "string" }, "id": { "description": "Unique extension identifier (e.g., ext_12345)", "type": "string" }, "name": { "description": "Extension name", "type": "string" }, "updatedAt": { "description": "Last update timestamp", "type": "string" } }, "required": [ "id", "name", "createdAt", "updatedAt" ], "title": "extensionUploadResponse", "type": "object" }, "FileDetails": { "additionalProperties": false, "properties": { "lastModified": { "description": "Timestamp when the file was created", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "path": { "description": "Path to the file in the storage system", "type": "string" }, "size": { "description": "Size of the file in bytes", "type": "number" } }, "required": [ "path", "size", "lastModified" ], "title": "fileDetails", "type": "object" }, "FileUploadRequest": { "additionalProperties": false, "properties": { "file": { "contentEncoding": "binary", "description": "The file to upload (binary) or URL string to download from", "format": "binary", "type": "string" }, "path": { "description": "Path to the file in the storage system", "type": "string" } }, "required": [ "file" ], "title": "fileUploadRequest", "type": "object" }, "GetSessionAgentLogsResponse": { "additionalProperties": false, "properties": { "events": { "items": { "additionalProperties": {}, "type": "object" }, "type": "array" }, "hasMore": { "type": "boolean" }, "total": { "type": "number" } }, "required": [ "events", "total", "hasMore" ], "title": "getSessionAgentLogsResponse", "type": "object" }, "GetSessionAgentTracesResponse": { "additionalProperties": false, "properties": { "events": { "items": { "additionalProperties": {}, "type": "object" }, "type": "array" }, "hasMore": { "type": "boolean" }, "total": { "type": "number" } }, "required": [ "events", "total", "hasMore" ], "title": "getSessionAgentTracesResponse", "type": "object" }, "GetSessionEventsResponse": { "description": "Events for a browser session", "items": {}, "title": "getSessionEventsResponse", "type": "array" }, "GetSessionLogsResponse": { "additionalProperties": false, "properties": { "events": { "items": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "log": { "type": "string" }, "timestamp": { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "log", "id", "timestamp" ], "type": "object" }, "type": "array" }, "hasMore": { "type": "boolean" }, "total": { "type": "number" } }, "required": [ "events", "total", "hasMore" ], "title": "getSessionLogsResponse", "type": "object" }, "Jwks": { "additionalProperties": false, "description": "A JSON Web Key Set (JWKS) containing a list of public keys.", "properties": { "keys": { "description": "A list of JSON Web Keys.", "items": { "additionalProperties": {}, "description": "A single JSON Web Key (JWK).", "properties": { "alg": { "description": "The specific cryptographic algorithm used with the key (e.g., 'RS256').", "type": "string" }, "e": { "description": "The exponent for the RSA public key.", "type": "string" }, "kid": { "description": "The unique identifier for the key.", "type": "string" }, "kty": { "description": "The key type, identifying the algorithm family (e.g., 'RSA').", "type": "string" }, "n": { "description": "The modulus for the RSA public key.", "type": "string" }, "use": { "description": "The intended use of the public key (e.g., 'sig' for signature).", "type": "string" } }, "type": "object" }, "type": "array" } }, "required": [ "keys" ], "title": "jwks", "type": "object" }, "MultipleFiles": { "additionalProperties": false, "properties": { "data": { "description": "Array of files for the current page", "items": { "additionalProperties": false, "properties": { "lastModified": { "description": "Timestamp when the file was created", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "path": { "description": "Path to the file in the storage system", "type": "string" }, "size": { "description": "Size of the file in bytes", "type": "number" } }, "required": [ "path", "size", "lastModified" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "title": "multipleFiles", "type": "object" }, "PdfRequest": { "additionalProperties": false, "properties": { "delay": { "description": "Delay before generating the PDF (in milliseconds)", "type": "number" }, "projectId": { "description": "Project to execute the PDF generation in.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "region": { "description": "The desired region for the action to be performed in" }, "url": { "description": "URL of the webpage to convert to PDF", "format": "uri", "type": "string" }, "useProxy": { "description": "Use a Steel-provided residential proxy for generating the PDF", "type": "boolean" } }, "required": [ "url" ], "title": "pdfRequest", "type": "object" }, "PdfResponse": { "additionalProperties": false, "properties": { "url": { "description": "URL where the PDF is hosted", "format": "uri", "type": "string" } }, "required": [ "url" ], "title": "pdfResponse", "type": "object" }, "Profile": { "additionalProperties": false, "properties": { "createdAt": { "description": "The date and time when the profile was created", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "credentialsConfig": { "description": "The credentials configuration associated with the profile", "nullable": true }, "dimensions": { "additionalProperties": false, "description": "The dimensions associated with the profile", "nullable": true, "properties": { "height": { "type": "number" }, "width": { "type": "number" } }, "required": [ "width", "height" ], "type": "object" }, "extensionIds": { "description": "The extension IDs associated with the profile", "items": { "type": "string" }, "nullable": true, "type": "array" }, "fingerprint": { "additionalProperties": false, "description": "The fingerprint associated with the profile", "nullable": true, "properties": { "fingerprint": { "additionalProperties": {}, "properties": { "audioCodecs": { "additionalProperties": { "nullable": true, "type": "string" }, "type": "object" }, "battery": { "additionalProperties": {}, "properties": { "charging": { "nullable": true, "type": "boolean" }, "chargingTime": { "nullable": true, "type": "number" }, "dischargingTime": { "nullable": true, "type": "number" }, "level": { "nullable": true, "type": "number" } }, "required": [ "level", "charging", "chargingTime", "dischargingTime" ], "type": "object" }, "fonts": { "items": { "nullable": true, "type": "string" }, "type": "array" }, "mockWebRTC": { "nullable": true, "type": "boolean" }, "multimediaDevices": { "additionalProperties": {}, "properties": { "micros": { "items": { "additionalProperties": {}, "properties": { "deviceId": { "nullable": true, "type": "string" }, "groupId": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "label": { "nullable": true, "type": "string" } }, "required": [ "kind", "label", "groupId", "deviceId" ], "type": "object" }, "type": "array" }, "speakers": { "items": { "additionalProperties": {}, "properties": { "deviceId": { "nullable": true, "type": "string" }, "groupId": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "label": { "nullable": true, "type": "string" } }, "required": [ "kind", "label", "groupId", "deviceId" ], "type": "object" }, "type": "array" }, "webcams": { "items": { "additionalProperties": {}, "properties": { "deviceId": { "nullable": true, "type": "string" }, "groupId": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "label": { "nullable": true, "type": "string" } }, "required": [ "kind", "label", "groupId", "deviceId" ], "type": "object" }, "type": "array" } }, "required": [ "micros", "webcams", "speakers" ], "type": "object" }, "navigator": { "additionalProperties": {}, "properties": { "appCodeName": { "nullable": true, "type": "string" }, "appName": { "nullable": true, "type": "string" }, "appVersion": { "nullable": true, "type": "string" }, "deviceMemory": { "nullable": true, "type": "number" }, "doNotTrack": { "nullable": true, "type": "string" }, "extraProperties": { "additionalProperties": {}, "properties": { "globalPrivacyControl": { "nullable": true, "type": "boolean" }, "installedApps": { "items": { "nullable": true, "type": "string" }, "type": "array" }, "pdfViewerEnabled": { "nullable": true, "type": "boolean" }, "vendorFlavors": { "items": { "nullable": true, "type": "string" }, "type": "array" } }, "required": [ "installedApps", "vendorFlavors", "pdfViewerEnabled", "globalPrivacyControl" ], "type": "object" }, "hardwareConcurrency": { "nullable": true, "type": "number" }, "language": { "nullable": true, "type": "string" }, "languages": { "items": { "nullable": true, "type": "string" }, "type": "array" }, "maxTouchPoints": { "nullable": true, "type": "number" }, "oscpu": { "nullable": true, "type": "string" }, "platform": { "nullable": true, "type": "string" }, "product": { "nullable": true, "type": "string" }, "productSub": { "nullable": true, "type": "string" }, "userAgent": { "nullable": true, "type": "string" }, "userAgentData": { "additionalProperties": {}, "properties": { "brands": { "items": { "additionalProperties": {}, "properties": { "brand": { "nullable": true, "type": "string" }, "version": { "nullable": true, "type": "string" } }, "required": [ "brand", "version" ], "type": "object" }, "type": "array" }, "mobile": { "nullable": true, "type": "boolean" }, "platform": { "nullable": true, "type": "string" } }, "required": [ "brands", "mobile", "platform" ], "type": "object" }, "vendor": { "nullable": true, "type": "string" }, "vendorSub": { "nullable": true, "type": "string" }, "webdriver": { "nullable": true, "type": "boolean" } }, "required": [ "oscpu", "vendor", "appName", "product", "language", "platform", "languages", "userAgent", "vendorSub", "webdriver", "appVersion", "productSub", "appCodeName", "deviceMemory", "hardwareConcurrency", "userAgentData", "maxTouchPoints", "extraProperties" ], "type": "object" }, "pluginsData": { "additionalProperties": {}, "properties": { "mimeTypes": { "items": { "nullable": true, "type": "string" }, "type": "array" }, "plugins": { "items": { "additionalProperties": {}, "properties": { "description": { "nullable": true, "type": "string" }, "filename": { "nullable": true, "type": "string" }, "mimeTypes": { "items": { "additionalProperties": {}, "properties": { "description": { "nullable": true, "type": "string" }, "enabledPlugin": { "nullable": true, "type": "string" }, "suffixes": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "required": [ "type", "suffixes", "description", "enabledPlugin" ], "type": "object" }, "type": "array" }, "name": { "nullable": true, "type": "string" } }, "required": [ "name", "filename", "mimeTypes", "description" ], "type": "object" }, "type": "array" } }, "required": [ "plugins", "mimeTypes" ], "type": "object" }, "screen": { "additionalProperties": {}, "properties": { "availHeight": { "nullable": true, "type": "number" }, "availLeft": { "nullable": true, "type": "number" }, "availTop": { "nullable": true, "type": "number" }, "availWidth": { "nullable": true, "type": "number" }, "clientHeight": { "nullable": true, "type": "number" }, "clientWidth": { "nullable": true, "type": "number" }, "colorDepth": { "nullable": true, "type": "number" }, "devicePixelRatio": { "nullable": true, "type": "number" }, "hasHDR": { "nullable": true, "type": "boolean" }, "height": { "nullable": true, "type": "number" }, "innerHeight": { "nullable": true, "type": "number" }, "innerWidth": { "nullable": true, "type": "number" }, "outerHeight": { "nullable": true, "type": "number" }, "outerWidth": { "nullable": true, "type": "number" }, "pageXOffset": { "nullable": true, "type": "number" }, "pageYOffset": { "nullable": true, "type": "number" }, "pixelDepth": { "nullable": true, "type": "number" }, "screenX": { "nullable": true, "type": "number" }, "width": { "nullable": true, "type": "number" } }, "required": [ "width", "height", "hasHDR", "screenX", "availTop", "availLeft", "availWidth", "colorDepth", "innerWidth", "outerWidth", "pixelDepth", "availHeight", "clientWidth", "innerHeight", "outerHeight", "pageXOffset", "pageYOffset", "clientHeight", "devicePixelRatio" ], "type": "object" }, "slim": { "nullable": true, "type": "boolean" }, "videoCard": { "additionalProperties": {}, "properties": { "renderer": { "nullable": true, "type": "string" }, "vendor": { "nullable": true, "type": "string" } }, "required": [ "vendor", "renderer" ], "type": "object" }, "videoCodecs": { "additionalProperties": { "nullable": true, "type": "string" }, "type": "object" } }, "required": [ "slim", "fonts", "screen", "battery", "navigator", "videoCard", "mockWebRTC", "audioCodecs", "pluginsData", "videoCodecs", "multimediaDevices" ], "type": "object" }, "headers": { "additionalProperties": {}, "properties": { "accept": { "nullable": true, "type": "string" }, "accept-encoding": { "nullable": true, "type": "string" }, "accept-language": { "nullable": true, "type": "string" }, "dnt": { "nullable": true, "type": "string" }, "sec-ch-ua": { "nullable": true, "type": "string" }, "sec-ch-ua-mobile": { "nullable": true, "type": "string" }, "sec-ch-ua-platform": { "nullable": true, "type": "string" }, "sec-fetch-dest": { "nullable": true, "type": "string" }, "sec-fetch-mode": { "nullable": true, "type": "string" }, "sec-fetch-site": { "nullable": true, "type": "string" }, "sec-fetch-user": { "nullable": true, "type": "string" }, "upgrade-insecure-requests": { "nullable": true, "type": "string" }, "user-agent": { "nullable": true, "type": "string" } }, "required": [ "user-agent" ], "type": "object" } }, "required": [ "headers", "fingerprint" ], "type": "object" }, "id": { "description": "The unique identifier for the profile", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "projectId": { "description": "The project ID associated with the profile", "format": "uuid", "nullable": true, "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "sourceSessionId": { "description": "The last session ID associated with the profile", "format": "uuid", "nullable": true, "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "status": { "description": "The status of the profile", "enum": [ "UPLOADING", "READY", "FAILED" ], "type": "string" }, "updatedAt": { "description": "The date and time when the profile was last updated", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "useProxyConfig": { "description": "The proxy configuration associated with the profile", "nullable": true }, "userAgent": { "description": "The user agent associated with the profile", "nullable": true, "type": "string" } }, "required": [ "id", "projectId", "createdAt", "updatedAt", "sourceSessionId", "fingerprint", "userAgent", "dimensions", "status", "useProxyConfig", "extensionIds", "credentialsConfig" ], "title": "profile", "type": "object" }, "ProfileCreateRequest": { "additionalProperties": false, "properties": { "dimensions": { "additionalProperties": false, "description": "The dimensions associated with the profile", "properties": { "height": { "type": "number" }, "width": { "type": "number" } }, "required": [ "width", "height" ], "type": "object" }, "projectId": { "description": "Project to create the profile in", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "proxyUrl": { "description": "The proxy associated with the profile", "format": "uri", "type": "string" }, "useProxy": { "description": "JSON-encoded proxy configuration associated with the profile. For fixed IPs, send {\"type\":\"fixed\",\"id\":\"fixed:\"}.", "type": "string" }, "userAgent": { "description": "The user agent associated with the profile", "type": "string" }, "userDataDir": { "contentEncoding": "binary", "description": "The user data directory associated with the profile", "format": "binary", "type": "string" } }, "required": [ "userDataDir" ], "title": "profileCreateRequest", "type": "object" }, "ProfileListResponse": { "additionalProperties": false, "properties": { "count": { "description": "The total number of profiles", "minimum": 0, "type": "number" }, "profiles": { "description": "The list of profiles", "items": { "additionalProperties": false, "properties": { "createdAt": { "description": "The date and time when the profile was created", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "credentialsConfig": { "description": "The credentials configuration associated with the profile", "nullable": true }, "dimensions": { "additionalProperties": false, "description": "The dimensions associated with the profile", "nullable": true, "properties": { "height": { "type": "number" }, "width": { "type": "number" } }, "required": [ "width", "height" ], "type": "object" }, "extensionIds": { "description": "The extension IDs associated with the profile", "items": { "type": "string" }, "nullable": true, "type": "array" }, "fingerprint": { "additionalProperties": false, "description": "The fingerprint associated with the profile", "nullable": true, "properties": { "fingerprint": { "additionalProperties": {}, "properties": { "audioCodecs": { "additionalProperties": { "nullable": true, "type": "string" }, "type": "object" }, "battery": { "additionalProperties": {}, "properties": { "charging": { "nullable": true, "type": "boolean" }, "chargingTime": { "nullable": true, "type": "number" }, "dischargingTime": { "nullable": true, "type": "number" }, "level": { "nullable": true, "type": "number" } }, "required": [ "level", "charging", "chargingTime", "dischargingTime" ], "type": "object" }, "fonts": { "items": { "nullable": true, "type": "string" }, "type": "array" }, "mockWebRTC": { "nullable": true, "type": "boolean" }, "multimediaDevices": { "additionalProperties": {}, "properties": { "micros": { "items": { "additionalProperties": {}, "properties": { "deviceId": { "nullable": true, "type": "string" }, "groupId": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "label": { "nullable": true, "type": "string" } }, "required": [ "kind", "label", "groupId", "deviceId" ], "type": "object" }, "type": "array" }, "speakers": { "items": { "additionalProperties": {}, "properties": { "deviceId": { "nullable": true, "type": "string" }, "groupId": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "label": { "nullable": true, "type": "string" } }, "required": [ "kind", "label", "groupId", "deviceId" ], "type": "object" }, "type": "array" }, "webcams": { "items": { "additionalProperties": {}, "properties": { "deviceId": { "nullable": true, "type": "string" }, "groupId": { "nullable": true, "type": "string" }, "kind": { "nullable": true, "type": "string" }, "label": { "nullable": true, "type": "string" } }, "required": [ "kind", "label", "groupId", "deviceId" ], "type": "object" }, "type": "array" } }, "required": [ "micros", "webcams", "speakers" ], "type": "object" }, "navigator": { "additionalProperties": {}, "properties": { "appCodeName": { "nullable": true, "type": "string" }, "appName": { "nullable": true, "type": "string" }, "appVersion": { "nullable": true, "type": "string" }, "deviceMemory": { "nullable": true, "type": "number" }, "doNotTrack": { "nullable": true, "type": "string" }, "extraProperties": { "additionalProperties": {}, "properties": { "globalPrivacyControl": { "nullable": true, "type": "boolean" }, "installedApps": { "items": { "nullable": true, "type": "string" }, "type": "array" }, "pdfViewerEnabled": { "nullable": true, "type": "boolean" }, "vendorFlavors": { "items": { "nullable": true, "type": "string" }, "type": "array" } }, "required": [ "installedApps", "vendorFlavors", "pdfViewerEnabled", "globalPrivacyControl" ], "type": "object" }, "hardwareConcurrency": { "nullable": true, "type": "number" }, "language": { "nullable": true, "type": "string" }, "languages": { "items": { "nullable": true, "type": "string" }, "type": "array" }, "maxTouchPoints": { "nullable": true, "type": "number" }, "oscpu": { "nullable": true, "type": "string" }, "platform": { "nullable": true, "type": "string" }, "product": { "nullable": true, "type": "string" }, "productSub": { "nullable": true, "type": "string" }, "userAgent": { "nullable": true, "type": "string" }, "userAgentData": { "additionalProperties": {}, "properties": { "brands": { "items": { "additionalProperties": {}, "properties": { "brand": { "nullable": true, "type": "string" }, "version": { "nullable": true, "type": "string" } }, "required": [ "brand", "version" ], "type": "object" }, "type": "array" }, "mobile": { "nullable": true, "type": "boolean" }, "platform": { "nullable": true, "type": "string" } }, "required": [ "brands", "mobile", "platform" ], "type": "object" }, "vendor": { "nullable": true, "type": "string" }, "vendorSub": { "nullable": true, "type": "string" }, "webdriver": { "nullable": true, "type": "boolean" } }, "required": [ "oscpu", "vendor", "appName", "product", "language", "platform", "languages", "userAgent", "vendorSub", "webdriver", "appVersion", "productSub", "appCodeName", "deviceMemory", "hardwareConcurrency", "userAgentData", "maxTouchPoints", "extraProperties" ], "type": "object" }, "pluginsData": { "additionalProperties": {}, "properties": { "mimeTypes": { "items": { "nullable": true, "type": "string" }, "type": "array" }, "plugins": { "items": { "additionalProperties": {}, "properties": { "description": { "nullable": true, "type": "string" }, "filename": { "nullable": true, "type": "string" }, "mimeTypes": { "items": { "additionalProperties": {}, "properties": { "description": { "nullable": true, "type": "string" }, "enabledPlugin": { "nullable": true, "type": "string" }, "suffixes": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "required": [ "type", "suffixes", "description", "enabledPlugin" ], "type": "object" }, "type": "array" }, "name": { "nullable": true, "type": "string" } }, "required": [ "name", "filename", "mimeTypes", "description" ], "type": "object" }, "type": "array" } }, "required": [ "plugins", "mimeTypes" ], "type": "object" }, "screen": { "additionalProperties": {}, "properties": { "availHeight": { "nullable": true, "type": "number" }, "availLeft": { "nullable": true, "type": "number" }, "availTop": { "nullable": true, "type": "number" }, "availWidth": { "nullable": true, "type": "number" }, "clientHeight": { "nullable": true, "type": "number" }, "clientWidth": { "nullable": true, "type": "number" }, "colorDepth": { "nullable": true, "type": "number" }, "devicePixelRatio": { "nullable": true, "type": "number" }, "hasHDR": { "nullable": true, "type": "boolean" }, "height": { "nullable": true, "type": "number" }, "innerHeight": { "nullable": true, "type": "number" }, "innerWidth": { "nullable": true, "type": "number" }, "outerHeight": { "nullable": true, "type": "number" }, "outerWidth": { "nullable": true, "type": "number" }, "pageXOffset": { "nullable": true, "type": "number" }, "pageYOffset": { "nullable": true, "type": "number" }, "pixelDepth": { "nullable": true, "type": "number" }, "screenX": { "nullable": true, "type": "number" }, "width": { "nullable": true, "type": "number" } }, "required": [ "width", "height", "hasHDR", "screenX", "availTop", "availLeft", "availWidth", "colorDepth", "innerWidth", "outerWidth", "pixelDepth", "availHeight", "clientWidth", "innerHeight", "outerHeight", "pageXOffset", "pageYOffset", "clientHeight", "devicePixelRatio" ], "type": "object" }, "slim": { "nullable": true, "type": "boolean" }, "videoCard": { "additionalProperties": {}, "properties": { "renderer": { "nullable": true, "type": "string" }, "vendor": { "nullable": true, "type": "string" } }, "required": [ "vendor", "renderer" ], "type": "object" }, "videoCodecs": { "additionalProperties": { "nullable": true, "type": "string" }, "type": "object" } }, "required": [ "slim", "fonts", "screen", "battery", "navigator", "videoCard", "mockWebRTC", "audioCodecs", "pluginsData", "videoCodecs", "multimediaDevices" ], "type": "object" }, "headers": { "additionalProperties": {}, "properties": { "accept": { "nullable": true, "type": "string" }, "accept-encoding": { "nullable": true, "type": "string" }, "accept-language": { "nullable": true, "type": "string" }, "dnt": { "nullable": true, "type": "string" }, "sec-ch-ua": { "nullable": true, "type": "string" }, "sec-ch-ua-mobile": { "nullable": true, "type": "string" }, "sec-ch-ua-platform": { "nullable": true, "type": "string" }, "sec-fetch-dest": { "nullable": true, "type": "string" }, "sec-fetch-mode": { "nullable": true, "type": "string" }, "sec-fetch-site": { "nullable": true, "type": "string" }, "sec-fetch-user": { "nullable": true, "type": "string" }, "upgrade-insecure-requests": { "nullable": true, "type": "string" }, "user-agent": { "nullable": true, "type": "string" } }, "required": [ "user-agent" ], "type": "object" } }, "required": [ "headers", "fingerprint" ], "type": "object" }, "id": { "description": "The unique identifier for the profile", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "projectId": { "description": "The project ID associated with the profile", "format": "uuid", "nullable": true, "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "sourceSessionId": { "description": "The last session ID associated with the profile", "format": "uuid", "nullable": true, "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "status": { "description": "The status of the profile", "enum": [ "UPLOADING", "READY", "FAILED" ], "type": "string" }, "updatedAt": { "description": "The date and time when the profile was last updated", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "useProxyConfig": { "description": "The proxy configuration associated with the profile", "nullable": true }, "userAgent": { "description": "The user agent associated with the profile", "nullable": true, "type": "string" } }, "required": [ "id", "projectId", "createdAt", "updatedAt", "sourceSessionId", "fingerprint", "userAgent", "dimensions", "status", "useProxyConfig", "extensionIds", "credentialsConfig" ], "type": "object" }, "type": "array" } }, "required": [ "profiles", "count" ], "title": "profileListResponse", "type": "object" }, "ReleaseSessionResponse": { "additionalProperties": false, "description": "Response for releasing a single session.", "properties": { "message": { "description": "Details about the outcome of the release operation", "type": "string" }, "success": { "description": "Indicates if the session was successfully released", "type": "boolean" } }, "required": [ "success", "message" ], "title": "releaseSessionResponse", "type": "object" }, "ReleaseSessionsResponse": { "additionalProperties": false, "description": "Response for releasing multiple sessions.", "properties": { "message": { "description": "Details about the outcome of the release operation", "type": "string" }, "success": { "description": "Indicates if the sessions were successfully released", "type": "boolean" } }, "required": [ "success", "message" ], "title": "releaseSessionsResponse", "type": "object" }, "ScrapeRequest": { "additionalProperties": false, "properties": { "delay": { "description": "Delay before scraping (in milliseconds)", "type": "number" }, "format": { "description": "Desired format(s) for the scraped content. Default is `html`.", "items": { "enum": [ "html", "readability", "cleaned_html", "markdown" ], "type": "string" }, "type": "array" }, "pdf": { "description": "Include a PDF in the response", "type": "boolean" }, "projectId": { "description": "Project to execute the scrape in.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "region": { "description": "The desired region for the action to be performed in" }, "screenshot": { "description": "Include a screenshot in the response", "type": "boolean" }, "url": { "description": "URL of the webpage to scrape", "type": "string" }, "useProxy": { "description": "Use a Steel-provided residential proxy for the scrape", "type": "boolean" } }, "required": [ "url" ], "title": "scrapeRequest", "type": "object" }, "ScrapeResponse": { "additionalProperties": false, "description": "Response from a successful scrape request", "properties": { "content": { "additionalProperties": false, "properties": { "cleaned_html": { "description": "Cleaned HTML content of the webpage", "type": "string" }, "html": { "description": "Raw HTML content of the webpage", "type": "string" }, "markdown": { "description": "Webpage content converted to Markdown", "type": "string" }, "readability": { "additionalProperties": {}, "description": "Webpage content in Readability format", "type": "object" } }, "type": "object" }, "links": { "items": { "additionalProperties": false, "properties": { "text": { "description": "Text content of the link", "type": "string" }, "url": { "description": "URL of the link", "type": "string" } }, "required": [ "url", "text" ], "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": false, "properties": { "articleAuthor": { "description": "Author of the article content", "type": "string" }, "author": { "description": "Author of the webpage content", "type": "string" }, "canonical": { "description": "Canonical URL of the webpage", "type": "string" }, "description": { "description": "Description of the webpage", "type": "string" }, "favicon": { "description": "Favicon URL of the website", "type": "string" }, "jsonLd": { "description": "JSON-LD structured data from the webpage" }, "keywords": { "description": "Keywords associated with the webpage", "type": "string" }, "language": { "description": "Detected language of the webpage", "type": "string" }, "modifiedTime": { "description": "Last modification time of the content", "type": "string" }, "ogDescription": { "description": "Open Graph description", "type": "string" }, "ogImage": { "description": "Open Graph image URL", "type": "string" }, "ogSiteName": { "description": "Open Graph site name", "type": "string" }, "ogTitle": { "description": "Open Graph title", "type": "string" }, "ogUrl": { "description": "Open Graph URL", "type": "string" }, "publishedTime": { "description": "Publication time of the content", "type": "string" }, "statusCode": { "description": "HTTP status code of the response", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "timestamp": { "description": "Timestamp when the scrape was performed", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "title": { "description": "Title of the webpage", "type": "string" }, "urlSource": { "description": "Source URL of the scraped page", "type": "string" } }, "required": [ "statusCode" ], "type": "object" }, "pdf": { "additionalProperties": false, "properties": { "url": { "description": "URL of the generated PDF", "type": "string" } }, "required": [ "url" ], "type": "object" }, "screenshot": { "additionalProperties": false, "properties": { "url": { "description": "URL of the screenshot image", "type": "string" } }, "required": [ "url" ], "type": "object" } }, "required": [ "content", "metadata", "links" ], "title": "scrapeResponse", "type": "object" }, "ScreenshotRequest": { "additionalProperties": false, "properties": { "delay": { "description": "Delay before capturing the screenshot (in milliseconds)", "type": "number" }, "fullPage": { "description": "Capture the full page screenshot. Default is `false`.", "type": "boolean" }, "projectId": { "description": "Project to execute the screenshot in.", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "region": { "description": "The desired region for the action to be performed in" }, "url": { "description": "URL of the webpage to capture", "format": "uri", "type": "string" }, "useProxy": { "description": "Use a Steel-provided residential proxy for capturing the screenshot", "type": "boolean" } }, "required": [ "url" ], "title": "screenshotRequest", "type": "object" }, "ScreenshotResponse": { "additionalProperties": false, "properties": { "url": { "description": "URL where the screenshot is hosted", "format": "uri", "type": "string" } }, "required": [ "url" ], "title": "screenshotResponse", "type": "object" }, "SessionContextResponse": { "additionalProperties": false, "description": "Session context data returned from a browser session.", "properties": { "cookies": { "description": "Cookies to initialize in the session", "items": { "additionalProperties": false, "properties": { "domain": { "description": "The domain of the cookie", "type": "string" }, "expires": { "description": "The expiration date of the cookie", "type": "number" }, "httpOnly": { "description": "Whether the cookie is HTTP only", "type": "boolean" }, "name": { "description": "The name of the cookie", "type": "string" }, "partitionKey": { "additionalProperties": false, "description": "The partition key of the cookie", "properties": { "hasCrossSiteAncestor": { "description": "Indicates if the cookie has any ancestors that are cross-site to the topLevelSite.", "type": "boolean" }, "topLevelSite": { "description": "The site of the top-level URL the browser was visiting at the start of the request to the endpoint that set the cookie.", "type": "string" } }, "required": [ "topLevelSite", "hasCrossSiteAncestor" ], "type": "object" }, "path": { "description": "The path of the cookie", "type": "string" }, "priority": { "description": "The priority of the cookie", "enum": [ "Low", "Medium", "High" ], "type": "string" }, "sameParty": { "description": "Whether the cookie is a same party cookie", "type": "boolean" }, "sameSite": { "description": "The same site attribute of the cookie", "enum": [ "Strict", "Lax", "None" ], "type": "string" }, "secure": { "description": "Whether the cookie is secure", "type": "boolean" }, "session": { "description": "Whether the cookie is a session cookie", "type": "boolean" }, "size": { "description": "The size of the cookie", "type": "number" }, "sourcePort": { "description": "The source port of the cookie", "type": "number" }, "sourceScheme": { "description": "The source scheme of the cookie", "enum": [ "Unset", "NonSecure", "Secure" ], "type": "string" }, "url": { "description": "The URL of the cookie", "type": "string" }, "value": { "description": "The value of the cookie", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "indexedDB": { "additionalProperties": { "items": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "records": { "items": { "additionalProperties": false, "properties": { "blobFiles": { "items": { "additionalProperties": false, "properties": { "blobNumber": { "type": "number" }, "filename": { "type": "string" }, "lastModified": { "format": "date-time", "type": "string" }, "mimeType": { "type": "string" }, "path": { "type": "string" }, "size": { "type": "number" } }, "required": [ "blobNumber", "mimeType", "size" ], "type": "object" }, "type": "array" }, "key": {}, "value": {} }, "required": [ "key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "id", "name", "records" ], "type": "object" }, "type": "array" }, "id": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "name", "data" ], "type": "object" }, "type": "array" }, "description": "Domain-specific indexedDB items to initialize in the session", "type": "object" }, "localStorage": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "description": "Domain-specific localStorage items to initialize in the session", "type": "object" }, "sessionStorage": { "additionalProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "description": "Domain-specific sessionStorage items to initialize in the session", "type": "object" } }, "title": "sessionContextResponse", "type": "object" }, "SessionCostResponse": { "additionalProperties": false, "description": "Session cost breakdown in US dollars", "properties": { "currency": { "description": "Currency used for the cost values", "enum": [ "usd" ], "type": "string" }, "id": { "description": "Session ID", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "totalCost": { "description": "Exact total session cost in US dollars (e.g. 0.031905), with no rounding to whole cents. Rounded only to micro-dollar precision (6 decimal places) for precise billing passthrough.", "minimum": 0, "type": "number" }, "unit": { "description": "Cost unit. Values are expressed in US dollars.", "enum": [ "dollar" ], "type": "string" }, "usage": { "additionalProperties": false, "description": "Billable usage inputs used to calculate the costs", "properties": { "browser": { "additionalProperties": false, "properties": { "unit": { "description": "Billing unit for browser usage", "enum": [ "minute", "second" ], "type": "string" }, "value": { "description": "Billable browser usage value", "minimum": 0, "type": "number" } }, "required": [ "value", "unit" ], "type": "object" }, "captcha": { "additionalProperties": false, "properties": { "solves": { "description": "Billable captcha solves", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "solves" ], "type": "object" }, "proxy": { "additionalProperties": false, "properties": { "bytes": { "description": "Billable Steel proxy bytes for the session", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "bytes" ], "type": "object" } }, "required": [ "browser", "proxy", "captcha" ], "type": "object" } }, "required": [ "id", "currency", "unit", "totalCost", "usage" ], "title": "sessionCostResponse", "type": "object" }, "SessionLiveDetailsResponse": { "additionalProperties": false, "properties": { "pages": { "items": { "additionalProperties": false, "properties": { "favicon": { "nullable": true, "type": "string" }, "id": { "type": "string" }, "sessionViewerFullscreenUrl": { "type": "string" }, "sessionViewerUrl": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "id", "url", "title", "favicon", "sessionViewerUrl", "sessionViewerFullscreenUrl" ], "type": "object" }, "type": "array" }, "sessionViewerFullscreenUrl": { "type": "string" }, "sessionViewerUrl": { "type": "string" }, "wsUrl": { "type": "string" } }, "required": [ "sessionViewerUrl", "sessionViewerFullscreenUrl", "pages", "wsUrl" ], "title": "sessionLiveDetailsResponse", "type": "object" }, "SessionResponse": { "additionalProperties": false, "description": "Represents the data structure for a browser session, including its configuration and status.", "properties": { "browserMode": { "description": "Browser mode used for this session.", "enum": [ "stealth", "standard", "unknown" ], "type": "string" }, "createdAt": { "description": "Timestamp when the session started", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "creditsUsed": { "description": "Amount of credits consumed by the session", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "debugConfig": { "additionalProperties": false, "description": "Configuration for the debug URL and session viewer. Controls interaction capabilities and cursor visibility.", "properties": { "interactive": { "default": true, "description": "Whether interaction is allowed via the debug URL viewer. When false, the session viewer is view-only.", "type": "boolean" }, "systemCursor": { "default": true, "description": "Whether the OS-level mouse cursor is shown in the WebRTC stream (headful mode only).", "type": "boolean" } }, "type": "object" }, "debugUrl": { "description": "URL for debugging the session", "type": "string" }, "deviceConfig": { "additionalProperties": false, "description": "Device configuration for the session", "properties": { "device": { "default": "desktop", "enum": [ "desktop", "mobile" ], "type": "string" } }, "type": "object" }, "dimensions": { "additionalProperties": false, "description": "Viewport and browser window dimensions for the session", "properties": { "height": { "description": "Height of the browser window", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "width": { "description": "Width of the browser window", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "width", "height" ], "type": "object" }, "duration": { "description": "Duration of the session in milliseconds", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "eventCount": { "description": "Number of events processed in the session", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "fullscreen": { "description": "Launch the browser in fullscreen mode, covering the full screen with no Chrome UI.", "type": "boolean" }, "headless": { "default": false, "description": "Indicates if the session is headless or headful", "type": "boolean" }, "id": { "description": "Unique identifier for the session", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "inactivityTimeout": { "description": "Inactivity timeout in milliseconds, if one was set when the session was created", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "isSelenium": { "description": "Indicates if Selenium is used in the session", "type": "boolean" }, "optimizeBandwidth": { "additionalProperties": false, "description": "Bandwidth optimizations that were applied to the session.", "properties": { "blockHosts": { "items": { "type": "string" }, "type": "array" }, "blockImages": { "type": "boolean" }, "blockMedia": { "type": "boolean" }, "blockStylesheets": { "type": "boolean" }, "blockUrlPatterns": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "persistProfile": { "description": "This flag will persist the profile for the session.", "type": "boolean" }, "profileId": { "description": "The ID of the profile associated with the session", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "projectId": { "description": "The project associated with the session", "format": "uuid", "nullable": true, "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "proxyBytesUsed": { "description": "Amount of data transmitted through the proxy", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "proxySource": { "description": "Source of the proxy used for the session", "enum": [ "steel", "external" ], "nullable": true, "type": "string" }, "region": { "description": "The region where the session was created.", "type": "string" }, "releaseReason": { "description": "Why the session reached a terminal state. Null while the session is live, or when the reason is unknown (e.g. sessions created before this was tracked). One of: user_requested (released via the API/SDK), timeout (hard `timeout` elapsed), inactivity_timeout (no activity for the configured window), creation_timeout (never started in time), startup_failed (could not be dispatched), browser_closed (the browser or agent closed itself — not a crash), browser_crashed (the browser crashed or its machine became unresponsive).", "enum": [ "user_requested", "timeout", "inactivity_timeout", "creation_timeout", "startup_failed", "browser_closed", "browser_crashed" ], "nullable": true, "type": "string" }, "sessionViewerUrl": { "description": "URL to view session details", "type": "string" }, "solveCaptcha": { "description": "Indicates if captcha solving is enabled", "type": "boolean" }, "status": { "description": "Status of the session", "enum": [ "live", "released", "failed" ], "type": "string" }, "stealthConfig": { "additionalProperties": false, "description": "Stealth configuration for the session", "properties": { "autoCaptchaSolving": { "description": "When true, captchas will be automatically solved when detected. When false, use the solve endpoints to manually initiate solving.", "type": "boolean" }, "humanizeInteractions": { "description": "This flag will make the browser act more human-like by moving the mouse in a more natural way", "type": "boolean" }, "skipFingerprintInjection": { "description": "This flag will skip the fingerprint generation for the session.", "type": "boolean" } }, "type": "object" }, "timeout": { "description": "Session timeout duration in milliseconds", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "userAgent": { "description": "User agent string used in the session", "type": "string" }, "websocketUrl": { "description": "URL for the session's WebSocket connection", "type": "string" } }, "required": [ "id", "createdAt", "status", "duration", "eventCount", "timeout", "dimensions", "creditsUsed", "websocketUrl", "debugUrl", "sessionViewerUrl", "proxySource", "proxyBytesUsed", "optimizeBandwidth", "browserMode" ], "title": "sessionResponse", "type": "object" }, "SessionsResponse": { "additionalProperties": false, "description": "Response containing a list of browser sessions with pagination details.", "properties": { "nextCursor": { "description": "Cursor for the next page of results. Null if no more pages.", "nullable": true, "type": "string" }, "sessions": { "description": "List of browser sessions", "items": { "additionalProperties": false, "description": "Represents the data structure for a browser session, including its configuration and status.", "properties": { "browserMode": { "description": "Browser mode used for this session.", "enum": [ "stealth", "standard", "unknown" ], "type": "string" }, "createdAt": { "description": "Timestamp when the session started", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "creditsUsed": { "description": "Amount of credits consumed by the session", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "debugConfig": { "additionalProperties": false, "description": "Configuration for the debug URL and session viewer. Controls interaction capabilities and cursor visibility.", "properties": { "interactive": { "default": true, "description": "Whether interaction is allowed via the debug URL viewer. When false, the session viewer is view-only.", "type": "boolean" }, "systemCursor": { "default": true, "description": "Whether the OS-level mouse cursor is shown in the WebRTC stream (headful mode only).", "type": "boolean" } }, "type": "object" }, "debugUrl": { "description": "URL for debugging the session", "type": "string" }, "deviceConfig": { "additionalProperties": false, "description": "Device configuration for the session", "properties": { "device": { "default": "desktop", "enum": [ "desktop", "mobile" ], "type": "string" } }, "type": "object" }, "dimensions": { "additionalProperties": false, "description": "Viewport and browser window dimensions for the session", "properties": { "height": { "description": "Height of the browser window", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "width": { "description": "Width of the browser window", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "width", "height" ], "type": "object" }, "duration": { "description": "Duration of the session in milliseconds", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "eventCount": { "description": "Number of events processed in the session", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "fullscreen": { "description": "Launch the browser in fullscreen mode, covering the full screen with no Chrome UI.", "type": "boolean" }, "headless": { "default": false, "description": "Indicates if the session is headless or headful", "type": "boolean" }, "id": { "description": "Unique identifier for the session", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "inactivityTimeout": { "description": "Inactivity timeout in milliseconds, if one was set when the session was created", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "isSelenium": { "description": "Indicates if Selenium is used in the session", "type": "boolean" }, "optimizeBandwidth": { "additionalProperties": false, "description": "Bandwidth optimizations that were applied to the session.", "properties": { "blockHosts": { "items": { "type": "string" }, "type": "array" }, "blockImages": { "type": "boolean" }, "blockMedia": { "type": "boolean" }, "blockStylesheets": { "type": "boolean" }, "blockUrlPatterns": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "persistProfile": { "description": "This flag will persist the profile for the session.", "type": "boolean" }, "profileId": { "description": "The ID of the profile associated with the session", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "projectId": { "description": "The project associated with the session", "format": "uuid", "nullable": true, "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, "proxyBytesUsed": { "description": "Amount of data transmitted through the proxy", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "proxySource": { "description": "Source of the proxy used for the session", "enum": [ "steel", "external" ], "nullable": true, "type": "string" }, "region": { "description": "The region where the session was created.", "type": "string" }, "releaseReason": { "description": "Why the session reached a terminal state. Null while the session is live, or when the reason is unknown (e.g. sessions created before this was tracked). One of: user_requested (released via the API/SDK), timeout (hard `timeout` elapsed), inactivity_timeout (no activity for the configured window), creation_timeout (never started in time), startup_failed (could not be dispatched), browser_closed (the browser or agent closed itself — not a crash), browser_crashed (the browser crashed or its machine became unresponsive).", "enum": [ "user_requested", "timeout", "inactivity_timeout", "creation_timeout", "startup_failed", "browser_closed", "browser_crashed" ], "nullable": true, "type": "string" }, "sessionViewerUrl": { "description": "URL to view session details", "type": "string" }, "solveCaptcha": { "description": "Indicates if captcha solving is enabled", "type": "boolean" }, "status": { "description": "Status of the session", "enum": [ "live", "released", "failed" ], "type": "string" }, "stealthConfig": { "additionalProperties": false, "description": "Stealth configuration for the session", "properties": { "autoCaptchaSolving": { "description": "When true, captchas will be automatically solved when detected. When false, use the solve endpoints to manually initiate solving.", "type": "boolean" }, "humanizeInteractions": { "description": "This flag will make the browser act more human-like by moving the mouse in a more natural way", "type": "boolean" }, "skipFingerprintInjection": { "description": "This flag will skip the fingerprint generation for the session.", "type": "boolean" } }, "type": "object" }, "timeout": { "description": "Session timeout duration in milliseconds", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "userAgent": { "description": "User agent string used in the session", "type": "string" }, "websocketUrl": { "description": "URL for the session's WebSocket connection", "type": "string" } }, "required": [ "id", "createdAt", "status", "duration", "eventCount", "timeout", "dimensions", "creditsUsed", "websocketUrl", "debugUrl", "sessionViewerUrl", "proxySource", "proxyBytesUsed", "optimizeBandwidth", "browserMode" ], "type": "object" }, "type": "array" }, "totalCount": { "description": "Total number of sessions matching the query. Only included for filtered queries (e.g. status=live).", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "sessions", "nextCursor" ], "title": "sessionsResponse", "type": "object" }, "SolveCaptchaRequest": { "additionalProperties": false, "description": "If no fields are provided, all detected captchas will be solved", "properties": { "pageId": { "description": "The page ID where the captcha is located", "type": "string" }, "taskId": { "description": "The task ID of the specific captcha to solve", "type": "string" }, "url": { "description": "The URL where the captcha is located", "type": "string" } }, "title": "solveCaptchaRequest", "type": "object" }, "SolveImageCaptchaRequest": { "additionalProperties": false, "properties": { "imageXPath": { "description": "XPath to the captcha image element", "type": "string" }, "inputXPath": { "description": "XPath to the captcha input element", "type": "string" }, "url": { "description": "URL where the captcha is located. Defaults to the current page URL", "type": "string" } }, "required": [ "imageXPath", "inputXPath" ], "title": "solveImageCaptchaRequest", "type": "object" }, "SuccessResponse": { "additionalProperties": false, "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "title": "successResponse", "type": "object" }, "UploadExtensionRequest": { "additionalProperties": false, "properties": { "file": { "contentEncoding": "binary", "description": "Extension .zip/.crx file", "format": "binary", "type": "string" }, "url": { "description": "Extension URL", "format": "uri", "type": "string" } }, "title": "uploadExtensionRequest", "type": "object" } }, "securitySchemes": { "apiKey": { "in": "header", "name": "steel-api-key", "type": "apiKey" } } }, "info": { "contact": { "email": "team@steel.dev", "name": "Steel Team" }, "description": "Steel (https://steel.dev) is an open-source browser API purpose-built for AI agents.\n \nIt offers endpoints for various browser actions and session management, enabling agents to navigate the web for information over long running browser sessions.\n \n**Key Capabilities:**\n- Control fleets of browser sessions in the cloud via API or Python/Node SDKs\n- Easily extract page data as cleaned HTML, markdown, PDFs, or screenshots\n- Access data behind logins with persistent cookies and automatic sign-in\n- Render complex client-side content with JavaScript execution\n- Bypass anti-bot measures with rotating proxies, stealth configs, and CAPTCHA solving\n- Reduce token usage and costs by up to 80% with optimized page formats\n- Reuse session and cookie data across multiple runs\n- Debug with ease using live session viewers, replays, and embeddings\n\n**Target Audience:**\n- AI engineers and developers working with online LLMs\n- Users with their own infrastructure looking to offload browser hosting operations\n- Users who need to scrape the web for information\n- QA teams who need to test web applications\n\n**Get Started:**\n- Open-source: Available as a Docker container for easy integration and scaling\n- Cloud API: Fully hosted and managed, no setup required. Get an API key at https://steel.dev\n- SDK: Available in Python, JavaScript, and more\n\n**Documentation:**\n- Check out the full documentation at https://docs.steel.dev\n- Explore the SDK documentation to get started with your project\n- Join our community on Discord for support and discussions", "title": "Steel API", "version": "0.0.1" }, "openapi": "3.0.3", "paths": { "/.well-known/jwks.json": { "get": { "description": "Provides the JSON Web Key Set (JWKS) for verifying JWTs issued by this service.", "operationId": "get_well_known_jwks", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Jwks" } } }, "description": "A JSON Web Key Set (JWKS) containing a list of public keys." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Get Public Keys (JWKS)", "tags": [ "Auth" ] } }, "/v1/credentials": { "delete": { "description": "Deletes encrypted credentials from the database", "operationId": "delete_credential", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialNamespaceOrigin" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Deletes credentials", "tags": [ "Credentials" ] }, "get": { "description": "Fetches all credential metadata for the current organization.", "operationId": "list_credentials", "parameters": [ { "description": "Project to query credentials from.", "in": "query", "name": "projectId", "required": false, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } }, { "description": "namespace credential is stored against", "in": "query", "name": "namespace", "required": false, "schema": { "type": "string" } }, { "description": "website origin the credential is for", "in": "query", "name": "origin", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialList" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "List all credential metadata", "tags": [ "Credentials" ] }, "post": { "description": "Encrypts and stores credentials for an origin", "operationId": "create_credential", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialMetadata" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Stores credentials", "tags": [ "Credentials" ] }, "put": { "description": "Encrypts and updates credentials for an origin", "operationId": "update_credential", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialUpdate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialMetadata" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Updates credentials", "tags": [ "Credentials" ] } }, "/v1/extensions": { "delete": { "description": "Delete all extensions for the organization", "operationId": "delete_all_extensions", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Delete all extensions", "tags": [ "Extensions" ] }, "get": { "description": "List all extensions for the organization", "operationId": "list_extensions", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionList" } } }, "description": "Response containing a list of extensions for the organization" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "List extensions", "tags": [ "Extensions" ] }, "post": { "description": "Upload a Chrome extension (.zip/.crx file or Chrome Web Store URL) for the organization", "operationId": "upload_extension", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UploadExtensionRequest" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionUploadResponse" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Upload extension", "tags": [ "Extensions" ] } }, "/v1/extensions/{extensionId}": { "delete": { "description": "Delete an extension by ID", "operationId": "delete_extension", "parameters": [ { "description": "Extension ID", "in": "path", "name": "extensionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResponse" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Delete extension", "tags": [ "Extensions" ] }, "get": { "description": "Download an extension file by extension ID", "operationId": "download_extension", "parameters": [ { "description": "Extension ID", "in": "path", "name": "extensionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "Extension zip file", "format": "binary", "type": "string" } } }, "description": "Extension zip file" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Download extension", "tags": [ "Extensions" ] }, "put": { "description": "Update a Chrome extension (.zip/.crx file or Chrome Web Store URL) for the organization", "operationId": "update_extension", "parameters": [ { "description": "Extension ID", "in": "path", "name": "extensionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UploadExtensionRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtensionUploadResponse" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Update extension", "tags": [ "Extensions" ] } }, "/v1/files": { "get": { "description": "List all global files for the organization in descending order.", "operationId": "list_global_files", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultipleFiles" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "List global files", "tags": [ "Files" ] }, "post": { "description": "Uploads a file to global storage via `multipart/form-data` with a `file` field that accepts either binary data or a URL string to download from, and an optional `path` field for the file storage path.", "operationId": "upload_global_file", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FileUploadRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDetails" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Upload a global file", "tags": [ "Files" ] } }, "/v1/files/{path}": { "delete": { "description": "Delete a file from global storage", "operationId": "delete_global_file", "parameters": [ { "in": "path", "name": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "File successfully deleted" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Delete a global file", "tags": [ "Files" ] }, "get": { "description": "Download a file from global storage", "operationId": "download_global_file", "parameters": [ { "in": "path", "name": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful download" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Download a global file", "tags": [ "Files" ] } }, "/v1/pdf": { "post": { "description": "Generates a PDF from a specified webpage.", "operationId": "pdf", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PdfRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PdfResponse" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Convert webpage to PDF", "tags": [ "Browser Tools" ] } }, "/v1/profiles": { "get": { "description": "Retrieve a list of all profiles", "operationId": "listProfiles", "parameters": [ { "description": "Project to query profiles from", "in": "query", "name": "projectId", "required": false, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileListResponse" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "List all profiles", "tags": [ "Profiles" ] }, "post": { "description": "Create a new profile", "operationId": "createProfile", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProfileCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profile" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Create a profile", "tags": [ "Profiles" ] } }, "/v1/profiles/{id}": { "get": { "description": "Retrieve a profile by ID", "operationId": "getProfile", "parameters": [ { "description": "Project to query profiles from", "in": "query", "name": "projectId", "required": false, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profile" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Get a profile", "tags": [ "Profiles" ] }, "patch": { "description": "Update an existing profile", "operationId": "updateProfile", "parameters": [ { "description": "Project to query profiles from", "in": "query", "name": "projectId", "required": false, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProfileCreateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profile" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Update a profile", "tags": [ "Profiles" ] } }, "/v1/scrape": { "post": { "description": "Extracts content from a specified URL.", "operationId": "scrape", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScrapeRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScrapeResponse" } } }, "description": "Response from a successful scrape request" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Scrape webpage content", "tags": [ "Browser Tools" ] } }, "/v1/screenshot": { "post": { "description": "Captures a screenshot of a specified webpage.", "operationId": "screenshot", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreenshotRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreenshotResponse" } } }, "description": "Default Response" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Capture webpage screenshot", "tags": [ "Browser Tools" ] } }, "/v1/sessions": { "get": { "description": "Fetches all active sessions for the current organization.", "operationId": "get_sessions", "parameters": [ { "description": "Cursor ID for pagination", "in": "query", "name": "cursorId", "required": false, "schema": { "type": "string" } }, { "description": "Number of sessions to return. Default is 50, max is 100.", "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Filter sessions by current status", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "live", "released", "failed" ], "type": "string" } }, { "description": "Filter sessions by project", "in": "query", "name": "projectId", "required": false, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionsResponse" } } }, "description": "Response containing a list of browser sessions with pagination details." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "List all sessions", "tags": [ "Sessions" ], "x-steel-cli": { "command": [ "sessions", "list" ] } }, "post": { "description": "Creates a new session with the provided configuration.", "operationId": "create_session", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSessionRequest" } } }, "required": false }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } }, "description": "Represents the data structure for a browser session, including its configuration and status." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Create a session", "tags": [ "Sessions" ] } }, "/v1/sessions/release": { "post": { "description": "Releases all active sessions for the current organization.", "operationId": "release_all_sessions", "parameters": [ { "description": "Release sessions only within this project", "in": "query", "name": "projectId", "required": false, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseSessionsResponse" } } }, "description": "Response for releasing multiple sessions." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseSessionsResponse" } } }, "description": "Response for releasing multiple sessions." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Release all sessions", "tags": [ "Sessions" ], "x-steel-cli": { "command": [ "sessions", "release", "--all" ] } } }, "/v1/sessions/{id}": { "get": { "description": "Retrieves details of a specific session by ID.", "operationId": "get_session", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } }, "description": "Represents the data structure for a browser session, including its configuration and status." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Get session details", "tags": [ "Sessions" ], "x-steel-cli": { "command": [ "sessions", "get" ] } } }, "/v1/sessions/{id}/agent-logs": { "get": { "description": "Query raw CDP-derived agent events (Input.dispatchMouseEvent, Input.dispatchKeyEvent, Page.navigate, …) for a session. For the semantic, replay-oriented interaction timeline use /sessions/:id/agent-traces instead.", "operationId": "get_session_agent_logs", "parameters": [ { "in": "query", "name": "namespace", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "startTime", "required": false, "schema": { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" } }, { "in": "query", "name": "endTime", "required": false, "schema": { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" } }, { "in": "query", "name": "eventTypes", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSessionAgentLogsResponse" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Get session agent logs", "tags": [ "Sessions" ], "x-steel-cli": { "command": [ "sessions", "agent-logs" ], "defaultFormat": "timeline" } } }, "/v1/sessions/{id}/agent-traces": { "get": { "description": "Query the semantic agent trace timeline for a session: a coalesced, replay-oriented record of user/agent interactions (clicks, typing, scrolls, drags, navigations) with target metadata (role, accessible name, selectors). Returns an empty list for sessions that predate browser-interaction capture.", "operationId": "get_session_agent_traces", "parameters": [ { "in": "query", "name": "namespace", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "startTime", "required": false, "schema": { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" } }, { "in": "query", "name": "endTime", "required": false, "schema": { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" } }, { "in": "query", "name": "eventTypes", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSessionAgentTracesResponse" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Get session agent traces", "tags": [ "Sessions" ], "x-steel-cli": { "command": [ "sessions", "traces" ], "defaultFormat": "timeline", "follow": { "path": "/v1/sessions/{id}/agent-traces", "transport": "websocket" } } } }, "/v1/sessions/{id}/context": { "get": { "description": "Fetches the context data of a specific session.", "operationId": "get_session_context", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionContextResponse" } } }, "description": "Session context data returned from a browser session." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Get session context", "tags": [ "Sessions" ] } }, "/v1/sessions/{id}/cost": { "get": { "description": "Returns the finalized cost of a released session as an exact amount in US dollars (e.g. 0.031905), suitable for precise billing passthrough.", "operationId": "get_session_cost", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionCostResponse" } } }, "description": "Session cost breakdown in US dollars" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Get session cost", "tags": [ "Sessions" ] } }, "/v1/sessions/{id}/events": { "get": { "description": "This endpoint allows you to get the recorded session events in the RRWeb format", "operationId": "get_session_events", "parameters": [ { "description": "Compress the events", "in": "query", "name": "compressed", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Optional pagination limit", "in": "query", "name": "limit", "required": false, "schema": { "default": 1000, "maximum": 1000, "minimum": 1, "type": "integer" } }, { "description": "Opaque pagination token. Pass the Next-Cursor header value to get the next page.", "in": "query", "name": "pointer", "required": false, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSessionEventsResponse" } } }, "description": "Events for a browser session" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Get recorded events", "tags": [ "Sessions" ] } }, "/v1/sessions/{id}/hls": { "get": { "description": "Get HLS playlist for a session recording using app auth or an RTC token", "operationId": "get_session_hls_playlist", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "description": "HLS M3U8 playlist.", "type": "string" } } }, "description": "HLS M3U8 playlist.", "headers": { "Content-Type": { "description": "application/vnd.apple.mpegurl", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Get HLS playlist", "tags": [ "Sessions" ] } }, "/v1/sessions/{id}/live-details": { "get": { "description": "Returns the live state of the session, including pages, tabs, and browser state", "operationId": "get_session_live_details", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionLiveDetailsResponse" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Get live session details", "tags": [ "Sessions" ] } }, "/v1/sessions/{id}/logs": { "get": { "description": "Query browser event logs for a session", "operationId": "get_session_logs", "parameters": [ { "in": "query", "name": "namespace", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "startTime", "required": false, "schema": { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" } }, { "in": "query", "name": "endTime", "required": false, "schema": { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" } }, { "in": "query", "name": "eventTypes", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 1000, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSessionLogsResponse" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Get session logs", "tags": [ "Sessions" ], "x-steel-cli": { "command": [ "sessions", "logs" ], "defaultFormat": "timeline", "follow": { "path": "/v1/sessions/{id}/logs", "transport": "websocket" } } } }, "/v1/sessions/{id}/release": { "post": { "description": "Releases a specific session by ID.", "operationId": "release_session", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseSessionResponse" } } }, "description": "Response for releasing a single session." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Release a session", "tags": [ "Sessions" ], "x-steel-cli": { "command": [ "sessions", "release" ] } } }, "/v1/sessions/{sessionId}/captchas/solve": { "post": { "description": "Solves captcha(s) for the session. If pageId, url, or taskId is provided, solves that specific captcha. If no parameters are provided, solves all detected captchas. Use this when autoCaptchaSolving is disabled in stealthConfig.", "operationId": "solve_captcha", "parameters": [ { "description": "Session ID", "in": "path", "name": "sessionId", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SolveCaptchaRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptchaActionResponse" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Solve captcha(s)", "tags": [ "Captchas" ] } }, "/v1/sessions/{sessionId}/captchas/solve-image": { "post": { "description": "Solves an image captcha using XPath selectors", "operationId": "solve_image_captcha", "parameters": [ { "description": "Session ID", "in": "path", "name": "sessionId", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SolveImageCaptchaRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptchaActionResponse" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Solve image captcha", "tags": [ "Captchas" ] } }, "/v1/sessions/{sessionId}/captchas/status": { "get": { "description": "Gets the current captcha status for a session", "operationId": "get_captcha_status", "parameters": [ { "description": "Session ID", "in": "path", "name": "sessionId", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptchaStateResponse" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Get captcha status", "tags": [ "Captchas" ] } }, "/v1/sessions/{sessionId}/computer": { "post": { "description": "Execute computer actions like mouse movements, clicks, keyboard input, and more", "operationId": "execute_computer_action", "parameters": [ { "description": "Session ID", "in": "path", "name": "sessionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerActionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComputerActionResponse" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Execute computer action", "tags": [ "Computer" ] } }, "/v1/sessions/{sessionId}/files": { "delete": { "description": "Delete all files from a session", "operationId": "delete_all_files", "parameters": [ { "in": "path", "name": "sessionId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "All files successfully deleted" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Delete all files", "tags": [ "Files" ] }, "get": { "description": "List all files from the session in descending order.", "operationId": "list_files", "parameters": [ { "in": "path", "name": "sessionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultipleFiles" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "List files", "tags": [ "Files" ] }, "post": { "description": "Uploads a file to a session via `multipart/form-data` with a `file` field that accepts either binary data or a URL string to download from, and an optional `path` field for the file storage path.", "operationId": "upload_file", "parameters": [ { "in": "path", "name": "sessionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FileUploadRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDetails" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Upload a file", "tags": [ "Files" ] } }, "/v1/sessions/{sessionId}/files.zip": { "get": { "description": "Download all files from the session as a zip archive.", "operationId": "download_archive", "parameters": [ { "in": "path", "name": "sessionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful download" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Download archive", "tags": [ "Files" ] } }, "/v1/sessions/{sessionId}/files/{path}": { "delete": { "description": "Delete a file from a session", "operationId": "delete_file", "parameters": [ { "in": "path", "name": "sessionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "File successfully deleted" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Delete a file", "tags": [ "Files" ] }, "get": { "description": "Download a file from a session", "operationId": "download_file", "parameters": [ { "in": "path", "name": "sessionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Successful download" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An error response from the API" } }, "summary": "Download a file", "tags": [ "Files" ] } } }, "security": [ { "apiKey": [] }, {} ], "servers": [ { "description": "Steel production server", "url": "https://api.steel.dev" } ] }