Hover Element
POST /v1/browser/interactions/hover
Move the pointer over one element in the active tab of your browser session.
Name the element with exactly one of selector or element_ref. If the browser's reply is
lost, the call still returns 200 with success false and error_code outcome_unknown:
inspect the page before you retry.
Authentication
Requires authentication via: OAuth2PasswordBearer.
Parameters
| Name | In | Type | Required | Description | Constraints |
|---|---|---|---|---|---|
X-API-Key | header | string | null | No | nullable |
Request Body
Required: Yes
application/json
Resolved schema:
{
"properties": {
"selector": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Selector"
},
"element_ref": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Element Ref"
},
"session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Id"
},
"timeout": {
"type": "integer",
"maximum": 30000,
"minimum": 1,
"title": "Timeout",
"default": 15000
}
},
"type": "object",
"title": "BrowserTargetRequest",
"description": "Exactly one current observed reference or unique selector."
}
Field details:
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
selector | string | null | No | nullable | |
element_ref | string | null | No | nullable | |
session_id | string | null | No | nullable | |
timeout | integer | No | default=15000, min=1, max=30000 |
Responses
200
Successful Response
application/json
Resolved schema:
{
"properties": {
"success": {
"type": "boolean",
"title": "Success"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message"
},
"execution_time": {
"type": "number",
"title": "Execution Time"
},
"session_id": {
"type": "string",
"title": "Session Id"
},
"data": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Data"
}
},
"type": "object",
"required": [
"success",
"execution_time",
"session_id"
],
"title": "BrowserInteractionResponse",
"description": "Generic response for browser interactions"
}
Field details:
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
success | boolean | Yes | ||
message | string | null | No | nullable | |
execution_time | number | Yes | ||
session_id | string | Yes | ||
data | object | null | No | nullable |
400
session_id is missing or empty.
No response body.
401
No credentials, or the Bearer token / X-API-Key is invalid.
No response body.
403
The account is disabled, or a guest token was used.
No response body.
404
Session not found, expired, or not yours.
No response body.
422
Validation Error
application/json
Resolved schema:
{
"properties": {
"detail": {
"items": {
"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"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
Field details:
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
detail | array<object> | No | ||
detail[] | object | No | ||
detail[].loc | array<string | integer> | No | ||
detail[].loc[] | string | integer | No | ||
detail[].msg | string | No | ||
detail[].type | string | No |