Browser Use

Browser Use Profiles API

The Profiles API from Browser Use — 2 operation(s) for profiles.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /profiles List or search browser profiles · List Profiles #
Ask an LLM
“Which saved browser profiles do I have in my project?”
“Can I search profiles by name or by the user ID I assigned to them?”
Tell an agent
Find the browser profile for user {query}.
List my browser profiles, page {page} with {size} per page.
POST /profiles Create a browser profile to keep logins · Create Profile #
Ask an LLM
“How do I keep an agent logged in to a site between tasks?”
“Can I tag a new browser profile with my own internal user ID?”
Tell an agent
Create a browser profile named {name} for user {user_id}.
Make a new profile so this customer's login state persists across tasks.
GET /profiles/{profile_id} Get a browser profile's details · Get Profile #
Ask an LLM
“What name and user ID are attached to a particular browser profile?”
“Can I look up one specific browser profile by its ID?”
Tell an agent
Show the details of browser profile {profile_id}.
Look up profile {profile_id} and tell me which user it belongs to.
PATCH /profiles/{profile_id} Rename a profile or change its user ID · Update Profile #
Ask an LLM
“Can I rename an existing browser profile?”
“How do I change the user ID linked to a profile I already created?”
Tell an agent
Rename browser profile {profile_id} to {name}.
Set the user ID on existing profile {profile_id} to {user_id}.
DELETE /profiles/{profile_id} Permanently delete a browser profile · Delete Browser Profile #
Ask an LLM
“How do I remove a saved browser profile and its stored login state?”
“Is deleting a browser profile permanent?”
Tell an agent destructive · confirm first
Delete browser profile {profile_id} permanently.
Remove the profile {profile_id} for a user who closed their account.

Documentation

📖
APIReference
https://browser-use.com/api
📖
Documentation
https://docs.browser-use.com/cloud/api-v4-overview
📖
Documentation
https://docs.browser-use.com/cloud/api-reference
📖
Documentation
https://docs.browser-use.com/cloud/api-v2-overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/browser-use/refs/heads/main/openapi/browser-use-profiles-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/browser-use/refs/heads/main/data-model/browser-use-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/browser-use:browser-use-profiles-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

browser-use-profiles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Browser Use Profiles API
  version: '1.0'
  description: 'Operations tagged Profiles across 3 of this provider''s published API definitions: browser-use-api-v2-openapi.json, browser-use-api-v3-openapi.json, browser-use-api-v4-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.browser-use.com/api/v2
  description: Production server
- url: https://api.browser-use.com/api/v3
  description: Production server
- url: https://api.browser-use.com/api/v4
  description: Production server
tags:
- name: Profiles
paths:
  /profiles:
    get:
      tags:
      - Profiles
      summary: List Profiles
      description: 'Get paginated list of profiles.


        Use the `query` parameter to search profiles by name or user_id.

        This is useful when you have many profiles and need to find a specific user.


        Example: If you set `user_id` to your internal user identifier when creating profiles,

        you can later search for that user by passing their identifier as the `query` parameter.'
      operationId: list_profiles_profiles_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: pageSize
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 10
          title: Pagesize
      - name: pageNumber
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          title: Pagenumber
      - name: query
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Profiles
      summary: Create Profile
      description: 'Profiles allow you to preserve the state of the browser between tasks.


        They are most commonly used to allow users to preserve the log-in state in the agent between tasks.

        You''d normally create one profile per user and then use it for all their tasks.


        You can set a `user_id` when creating a profile to associate it with a user in your system.

        This allows you to later search for the profile using the GET /profiles endpoint with a query parameter.'
      operationId: create_profile_profiles_post
      security:
      - APIKeyHeader: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProfileCreateRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileView'
        '402':
          description: Subscription required for additional profiles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsufficientCreditsError'
        '422':
          description: Request validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
    servers:
    - url: https://api.browser-use.com/api/v2
      description: Production server
  /profiles/{profile_id}:
    get:
      tags:
      - Profiles
      summary: Get Profile
      description: Get profile details.
      operationId: get_profile_profiles__profile_id__get
      security:
      - APIKeyHeader: []
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Profile Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileView'
        '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'
    patch:
      tags:
      - Profiles
      summary: Update Profile
      description: Update a browser profile's information.
      operationId: update_profile_profiles__profile_id__patch
      security:
      - APIKeyHeader: []
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Profile Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProfileUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileView'
        '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'
    delete:
      tags:
      - Profiles
      summary: Delete Browser Profile
      description: Permanently delete a browser profile and its configuration.
      operationId: delete_browser_profile_profiles__profile_id__delete
      security:
      - APIKeyHeader: []
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Profile Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: https://api.browser-use.com/api/v2
      description: Production server
components:
  schemas:
    ProfileUpdateRequest:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: Name
          description: Optional name for the profile
        userId:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: User ID
          description: Your internal user identifier for this profile. Use this to associate a profile with a user in your system.
      type: object
      title: ProfileUpdateRequest
      description: Request model for updating a profile.
    ProfileCreateRequest:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: Name
          description: Optional name for the profile
        userId:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: User ID
          description: Your internal user identifier for this profile. Use this to associate a profile with a user in your system.
      type: object
      title: ProfileCreateRequest
      description: Request model for creating a new profile.
    InsufficientCreditsError:
      properties:
        detail:
          type: string
          title: Detail
          default: Insufficient credits
      type: object
      title: InsufficientCreditsError
      description: Error response when there are insufficient credits
    ProfileNotFoundError:
      properties:
        detail:
          type: string
          title: Detail
          default: Profile not found
      type: object
      title: ProfileNotFoundError
      description: Error response when a profile is not found
    ProfileListResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ProfileView'
          type: array
          title: Items
          description: List of profile views for the current page
        totalItems:
          type: integer
          title: Total Items
          description: Total number of items in the list
        pageNumber:
          type: integer
          title: Page Number
          description: Page number
        pageSize:
          type: integer
          title: Page Size
          description: Number of items per page
      type: object
      required:
      - items
      - totalItems
      - pageNumber
      - pageSize
      title: ProfileListResponse
      description: Response model for paginated profile list requests.
    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
    ProfileView:
      properties:
        id:
          type: string
          format: uuid
          title: ID
          description: Unique identifier for the profile
        userId:
          anyOf:
          - type: string
          - type: 'null'
          title: User ID
          description: Your internal user identifier for this profile. Use this to associate a profile with a user in your system.
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
          description: Optional name for the profile
        lastUsedAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Used At
          description: Timestamp when the profile was last used
        createdAt:
          type: string
          format: date-time
          title: Created At
          description: Timestamp when the profile was created
        updatedAt:
          type: string
          format: date-time
          title: Updated At
          description: Timestamp when the profile was last updated
        cookieDomains:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Cookie Domains
          description: List of domain URLs that have cookies stored for this profile
      type: object
      required:
      - id
      - createdAt
      - updatedAt
      title: ProfileView
      description: 'View model for representing a profile. A profile lets you preserve the login state between sessions.


        We recommend that you create a separate profile for each user of your app.

        You can assign a user_id to each profile to easily identify which user the profile belongs to.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-Browser-Use-API-Key
x-refined-from:
- browser-use-api-v2-openapi.json
- browser-use-api-v3-openapi.json
- browser-use-api-v4-openapi.json