---
title: "Create a session"
method: POST
path: "/v1/sessions"
tags: ["Sessions"]
---

# Create a session

`POST /v1/sessions`

Creates a new session with the provided configuration.

## Request body

- CreateSessionRequest, nullable — Request body schema for creating a new browser session.
  - `blockAds` boolean — Block ads in the browser session. Default is false.
  - `caCertificates` string[] — PEM-encoded root CA certificates to trust in this session. THIS IS CURRENTLY AN EXPERIMENTAL FEATURE.
  - `concurrency` integer — Number of sessions to create concurrently (check your plan limit)
  - `credentials` object — Configuration for session credentials
    - `autoSubmit` boolean
    - `blurFields` boolean
    - `exactOrigin` boolean
  - `debugConfig` object — Configuration for the debug URL and session viewer. Controls interaction capabilities, cursor visibility, and other debug-related settings.
    - `interactive` boolean — Allow interaction with the browser session via the debug URL viewer. When false, the session viewer will be view-only. Default is true.
    - `systemCursor` boolean — 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.
  - `deviceConfig` object — Device configuration for the session. Specify 'mobile' for mobile device fingerprints and configurations.
    - `device` 'desktop' | 'mobile'
  - `dimensions` object — 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.
    - `height` integer, required — Height of the session
    - `width` integer, required — Width of the session
  - `experimentalFeatures` string[] — Enable experimental features for the session.
  - `extensionIds` string[] — Array of extension IDs to install in the session. Use ['all_ext'] to install all uploaded extensions.
  - `fullscreen` boolean — Launch the browser in fullscreen mode, covering the full screen with no Chrome UI. Default is false.
  - `headless` boolean — Enable headless browser mode (disable Headful mode)
  - `inactivityTimeout` integer — 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.
  - `isSelenium` boolean — Enable Selenium mode for the browser session (default is false). Use this when you plan to connect to the browser session via Selenium.
  - `namespace` string — The namespace the session should be created against. Defaults to "default".
  - `optimizeBandwidth` union — Enable bandwidth optimizations. Passing true enables all flags (except hosts/patterns). Object allows granular control.
    - boolean
    - object
      - `blockHosts` string[]
      - `blockImages` boolean
      - `blockMedia` boolean
      - `blockStylesheets` boolean
      - `blockUrlPatterns` string[]
  - `persistProfile` boolean — This flag will persist the user profile for the session.
  - `profileId` string, uuid — This flag will set the profile for the session.
  - `projectId` string, uuid — The project to create the session in. When provided, the session namespace is resolved from the project.
  - `proxyUrl` string, uri — 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
  - `region` unknown
  - `sessionContext` object — Session context data to be used in the created session. Sessions will start with an empty context by default.
    - `cookies` object[] — Cookies to initialize in the session
      - `domain` string — The domain of the cookie
      - `expires` number — The expiration date of the cookie
      - `httpOnly` boolean — Whether the cookie is HTTP only
      - `name` string, required — The name of the cookie
      - `partitionKey` object — The partition key of the cookie
        - `hasCrossSiteAncestor` boolean, required — Indicates if the cookie has any ancestors that are cross-site to the topLevelSite.
        - `topLevelSite` string, required — The site of the top-level URL the browser was visiting at the start of the request to the endpoint that set the cookie.
      - `path` string — The path of the cookie
      - `priority` 'Low' | 'Medium' | 'High' — The priority of the cookie
      - `sameParty` boolean — Whether the cookie is a same party cookie
      - `sameSite` 'Strict' | 'Lax' | 'None' — The same site attribute of the cookie
      - `secure` boolean — Whether the cookie is secure
      - `session` boolean — Whether the cookie is a session cookie
      - `size` number — The size of the cookie
      - `sourcePort` number — The source port of the cookie
      - `sourceScheme` 'Unset' | 'NonSecure' | 'Secure' — The source scheme of the cookie
      - `url` string — The URL of the cookie
      - `value` string, required — The value of the cookie
    - `indexedDB` object — Domain-specific indexedDB items to initialize in the session
    - `localStorage` object — Domain-specific localStorage items to initialize in the session
    - `sessionStorage` object — Domain-specific sessionStorage items to initialize in the session
  - `sessionId` string, uuid — Optional custom UUID for the session
  - `solveCaptcha` boolean — Enable automatic captcha solving. Default is false.
  - `stealthConfig` object — Stealth configuration for the session
    - `autoCaptchaSolving` boolean — When true, captchas will be automatically solved when detected. When false, use the solve endpoints to manually initiate solving.
    - `humanizeInteractions` boolean — This flag will make the browser act more human-like by moving the mouse in a more natural way.
    - `skipFingerprintInjection` boolean — This flag will skip the fingerprint generation for the session.
  - `timeout` integer — Session timeout duration in milliseconds. Default is 300000 (5 minutes).
  - `useProxy` union
    - boolean — Simple boolean to enable/disable Steel proxies
    - object
      - `geolocation` object, required — Geographic location for the proxy
        - `city` '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' — City name (e.g., 'NEW_YORK', 'LOS_ANGELES')
        - `country` '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', required — Country code (e.g., 'US', 'GB', 'DE') - ISO 3166-1 alpha-2
        - `state` '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' — State code (e.g., 'NY', 'CA') - US states only
    - object
      - `server` string, required — Proxy server URL
    - object
      - `id` string — Specific fixed IP identifier. Omit to use any active fixed IP owned by the org.
      - `type` 'fixed', required — Use Steel fixed IP proxies
    - unknown
  - `userAgent` string — Custom user agent string for the browser session

