Edge API Request Parameters
Coming Soon:
The Edge API is part of the Arkose Edge Product and is currently under development. It is expected to launch in early Q3-2025. The specifications below are tentative and might change.
Overview
This document outlines how to make POST requests to the Arkose Labs Edge API, including endpoint structure, required headers, and request body format.
API Access Methods
Edge API can be accessed via a direct HTTP request.
Request URL format:
https://client-api.arkoselabs.com/api/edge/v1/<public_key>
Example using curl:
curl https://client-api.arkoselabs.com/api/edge/v1/<public_key> \
-H "Content-Type: application/json" \
-d '{"private_key": "<private_key>", "ip_address": "1.2.3.4"}'
Request Header Parameters
Name | Type | Required / Optional | Description |
---|---|---|---|
private_key | string | Required | The private key issued by Arkose Labs along with the public key used for the client-side API. |
ip_address | string | Required | IP address of the client making the request. |
os | string | No | Operating system name (e.g., "OS X", "Windows"). |
os_version | string | No | Version of the OS (e.g., "10.15"). |
platform | string | No | Platform (e.g., "MacIntel", "Win32"). |
ja3 | string | No | JA3 fingerprint of the TLS Client Hello. |
ja4 | string | No | JA4 fingerprint (includes more TLS details). |
email_address | string | No | Email address from the request, if applicable. |
headers | object | No | HTTP headers from the client request (key-value pairs). |
request.method | string | No | HTTP method used by the client (e.g., GET, POST). |
request.protocol | string | No | Protocol used in the client request (e.g., "http", "https"). |
request.path | string | No | Path of the request URL (e.g., "/home"). |
tls.cipher | string | No | TLS cipher suite used (e.g., "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"). |
tls.protocol | string | No | TLS protocol version (e.g., "TLSv1.3"). |
Request Schema with Example
The POST request should include a JSON body structure as show in the example below.
{
"private_key": "B4DFA9BC-XXXX-XXXX-XXXX-D24DD4C8C27D",
"ip_address": "11.22.33.44",
"os": "OS X",
"os_version": "10.15",
"platform": "MacIntel",
"ja3": "e7d705a3286e19ea42f587b344ee6865",
"ja4": "t13d1516h2_8daaf6152771a5b3",
"email_address": "[email protected]",
"headers": {
"Accept": "*/*",
"User-Agent": "Mozilla/5.0 ..."
},
"request": {
"method": "GET",
"protocol": "https",
"path": "/some-website"
},
"tls": {
"cipher": "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
"protocol": "TLSv1.3"
}
}
Updated 24 days ago