LogoLogo
SupportDashboard
  • Community
  • Welcome to Hyperbrowser
  • Get Started
    • Quickstart
      • AI Agents
        • Browser Use
        • Claude Computer Use
        • OpenAI CUA
      • Web Scraping
        • Scrape
        • Crawl
        • Extract
      • Browser Automation
        • Puppeteer
        • Playwright
        • Selenium
  • Agents
    • Browser Use
    • Claude Computer Use
    • OpenAI CUA
  • HyperAgent
    • About HyperAgent
      • HyperAgent SDK
      • HyperAgent Types
  • Quickstart
  • Multi-Page actions
  • Custom Actions
  • MCP Support
    • Tutorial
  • Examples
    • Custom Actions
    • LLM support
    • Cloud Support
      • Setting Up
      • Proxies
      • Profiles
    • MCP Examples
      • Google Sheets
      • Weather
        • Weather Server
    • Output to Schema
  • Web Scraping
    • Scrape
    • Crawl
    • Extract
  • Sessions
    • Overview
      • Session Parameters
    • Advanced Privacy & Anti-Detection
      • Stealth Mode
      • Proxies
      • Static IPs
      • CAPTCHA Solving
      • Ad Blocking
    • Profiles
    • Recordings
    • Live View
    • Extensions
    • Downloads
  • Guides
    • Model Context Protocol
    • Scraping
    • AI Function Calling
    • Extract Information with an LLM
    • Using Hyperbrowser Session
    • CAPTCHA Solving
  • Integrations
    • ⛓️LangChain
    • 🦙LlamaIndex
  • reference
    • Pricing
    • SDKs
      • Node
        • Sessions
        • Profiles
        • Scrape
        • Crawl
        • Extensions
      • Python
        • Sessions
        • Profiles
        • Scrape
        • Crawl
        • Extensions
    • API Reference
      • Sessions
      • Scrape
      • Crawl
      • Extract
      • Agents
        • Browser Use
        • Claude Computer Use
        • OpenAI CUA
      • Profiles
      • Extensions
Powered by GitBook
On this page
Export as PDF
  1. reference
  2. API Reference

Profiles

PreviousOpenAI CUANextExtensions

Last updated 1 month ago

Delete profile by ID

delete
Authorizations
Path parameters
idstringRequired
Responses
200
Profile deleted
application/json
delete
DELETE /api/profile/{id} HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*
200

Profile deleted

{
  "success": true
}

Get list of profiles

get
Authorizations
Query parameters
pagenumberOptionalDefault: 1
limitnumberOptionalDefault: 10
namestringOptional
Responses
200
List of profiles
application/json
400
Invalid query parameters
application/json
500
Server error
application/json
get
GET /api/profiles HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*
{
  "profiles": [
    {
      "id": "text",
      "name": "text",
      "teamId": "text",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "totalCount": 1,
  "page": 1,
  "perPage": 1
}
  • POSTCreates a new profile
  • GETGet profile by ID
  • DELETEDelete profile by ID
  • GETGet list of profiles

Get profile by ID

get
Authorizations
Path parameters
idstringRequired
Responses
200
Profile details
application/json
404
Profile not found
application/json
get
GET /api/profile/{id} HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*
{
  "id": "text",
  "name": "text",
  "teamId": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

Creates a new profile

post
Authorizations
Body
namestringOptional
Responses
200
Profile created
application/json
post
POST /api/profile HTTP/1.1
Host: api.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
200

Profile created

{
  "id": "text",
  "name": "text"
}