Sign in

v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB

Collect Automation Intelligence.

The Automation Intelligence API (in public preview) gives you the tools to determine whether traffic is legitimate and should be accepted by your application.

The API detects automation tools like AI Agents, AI Assistants and AI Browsers. Additionally it provides IP intelligence like geolocation and data center detection.

Event Retrieval

Events created by the Automation Intelligence API can be fetched via the /v4/events/{event_id} API using the event_id present in the API response.

Fetch all Automation Intelligence API events via the /v4/events?source=edge API.

post/edge

Request body

methodstring required

HTTP method of the request. Preserve the original HTTP method of the request, including casing.

urlstring uri required

Absolute URL of the request, without a #fragment suffix. Only HTTP and HTTPS schemes are supported.

ipv4_addressstring ipv4

Client IPv4 address observed by your server.

ipv6_addressstring ipv6

Client IPv6 address observed by your server.

linked_idstring

A customer-provided id that was sent with the request.

tagsTags

A customer-provided value or an object that was sent with the identification request or updated later.

Response

OK.

event_idstring required

Unique identifier of the user's request. The first portion of the event_id is a unix epoch milliseconds timestamp.

timestampinteger required

Timestamp of the event with millisecond precision in Unix time.

linked_idstring

A customer-provided id that was sent with the request.

tagsTags

A customer-provided value or an object that was sent with the identification request or updated later.

urlstring

Page URL from which the request was sent.

proxyboolean

IP address was used by a public proxy provider or belonged to a known recent residential proxy

proxy_confidence'low' | 'medium' | 'high'

Confidence level of the proxy detection. If a proxy is not detected, confidence is "high". If it's detected, can be "low", "medium", or "high".

vpnboolean

VPN or other anonymizing service has been used when sending the request.

vpn_confidence'low' | 'medium' | 'high'

A confidence rating for the VPN detection result — "low", "medium", or "high". Depends on the combination of results returned from all VPN detection methods.