## Response `201`

Represents the data structure for a browser session, including its configuration and status.

- SessionResponse — Represents the data structure for a browser session, including its configuration and status.
  - `createdAt` string, date-time, required — Timestamp when the session started
  - `creditsUsed` integer, required — Amount of credits consumed by the session
  - `debugConfig` object — Configuration for the debug URL and session viewer. Controls interaction capabilities and cursor visibility.
    - `interactive` boolean — Whether interaction is allowed via the debug URL viewer. When false, the session viewer is view-only.
    - `systemCursor` boolean — Whether the OS-level mouse cursor is shown in the WebRTC stream (headful mode only).
  - `debugUrl` string, required — URL for debugging the session
  - `deviceConfig` object — Device configuration for the session
    - `device` 'desktop' | 'mobile'
  - `dimensions` object, required — Viewport and browser window dimensions for the session
    - `height` integer, required — Height of the browser window
    - `width` integer, required — Width of the browser window
  - `duration` integer, required — Duration of the session in milliseconds
  - `eventCount` integer, required — Number of events processed in the session
  - `fullscreen` boolean — Launch the browser in fullscreen mode, covering the full screen with no Chrome UI.
  - `headless` boolean — Indicates if the session is headless or headful
  - `id` string, uuid, required — Unique identifier for the session
  - `inactivityTimeout` integer — Inactivity timeout in milliseconds, if one was set when the session was created
  - `isSelenium` boolean — Indicates if Selenium is used in the session
  - `optimizeBandwidth` object, required — Bandwidth optimizations that were applied to the session.
    - `blockHosts` string[]
    - `blockImages` boolean
    - `blockMedia` boolean
    - `blockStylesheets` boolean
    - `blockUrlPatterns` string[]
  - `persistProfile` boolean — This flag will persist the profile for the session.
  - `profileId` string, uuid — The ID of the profile associated with the session
  - `projectId` string, uuid, nullable — The project associated with the session
  - `proxyBytesUsed` integer, required — Amount of data transmitted through the proxy
  - `proxySource` 'steel' | 'external', nullable, required — Source of the proxy used for the session
  - `region` 'lax' | 'ord' | 'iad' | 'scl' | 'fra' | 'nrt' | 'us-east' | 'us-west' | 'us-central' | 'eu-west' | 'eu-central' | 'ap-northeast' | 'ap-southeast' | 'sa-east' — The region where the session was created.
  - `releaseReason` 'user_requested' | 'timeout' | 'inactivity_timeout' | 'creation_timeout' | 'startup_failed' | 'browser_closed' | 'browser_crashed', nullable — 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).
  - `sessionViewerUrl` string, required — URL to view session details
  - `solveCaptcha` boolean — Indicates if captcha solving is enabled
  - `status` 'live' | 'released' | 'failed', required — Status of the session
  - `stealthConfig` object — Stealth configuration for the session
    - `autoCaptchaSolving` boolean — When true, captchas will be automatically solved when detected. When false, use the solve endpoints to manually initiate solving.
    - `humanizeInteractions` boolean — This flag will make the browser act more human-like by moving the mouse in a more natural way
    - `skipFingerprintInjection` boolean — This flag will skip the fingerprint generation for the session.
  - `timeout` integer, required — Session timeout duration in milliseconds
  - `userAgent` string — User agent string used in the session
  - `websocketUrl` string, required — URL for the session's WebSocket connection

## Other responses

- `400` — An error response from the API
- `403` — An error response from the API
- `409` — An error response from the API
- `422` — An error response from the API
- `429` — An error response from the API
- `500` — An error response from the API
- `503` — An error response from the API
- `504` — An error response from the API

---

[API](https://skmtc.net/steel-dev/apis/steel-api.md) · [All operations](https://skmtc.net/steel-dev/apis/steel-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/steel-dev/steel-api/versions/2248d956188a/schema)