ShapeF5Token
API documentation for ShapeF5Token task type
Supported Providers
| Provider | Price per 1,000 | Routing |
|---|---|---|
 | $1.00 |
Request Schema
| Field | Type | Required | Description |
|---|---|---|---|
clientKey* | string | Yes | Your API key. Create one in the [AnySolver dashboard](/dashboard/api-keys). Example: |
task* | object | Yes | The task body. Required fields depend on the task type. See [Tasks](/docs/tasks) for per-task schemas. View task properties |
provider | No | Specific provider to use. If omitted, automatic routing selects the best provider. Example: | |
selectionMode | No | Routing strategy for this request. Overrides the API key default. See [Routing Strategies](/docs/getting-started/routing-strategies). Example: | |
keyPoolMode | No | Which provider key pool to use: `all` (default, uses AnySolver-managed keys and your own) or `platformOnly` (AnySolver-managed keys only). See [Key Pool Mode](/docs/getting-started/routing-strategies#key-pool-mode). Example: |
Task Object Properties
The task field accepts an object with the following properties:
| Field | Type | Required | Description |
|---|---|---|---|
type* | Yes | ||
targetUrl* | URL | Yes | Page URL where the target API is located. Example: |
targetApi* | URL | Yes | Real business API URL (e.g., search/order/login APIs). Example: |
shapeJsUrl* | URL | Yes | Shape JS URL. Usually find a JS file with seed= in the URL; the previous one is the shape_js_url. Example: |
title* | string | Yes | Title of the page where the target API is located (document.title). Example: |
method* | Yes | HTTP method consistent with the target API. Example: | |
proxy* | string | object | Yes | |
referer | URL | No | Referer of the page where the target API is located. Omit if target_url is the homepage. Example: |
Optional fields are not guaranteed across providers
Response Schema
| Field | Type | Required | Description |
|---|---|---|---|
status* | Yes | Task status: "processing", "ready", or "failed". Example: | |
errorId* | Yes | 0 = success, 1 = external error, 2 = internal error. Example: | |
taskId | string | No | Unique identifier returned when the task was created. Example: |
errorCode | No | Machine-readable error code. Example: | |
errorDescription | string | No | Human-readable error message with resolution hints. Example: |
cost | number | No | Actual cost charged for this task in USD. Example: |
taskType | No | The type of CAPTCHA task to solve. Example: | |
provider | No | Specific provider to use. If omitted, automatic routing selects the best provider. Example: | |
solution | object | No |
Solution Object Properties
The solution field contains an object with the following properties:
| Field | Type | Required | Description |
|---|---|---|---|
headers* | Record<string, unknown> | Yes | HTTP headers returned by the solver. Inject all of these into your request to the target API. Example: |
raw* | Record<string, unknown> | Yes | Raw provider response data for advanced use cases. |