hyperbrowser/openapi/hyperbrowser-profiles-api-openapi.yml at main · api-evangelist/hyperbrowser · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
openapi: 3.0.1
info:
  title: Hyperbrowser Agents Profiles API
  version: 1.0.0
  description: Start, stop, and monitor agentic browser tasks across HyperAgent, Browser-Use, Claude Computer Use, Gemini Computer Use, and OpenAI CUA.
  contact:
    name: Hyperbrowser
    url: https://hyperbrowser.ai
  license:
    name: Hyperbrowser Terms
    url: https://hyperbrowser.ai/terms
servers:
- url: https://api.hyperbrowser.ai
  description: Production server
security:
- ApiKeyAuth: []
tags:
- name: Profiles
paths:
  /api/profiles:
    get:
      summary: Get list of profiles
      security:
      - ApiKeyAuth: []
      x-codeSamples:
      - lang: javascript
        label: List profiles
        source: "import { Hyperbrowser } from '@hyperbrowser/sdk';\n\nconst client = new Hyperbrowser({ apiKey: 'your-api-key' });\n\nawait client.profiles.list({\n  page: 1\n});"
      - lang: python
        label: List profiles
        source: "from hyperbrowser import Hyperbrowser\nfrom hyperbrowser.models import ProfileListParams\n\nclient = Hyperbrowser(api_key='your-api-key')\n\nclient.profiles.list(ProfileListParams(\n  page=1\n))"
      parameters:
      - name: page
        in: query
        schema:
          type: number
          default: 1
      - name: limit
        in: query
        schema:
          type: number
          default: 10
      - name: name
        in: query
        schema:
          type: string
      responses:
        '200':
          description: List of profiles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileListResponse'
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
      - Profiles
  /api/profile:
    post:
      operationId: post-api-profile
      summary: Creates a New Profile
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProfileParams'
      responses:
        '200':
          description: Profile created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProfileResponse'
      security:
      - ApiKeyAuth: []
      tags:
      - Profiles
  /api/profile/{id}:
    get:
      operationId: get-api-profile-id
      summary: Get Profile by ID
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Profile details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProfileResponse'
        '404':
          description: Profile not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      tags:
      - Profiles
    delete:
      operationId: delete-api-profile-id
      summary: Delete Profile by ID
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Profile deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicResponse'
      security:
      - ApiKeyAuth: []
      tags:
      - Profiles
components:
  schemas:
    CreateProfileParams:
      type: object
      properties:
        name:
          type: string
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
    CreateProfileResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
    ProfileListResponse:
      type: object
      properties:
        profiles:
          type: array
          items:
            $ref: '#/components/schemas/ProfileResponse'
        totalCount:
          type: number
        page:
          type: number
        perPage:
          type: number
    BasicResponse:
      type: object
      properties:
        success:
          type: boolean
    ProfileResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
        teamId:
          type: string
        createdAt:
          type: string
          format: iso8601
        updatedAt:
          type: string
          format: iso8601
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Account API key from app.hyperbrowser.ai