> ## Documentation Index
> Fetch the complete documentation index at: https://browseruse-0aece648-larsen-v1-unified-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Browser

> Provision a standalone browser. Billed upfront for the timeout window;
unused time refunded on stop. Faithful port of the v2 create orchestration.



## OpenAPI

````yaml /cloud/openapi/v1.json post /browsers
openapi: 3.1.0
info:
  title: Browser Use API v1
  summary: Unified /api/v1 preview spec, non-production only
  version: 1.0.0
servers:
  - url: https://api-staging-ufcbwvyv9yifyyvc3.browser-use.com/api/v1
    description: Browser Use API v1 (staging)
security: []
paths:
  /browsers:
    post:
      tags:
        - Browsers
      summary: Create Browser
      description: >-
        Provision a standalone browser. Billed upfront for the timeout window;

        unused time refunded on stop. Faithful port of the v2 create
        orchestration.
      operationId: create_browser_browsers_post
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/CreateBrowser'
                - type: 'null'
              title: Body
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Browser'
        '402':
          description: Insufficient credits.
        '403':
          description: Timeout over cap, or custom proxy without a plan.
        '404':
          description: Profile not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileNotFoundError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Too many concurrent browsers.
        '503':
          description: Browser service unavailable.
      security:
        - APIKeyHeader: []
components:
  schemas:
    CreateBrowser:
      properties:
        browserProfileId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Browserprofileid
          description: Start logged-in with this saved profile.
        proxyCountryCode:
          anyOf:
            - $ref: '#/components/schemas/ProxyCountryCode'
            - type: 'null'
          description: Residential proxy country, e.g. 'us', 'de'. Null disables the proxy.
        screenWidth:
          anyOf:
            - type: integer
            - type: 'null'
          title: Screenwidth
          description: Viewport width in px.
        screenHeight:
          anyOf:
            - type: integer
            - type: 'null'
          title: Screenheight
          description: Viewport height in px.
        customProxy:
          anyOf:
            - $ref: '#/components/schemas/StrictCustomProxy'
            - type: 'null'
          description: Your own proxy; overrides proxyCountryCode.
        enableRecording:
          type: boolean
          title: Enablerecording
          description: Record the session as an mp4.
          default: false
        timeout:
          type: integer
          maximum: 240
          minimum: 1
          title: Timeout
          description: >-
            Minutes before auto-stop (max 240). Billed upfront, unused time
            refunded on stop.
          default: 60
      additionalProperties: false
      type: object
      title: CreateBrowser
      description: Provision a browser. All fields optional; sensible defaults.
    Browser:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        status:
          type: string
          enum:
            - active
            - stopped
          title: Status
          description: '''active'' (running) or ''stopped''.'
        cdpUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Cdpurl
          description: Chrome DevTools Protocol endpoint. Null until the browser is booted.
        liveViewUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Liveviewurl
          description: Watch the browser live in a tab. Null until booted.
        agentSessionId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Agentsessionid
          description: The agent session that used this browser, if any.
        createdAt:
          type: string
          format: date-time
          title: Createdat
      type: object
      required:
        - id
        - status
        - createdAt
      title: Browser
    ProfileNotFoundError:
      properties:
        detail:
          type: string
          title: Detail
          description: Human-readable error message
      type: object
      required:
        - detail
      title: ProfileNotFoundError
      description: browser_profile_id does not resolve in this project.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ProxyCountryCode:
      type: string
      enum:
        - ad
        - ae
        - af
        - ag
        - ai
        - al
        - am
        - an
        - ao
        - aq
        - ar
        - as
        - at
        - au
        - aw
        - az
        - ba
        - bb
        - bd
        - be
        - bf
        - bg
        - bh
        - bi
        - bj
        - bl
        - bm
        - bn
        - bo
        - bq
        - br
        - bs
        - bt
        - bv
        - bw
        - by
        - bz
        - ca
        - cc
        - cd
        - cf
        - cg
        - ch
        - ci
        - ck
        - cl
        - cm
        - co
        - cr
        - cs
        - cu
        - cv
        - cw
        - cx
        - cy
        - cz
        - de
        - dj
        - dk
        - dm
        - do
        - dz
        - ec
        - ee
        - eg
        - eh
        - er
        - es
        - et
        - fi
        - fj
        - fk
        - fm
        - fo
        - fr
        - ga
        - gd
        - ge
        - gf
        - gg
        - gh
        - gi
        - gl
        - gm
        - gn
        - gp
        - gq
        - gr
        - gs
        - gt
        - gu
        - gw
        - gy
        - hk
        - hm
        - hn
        - hr
        - ht
        - hu
        - id
        - ie
        - il
        - im
        - in
        - iq
        - ir
        - is
        - it
        - je
        - jm
        - jo
        - jp
        - ke
        - kg
        - kh
        - ki
        - km
        - kn
        - kp
        - kr
        - kw
        - ky
        - kz
        - la
        - lb
        - lc
        - li
        - lk
        - lr
        - ls
        - lt
        - lu
        - lv
        - ly
        - ma
        - mc
        - md
        - me
        - mf
        - mg
        - mh
        - mk
        - ml
        - mm
        - mn
        - mo
        - mp
        - mq
        - mr
        - ms
        - mt
        - mu
        - mv
        - mw
        - mx
        - my
        - mz
        - na
        - nc
        - ne
        - nf
        - ng
        - ni
        - nl
        - 'no'
        - np
        - nr
        - nu
        - nz
        - om
        - pa
        - pe
        - pf
        - pg
        - ph
        - pk
        - pl
        - pm
        - pn
        - pr
        - ps
        - pt
        - pw
        - py
        - qa
        - re
        - ro
        - rs
        - ru
        - rw
        - sa
        - sb
        - sc
        - sd
        - se
        - sg
        - sh
        - si
        - sj
        - sk
        - sl
        - sm
        - sn
        - so
        - sr
        - ss
        - st
        - sv
        - sx
        - sy
        - sz
        - tc
        - td
        - tf
        - tg
        - th
        - tj
        - tk
        - tl
        - tm
        - tn
        - to
        - tr
        - tt
        - tv
        - tw
        - tz
        - ua
        - ug
        - uk
        - us
        - uy
        - uz
        - va
        - vc
        - ve
        - vg
        - vi
        - vn
        - vu
        - wf
        - ws
        - xk
        - ye
        - yt
        - za
        - zm
        - zw
      title: ProxyCountryCode
    StrictCustomProxy:
      properties:
        host:
          type: string
          maxLength: 255
          minLength: 1
          title: Host
          description: Host of the proxy.
        port:
          type: integer
          maximum: 65535
          minimum: 1
          title: Port
          description: Port of the proxy.
        username:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: Username
          description: Username for proxy authentication.
        password:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: Password
          description: Password for proxy authentication.
        ignoreCertErrors:
          type: boolean
          title: Ignore Certificate Errors
          description: >-
            Ignore TLS certificate errors. Enable this if your proxy uses a
            self-signed or untrusted certificate (e.g. Burp Suite, corporate
            proxies).
          default: false
      additionalProperties: false
      type: object
      required:
        - host
        - port
      title: StrictCustomProxy
      description: |-
        Shared CustomProxy made strict. forbid-extra doesn't cascade into nested
        models, so the nested proxy needs its own forbid to catch typo'd keys.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-Browser-Use-API-Key

````