# Product reviews

Query stored Amazon reviews with optional date, single-star and verified-purchase filters. Reviews may belong to other listing variants; this does not start a live collection.

ID: task:amazon_product_reviews_v1 · Region: global · Status: available

catalog_version: 938eb1e3bdb6476050bf2983e6e8db1edcf9f0942d16c7ebd2029dcd28295afe
updated_at: 2026-10-21T10:40:52.196893+00:00

Amazon

Dataset releases define historical periods; live reads describe request-time data and do not guarantee completeness.

Docs: https://docs.kleardata.ai/capabilities/task%3Aamazon_product_reviews_v1

## GET /v1/collections/tasks/amazon_product_reviews_v1

legacy · available · api_key, oauth

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.



Existing pricing applies; metadata reads do not charge Credits.

Where the request declares idempotency_key, reuse it for the same operation; metadata GET is read-only.

A pending response supplies a result/status reference. Read it first; do not automatically resubmit paid execution after a timeout or ambiguous result. Correct 401/403/422 errors before retrying.

### Input schema / 输入契约

```json
{
  "properties": {
    "task_code": {
      "const": "amazon_product_reviews_v1"
    },
    "task_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional task attribution: when provided, write one concise, self-contained task_query in the user's language and reuse that exact value in every call for the task, including discovery, search, approval retry, results, export, and status checks. For MCP calls, when omitted, Asklear records a generic non-user-specific attribution so compatible clients can still call the tool. REST calls may omit it and remain unattributed. It is a task description, not a task identifier. Do not include hidden reasoning, credentials, or direct personal identifiers such as phone numbers, email addresses, identity numbers, or street addresses.",
      "maxLength": 300
    }
  },
  "required": [
    "task_code"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "task_code": "amazon_product_reviews_v1"
}
```

### Synthetic response / 合成响应

```json
{
  "examples": [
    {
      "country": "US",
      "page": 1,
      "product": "B08LYNQ8LC",
      "since": "2021-01-21",
      "star": "5"
    }
  ],
  "input_schema": {
    "additionalProperties": false,
    "properties": {
      "country": {
        "default": "US",
        "enum": [
          "US",
          "GB",
          "DE",
          "FR",
          "IN",
          "CA",
          "JP",
          "ES",
          "IT",
          "MX",
          "AE",
          "AU",
          "BR",
          "SA"
        ],
        "type": "string"
      },
      "page": {
        "default": 1,
        "maximum": 10000,
        "minimum": 1,
        "type": "integer"
      },
      "product": {
        "maxLength": 2048,
        "minLength": 10,
        "type": "string",
        "ui_default": ""
      },
      "since": {
        "default": "",
        "maxLength": 10,
        "type": "string"
      },
      "star": {
        "default": "all",
        "enum": [
          "all",
          "1",
          "2",
          "3",
          "4",
          "5"
        ],
        "type": "string"
      },
      "verified_purchase_only": {
        "default": "false",
        "enum": [
          "false",
          "true"
        ],
        "type": "string"
      }
    },
    "required": [
      "product"
    ],
    "type": "object"
  }
}
```

- input_schema (object): No field description available
- examples (array<object>): No field description available
## describe_collection_task

legacy · available · api_key, oauth

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.



Existing pricing applies; metadata reads do not charge Credits.

Where the request declares idempotency_key, reuse it for the same operation; metadata GET is read-only.

A pending response supplies a result/status reference. Read it first; do not automatically resubmit paid execution after a timeout or ambiguous result. Correct 401/403/422 errors before retrying.

### Input schema / 输入契约

```json
{
  "properties": {
    "task_code": {
      "const": "amazon_product_reviews_v1"
    },
    "task_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional task attribution: when provided, write one concise, self-contained task_query in the user's language and reuse that exact value in every call for the task, including discovery, search, approval retry, results, export, and status checks. For MCP calls, when omitted, Asklear records a generic non-user-specific attribution so compatible clients can still call the tool. REST calls may omit it and remain unattributed. It is a task description, not a task identifier. Do not include hidden reasoning, credentials, or direct personal identifiers such as phone numbers, email addresses, identity numbers, or street addresses.",
      "maxLength": 300
    }
  },
  "required": [
    "task_code"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "task_code": "amazon_product_reviews_v1"
}
```

### Synthetic response / 合成响应

```json
{
  "examples": [
    {
      "country": "US",
      "page": 1,
      "product": "B08LYNQ8LC",
      "since": "2021-01-21",
      "star": "5"
    }
  ],
  "input_schema": {
    "additionalProperties": false,
    "properties": {
      "country": {
        "default": "US",
        "enum": [
          "US",
          "GB",
          "DE",
          "FR",
          "IN",
          "CA",
          "JP",
          "ES",
          "IT",
          "MX",
          "AE",
          "AU",
          "BR",
          "SA"
        ],
        "type": "string"
      },
      "page": {
        "default": 1,
        "maximum": 10000,
        "minimum": 1,
        "type": "integer"
      },
      "product": {
        "maxLength": 2048,
        "minLength": 10,
        "type": "string",
        "ui_default": ""
      },
      "since": {
        "default": "",
        "maxLength": 10,
        "type": "string"
      },
      "star": {
        "default": "all",
        "enum": [
          "all",
          "1",
          "2",
          "3",
          "4",
          "5"
        ],
        "type": "string"
      },
      "verified_purchase_only": {
        "default": "false",
        "enum": [
          "false",
          "true"
        ],
        "type": "string"
      }
    },
    "required": [
      "product"
    ],
    "type": "object"
  }
}
```

- input_schema (object): No field description available
- examples (array<object>): No field description available
## asklear collection describe

legacy · unavailable · api_key, oauth

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.



Existing pricing applies; metadata reads do not charge Credits.

Where the request declares idempotency_key, reuse it for the same operation; metadata GET is read-only.

A pending response supplies a result/status reference. Read it first; do not automatically resubmit paid execution after a timeout or ambiguous result. Correct 401/403/422 errors before retrying.

### Input schema / 输入契约

```json
{
  "properties": {
    "task_code": {
      "const": "amazon_product_reviews_v1"
    },
    "task_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional task attribution: when provided, write one concise, self-contained task_query in the user's language and reuse that exact value in every call for the task, including discovery, search, approval retry, results, export, and status checks. For MCP calls, when omitted, Asklear records a generic non-user-specific attribution so compatible clients can still call the tool. REST calls may omit it and remain unattributed. It is a task description, not a task identifier. Do not include hidden reasoning, credentials, or direct personal identifiers such as phone numbers, email addresses, identity numbers, or street addresses.",
      "maxLength": 300
    }
  },
  "required": [
    "task_code"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "task_code": "amazon_product_reviews_v1"
}
```

### Synthetic response / 合成响应

```json
{
  "examples": [
    {
      "country": "US",
      "page": 1,
      "product": "B08LYNQ8LC",
      "since": "2021-01-21",
      "star": "5"
    }
  ],
  "input_schema": {
    "additionalProperties": false,
    "properties": {
      "country": {
        "default": "US",
        "enum": [
          "US",
          "GB",
          "DE",
          "FR",
          "IN",
          "CA",
          "JP",
          "ES",
          "IT",
          "MX",
          "AE",
          "AU",
          "BR",
          "SA"
        ],
        "type": "string"
      },
      "page": {
        "default": 1,
        "maximum": 10000,
        "minimum": 1,
        "type": "integer"
      },
      "product": {
        "maxLength": 2048,
        "minLength": 10,
        "type": "string",
        "ui_default": ""
      },
      "since": {
        "default": "",
        "maxLength": 10,
        "type": "string"
      },
      "star": {
        "default": "all",
        "enum": [
          "all",
          "1",
          "2",
          "3",
          "4",
          "5"
        ],
        "type": "string"
      },
      "verified_purchase_only": {
        "default": "false",
        "enum": [
          "false",
          "true"
        ],
        "type": "string"
      }
    },
    "required": [
      "product"
    ],
    "type": "object"
  }
}
```

- input_schema (object): No field description available
- examples (array<object>): No field description available
## POST /v1/collections/estimate

legacy · available · api_key, oauth

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.

One product or one page per request. Each successful request, including an empty page, is charged independently.
Listing sales are estimates and may cover multiple variants. Published ASIN sales are not exact real-time sales.
Amounts use the currency's minor unit; JPY has no fractional unit. Missing data is null, not zero.
Stored reviews may be delayed and refer to other variants. No live review collection is started.
14 marketplaces are supported by the source contract; live verification is recorded separately.

49 Credits per successful task; estimate before starting.

Where the request declares idempotency_key, reuse it for the same operation; metadata GET is read-only.

A pending response supplies a result/status reference. Read it first; do not automatically resubmit paid execution after a timeout or ambiguous result. Correct 401/403/422 errors before retrying.

### Input schema / 输入契约

```json
{
  "$defs": {},
  "additionalProperties": false,
  "description": "Outer transport contract; each registered task validates its own input.",
  "properties": {
    "input": {
      "additionalProperties": false,
      "properties": {
        "country": {
          "default": "US",
          "enum": [
            "US",
            "GB",
            "DE",
            "FR",
            "IN",
            "CA",
            "JP",
            "ES",
            "IT",
            "MX",
            "AE",
            "AU",
            "BR",
            "SA"
          ],
          "type": "string"
        },
        "page": {
          "default": 1,
          "maximum": 10000,
          "minimum": 1,
          "type": "integer"
        },
        "product": {
          "maxLength": 2048,
          "minLength": 10,
          "type": "string"
        },
        "since": {
          "default": "",
          "maxLength": 10,
          "type": "string"
        },
        "star": {
          "default": "all",
          "enum": [
            "all",
            "1",
            "2",
            "3",
            "4",
            "5"
          ],
          "type": "string"
        },
        "verified_purchase_only": {
          "default": "false",
          "enum": [
            "false",
            "true"
          ],
          "type": "string"
        }
      },
      "required": [
        "product"
      ],
      "type": "object"
    },
    "task_code": {
      "const": "amazon_product_reviews_v1"
    }
  },
  "required": [
    "task_code",
    "input"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "input": {
    "country": "US",
    "page": 1,
    "product": "B08LYNQ8LC",
    "since": "2021-01-21",
    "star": "5"
  },
  "task_code": "amazon_product_reviews_v1"
}
```

### Synthetic response / 合成响应

```json
{
  "quote_token": "quote-token-from-estimate",
  "upper_bound_credits": 49
}
```

- quote_token (string): No field description available
- upper_bound_credits (integer): No field description available
## estimate_collection

legacy · available · api_key, oauth

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.

One product or one page per request. Each successful request, including an empty page, is charged independently.
Listing sales are estimates and may cover multiple variants. Published ASIN sales are not exact real-time sales.
Amounts use the currency's minor unit; JPY has no fractional unit. Missing data is null, not zero.
Stored reviews may be delayed and refer to other variants. No live review collection is started.
14 marketplaces are supported by the source contract; live verification is recorded separately.

49 Credits per successful task; estimate before starting.

Where the request declares idempotency_key, reuse it for the same operation; metadata GET is read-only.

A pending response supplies a result/status reference. Read it first; do not automatically resubmit paid execution after a timeout or ambiguous result. Correct 401/403/422 errors before retrying.

### Input schema / 输入契约

```json
{
  "$defs": {},
  "additionalProperties": false,
  "description": "Outer transport contract; each registered task validates its own input.",
  "properties": {
    "input": {
      "additionalProperties": false,
      "properties": {
        "country": {
          "default": "US",
          "enum": [
            "US",
            "GB",
            "DE",
            "FR",
            "IN",
            "CA",
            "JP",
            "ES",
            "IT",
            "MX",
            "AE",
            "AU",
            "BR",
            "SA"
          ],
          "type": "string"
        },
        "page": {
          "default": 1,
          "maximum": 10000,
          "minimum": 1,
          "type": "integer"
        },
        "product": {
          "maxLength": 2048,
          "minLength": 10,
          "type": "string"
        },
        "since": {
          "default": "",
          "maxLength": 10,
          "type": "string"
        },
        "star": {
          "default": "all",
          "enum": [
            "all",
            "1",
            "2",
            "3",
            "4",
            "5"
          ],
          "type": "string"
        },
        "verified_purchase_only": {
          "default": "false",
          "enum": [
            "false",
            "true"
          ],
          "type": "string"
        }
      },
      "required": [
        "product"
      ],
      "type": "object"
    },
    "task_code": {
      "const": "amazon_product_reviews_v1"
    },
    "task_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional task attribution: when provided, write one concise, self-contained task_query in the user's language and reuse that exact value in every call for the task, including discovery, search, approval retry, results, export, and status checks. For MCP calls, when omitted, Asklear records a generic non-user-specific attribution so compatible clients can still call the tool. REST calls may omit it and remain unattributed. It is a task description, not a task identifier. Do not include hidden reasoning, credentials, or direct personal identifiers such as phone numbers, email addresses, identity numbers, or street addresses.",
      "maxLength": 300
    }
  },
  "required": [
    "task_code",
    "input"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "input": {
    "country": "US",
    "page": 1,
    "product": "B08LYNQ8LC",
    "since": "2021-01-21",
    "star": "5"
  },
  "task_code": "amazon_product_reviews_v1"
}
```

### Synthetic response / 合成响应

```json
{
  "quote_token": "quote-token-from-estimate",
  "upper_bound_credits": 49
}
```

- quote_token (string): No field description available
- upper_bound_credits (integer): No field description available
## asklear collection estimate

legacy · unavailable · api_key, oauth

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.

One product or one page per request. Each successful request, including an empty page, is charged independently.
Listing sales are estimates and may cover multiple variants. Published ASIN sales are not exact real-time sales.
Amounts use the currency's minor unit; JPY has no fractional unit. Missing data is null, not zero.
Stored reviews may be delayed and refer to other variants. No live review collection is started.
14 marketplaces are supported by the source contract; live verification is recorded separately.

49 Credits per successful task; estimate before starting.

Where the request declares idempotency_key, reuse it for the same operation; metadata GET is read-only.

A pending response supplies a result/status reference. Read it first; do not automatically resubmit paid execution after a timeout or ambiguous result. Correct 401/403/422 errors before retrying.

### Input schema / 输入契约

```json
{
  "$defs": {},
  "additionalProperties": false,
  "description": "Outer transport contract; each registered task validates its own input.",
  "properties": {
    "input": {
      "additionalProperties": false,
      "properties": {
        "country": {
          "default": "US",
          "enum": [
            "US",
            "GB",
            "DE",
            "FR",
            "IN",
            "CA",
            "JP",
            "ES",
            "IT",
            "MX",
            "AE",
            "AU",
            "BR",
            "SA"
          ],
          "type": "string"
        },
        "page": {
          "default": 1,
          "maximum": 10000,
          "minimum": 1,
          "type": "integer"
        },
        "product": {
          "maxLength": 2048,
          "minLength": 10,
          "type": "string"
        },
        "since": {
          "default": "",
          "maxLength": 10,
          "type": "string"
        },
        "star": {
          "default": "all",
          "enum": [
            "all",
            "1",
            "2",
            "3",
            "4",
            "5"
          ],
          "type": "string"
        },
        "verified_purchase_only": {
          "default": "false",
          "enum": [
            "false",
            "true"
          ],
          "type": "string"
        }
      },
      "required": [
        "product"
      ],
      "type": "object"
    },
    "task_code": {
      "const": "amazon_product_reviews_v1"
    },
    "task_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional task attribution: when provided, write one concise, self-contained task_query in the user's language and reuse that exact value in every call for the task, including discovery, search, approval retry, results, export, and status checks. For MCP calls, when omitted, Asklear records a generic non-user-specific attribution so compatible clients can still call the tool. REST calls may omit it and remain unattributed. It is a task description, not a task identifier. Do not include hidden reasoning, credentials, or direct personal identifiers such as phone numbers, email addresses, identity numbers, or street addresses.",
      "maxLength": 300
    }
  },
  "required": [
    "task_code",
    "input"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "input": {
    "country": "US",
    "page": 1,
    "product": "B08LYNQ8LC",
    "since": "2021-01-21",
    "star": "5"
  },
  "task_code": "amazon_product_reviews_v1"
}
```

### Synthetic response / 合成响应

```json
{
  "quote_token": "quote-token-from-estimate",
  "upper_bound_credits": 49
}
```

- quote_token (string): No field description available
- upper_bound_credits (integer): No field description available
## POST /v1/collections/jobs

legacy · available · api_key, oauth

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.

One product or one page per request. Each successful request, including an empty page, is charged independently.
Listing sales are estimates and may cover multiple variants. Published ASIN sales are not exact real-time sales.
Amounts use the currency's minor unit; JPY has no fractional unit. Missing data is null, not zero.
Stored reviews may be delayed and refer to other variants. No live review collection is started.
14 marketplaces are supported by the source contract; live verification is recorded separately.

49 Credits per successful task; estimate before starting.

Where the request declares idempotency_key, reuse it for the same operation; metadata GET is read-only.

A pending response supplies a result/status reference. Read it first; do not automatically resubmit paid execution after a timeout or ambiguous result. Correct 401/403/422 errors before retrying.

### Input schema / 输入契约

```json
{
  "$defs": {},
  "additionalProperties": false,
  "properties": {
    "idempotency_key": {
      "maxLength": 128,
      "minLength": 1,
      "type": "string"
    },
    "input": {
      "additionalProperties": false,
      "properties": {
        "country": {
          "default": "US",
          "enum": [
            "US",
            "GB",
            "DE",
            "FR",
            "IN",
            "CA",
            "JP",
            "ES",
            "IT",
            "MX",
            "AE",
            "AU",
            "BR",
            "SA"
          ],
          "type": "string"
        },
        "page": {
          "default": 1,
          "maximum": 10000,
          "minimum": 1,
          "type": "integer"
        },
        "product": {
          "maxLength": 2048,
          "minLength": 10,
          "type": "string"
        },
        "since": {
          "default": "",
          "maxLength": 10,
          "type": "string"
        },
        "star": {
          "default": "all",
          "enum": [
            "all",
            "1",
            "2",
            "3",
            "4",
            "5"
          ],
          "type": "string"
        },
        "verified_purchase_only": {
          "default": "false",
          "enum": [
            "false",
            "true"
          ],
          "type": "string"
        }
      },
      "required": [
        "product"
      ],
      "type": "object"
    },
    "max_credits": {
      "anyOf": [
        {
          "exclusiveMinimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "quote_token": {
      "maxLength": 4096,
      "minLength": 16,
      "type": "string"
    },
    "task_code": {
      "const": "amazon_product_reviews_v1"
    }
  },
  "required": [
    "task_code",
    "input",
    "quote_token",
    "idempotency_key"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "idempotency_key": "directory-example",
  "input": {
    "country": "US",
    "page": 1,
    "product": "B08LYNQ8LC",
    "since": "2021-01-21",
    "star": "5"
  },
  "quote_token": "quote-token-from-estimate",
  "task_code": "amazon_product_reviews_v1"
}
```

### Synthetic response / 合成响应

```json
{
  "job_id": "collection-example",
  "status": "queued"
}
```

- job_id (string): No field description available
- status (string): No field description available

Follow up: GET /v1/collections/jobs/{job_id}
Read job status and its saved public result.

## start_collection

legacy · available · api_key, oauth

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.

One product or one page per request. Each successful request, including an empty page, is charged independently.
Listing sales are estimates and may cover multiple variants. Published ASIN sales are not exact real-time sales.
Amounts use the currency's minor unit; JPY has no fractional unit. Missing data is null, not zero.
Stored reviews may be delayed and refer to other variants. No live review collection is started.
14 marketplaces are supported by the source contract; live verification is recorded separately.

49 Credits per successful task; estimate before starting.

Where the request declares idempotency_key, reuse it for the same operation; metadata GET is read-only.

A pending response supplies a result/status reference. Read it first; do not automatically resubmit paid execution after a timeout or ambiguous result. Correct 401/403/422 errors before retrying.

### Input schema / 输入契约

```json
{
  "$defs": {},
  "additionalProperties": false,
  "properties": {
    "idempotency_key": {
      "maxLength": 128,
      "minLength": 1,
      "type": "string"
    },
    "input": {
      "additionalProperties": false,
      "properties": {
        "country": {
          "default": "US",
          "enum": [
            "US",
            "GB",
            "DE",
            "FR",
            "IN",
            "CA",
            "JP",
            "ES",
            "IT",
            "MX",
            "AE",
            "AU",
            "BR",
            "SA"
          ],
          "type": "string"
        },
        "page": {
          "default": 1,
          "maximum": 10000,
          "minimum": 1,
          "type": "integer"
        },
        "product": {
          "maxLength": 2048,
          "minLength": 10,
          "type": "string"
        },
        "since": {
          "default": "",
          "maxLength": 10,
          "type": "string"
        },
        "star": {
          "default": "all",
          "enum": [
            "all",
            "1",
            "2",
            "3",
            "4",
            "5"
          ],
          "type": "string"
        },
        "verified_purchase_only": {
          "default": "false",
          "enum": [
            "false",
            "true"
          ],
          "type": "string"
        }
      },
      "required": [
        "product"
      ],
      "type": "object"
    },
    "max_credits": {
      "anyOf": [
        {
          "exclusiveMinimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "quote_token": {
      "maxLength": 4096,
      "minLength": 16,
      "type": "string"
    },
    "task_code": {
      "const": "amazon_product_reviews_v1"
    },
    "task_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional task attribution: when provided, write one concise, self-contained task_query in the user's language and reuse that exact value in every call for the task, including discovery, search, approval retry, results, export, and status checks. For MCP calls, when omitted, Asklear records a generic non-user-specific attribution so compatible clients can still call the tool. REST calls may omit it and remain unattributed. It is a task description, not a task identifier. Do not include hidden reasoning, credentials, or direct personal identifiers such as phone numbers, email addresses, identity numbers, or street addresses.",
      "maxLength": 300
    }
  },
  "required": [
    "task_code",
    "input",
    "quote_token",
    "idempotency_key"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "idempotency_key": "directory-example",
  "input": {
    "country": "US",
    "page": 1,
    "product": "B08LYNQ8LC",
    "since": "2021-01-21",
    "star": "5"
  },
  "quote_token": "quote-token-from-estimate",
  "task_code": "amazon_product_reviews_v1"
}
```

### Synthetic response / 合成响应

```json
{
  "job_id": "collection-example",
  "status": "queued"
}
```

- job_id (string): No field description available
- status (string): No field description available

Follow up: GET /v1/collections/jobs/{job_id}
Read job status and its saved public result.

## asklear collection start

legacy · unavailable · api_key, oauth

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.

One product or one page per request. Each successful request, including an empty page, is charged independently.
Listing sales are estimates and may cover multiple variants. Published ASIN sales are not exact real-time sales.
Amounts use the currency's minor unit; JPY has no fractional unit. Missing data is null, not zero.
Stored reviews may be delayed and refer to other variants. No live review collection is started.
14 marketplaces are supported by the source contract; live verification is recorded separately.

49 Credits per successful task; estimate before starting.

Where the request declares idempotency_key, reuse it for the same operation; metadata GET is read-only.

A pending response supplies a result/status reference. Read it first; do not automatically resubmit paid execution after a timeout or ambiguous result. Correct 401/403/422 errors before retrying.

### Input schema / 输入契约

```json
{
  "$defs": {},
  "additionalProperties": false,
  "properties": {
    "idempotency_key": {
      "maxLength": 128,
      "minLength": 1,
      "type": "string"
    },
    "input": {
      "additionalProperties": false,
      "properties": {
        "country": {
          "default": "US",
          "enum": [
            "US",
            "GB",
            "DE",
            "FR",
            "IN",
            "CA",
            "JP",
            "ES",
            "IT",
            "MX",
            "AE",
            "AU",
            "BR",
            "SA"
          ],
          "type": "string"
        },
        "page": {
          "default": 1,
          "maximum": 10000,
          "minimum": 1,
          "type": "integer"
        },
        "product": {
          "maxLength": 2048,
          "minLength": 10,
          "type": "string"
        },
        "since": {
          "default": "",
          "maxLength": 10,
          "type": "string"
        },
        "star": {
          "default": "all",
          "enum": [
            "all",
            "1",
            "2",
            "3",
            "4",
            "5"
          ],
          "type": "string"
        },
        "verified_purchase_only": {
          "default": "false",
          "enum": [
            "false",
            "true"
          ],
          "type": "string"
        }
      },
      "required": [
        "product"
      ],
      "type": "object"
    },
    "max_credits": {
      "anyOf": [
        {
          "exclusiveMinimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "quote_token": {
      "maxLength": 4096,
      "minLength": 16,
      "type": "string"
    },
    "task_code": {
      "const": "amazon_product_reviews_v1"
    },
    "task_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional task attribution: when provided, write one concise, self-contained task_query in the user's language and reuse that exact value in every call for the task, including discovery, search, approval retry, results, export, and status checks. For MCP calls, when omitted, Asklear records a generic non-user-specific attribution so compatible clients can still call the tool. REST calls may omit it and remain unattributed. It is a task description, not a task identifier. Do not include hidden reasoning, credentials, or direct personal identifiers such as phone numbers, email addresses, identity numbers, or street addresses.",
      "maxLength": 300
    }
  },
  "required": [
    "task_code",
    "input",
    "quote_token",
    "idempotency_key"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "idempotency_key": "directory-example",
  "input": {
    "country": "US",
    "page": 1,
    "product": "B08LYNQ8LC",
    "since": "2021-01-21",
    "star": "5"
  },
  "quote_token": "quote-token-from-estimate",
  "task_code": "amazon_product_reviews_v1"
}
```

### Synthetic response / 合成响应

```json
{
  "job_id": "collection-example",
  "status": "queued"
}
```

- job_id (string): No field description available
- status (string): No field description available

Follow up: GET /v1/collections/jobs/{job_id}
Read job status and its saved public result.

## GET /v1/collections/jobs/{job_id}

legacy · available · api_key, oauth

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.

One product or one page per request. Each successful request, including an empty page, is charged independently.
Listing sales are estimates and may cover multiple variants. Published ASIN sales are not exact real-time sales.
Amounts use the currency's minor unit; JPY has no fractional unit. Missing data is null, not zero.
Stored reviews may be delayed and refer to other variants. No live review collection is started.
14 marketplaces are supported by the source contract; live verification is recorded separately.

Existing pricing applies; metadata reads do not charge Credits.

Where the request declares idempotency_key, reuse it for the same operation; metadata GET is read-only.

A pending response supplies a result/status reference. Read it first; do not automatically resubmit paid execution after a timeout or ambiguous result. Correct 401/403/422 errors before retrying.

### Input schema / 输入契约

```json
{
  "properties": {
    "job_id": {
      "type": "string"
    },
    "task_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional task attribution: when provided, write one concise, self-contained task_query in the user's language and reuse that exact value in every call for the task, including discovery, search, approval retry, results, export, and status checks. For MCP calls, when omitted, Asklear records a generic non-user-specific attribution so compatible clients can still call the tool. REST calls may omit it and remain unattributed. It is a task description, not a task identifier. Do not include hidden reasoning, credentials, or direct personal identifiers such as phone numbers, email addresses, identity numbers, or street addresses.",
      "maxLength": 300
    }
  },
  "required": [
    "job_id"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "job_id": "collection-example"
}
```

### Response schema / 响应契约

```json
{
  "$defs": {
    "Schema1": {
      "additionalProperties": false,
      "description": "The limited metadata safe to store and expose with a collection result.",
      "properties": {
        "api_name": {
          "maxLength": 128,
          "minLength": 1,
          "pattern": "^[\\x21-\\x7e]+$",
          "type": "string"
        },
        "credits_charged": {
          "maximum": 1000000,
          "minimum": 0,
          "type": "integer"
        },
        "latency_ms": {
          "maximum": 120000,
          "minimum": 0,
          "type": "integer"
        },
        "request_id": {
          "maxLength": 128,
          "minLength": 1,
          "pattern": "^[\\x21-\\x7e]+$",
          "type": "string"
        }
      },
      "required": [
        "request_id",
        "api_name",
        "latency_ms",
        "credits_charged"
      ],
      "type": "object"
    }
  },
  "additionalProperties": true,
  "properties": {
    "result": {
      "additionalProperties": false,
      "properties": {
        "data": {
          "additionalProperties": true,
          "type": "object"
        },
        "meta": {
          "$ref": "#/$defs/Schema1"
        }
      },
      "required": [
        "data",
        "meta"
      ],
      "type": "object"
    }
  },
  "type": "object"
}
```

### Synthetic response / 合成响应

```json
{
  "result": {
    "data": {},
    "meta": {
      "api_name": "https://www.linkedin.com/in/example",
      "credits_charged": 0,
      "latency_ms": 0,
      "request_id": "https://www.linkedin.com/in/example"
    }
  },
  "status": "succeeded"
}
```

- result.meta.request_id (string): Asklear request identifier for tracing.
- result.meta.api_name (string): Executed collection operation name.
- result.meta.latency_ms (integer): Collection execution latency in milliseconds.
- result.meta.credits_charged (integer): Asklear user-side Credits settled for this task after completion.
- result.data.country (string): Marketplace: US, GB, DE, FR, IN, CA, JP, ES, IT, MX, AE, AU, BR or SA. Defaults to US. Source support does not imply every country was live-tested.
- result.data.page (integer): Requested page, starting at 1. One call returns one page.
- result.data.next_page (integer|null): Pass this as page with the same country and filters. For search, a full page only permits trying the next page; it does not guarantee more matches. Each successful page is charged, including an empty page.
- result.data.max_page (integer|null): Total pages when known. Search has no total and returns null; Playground does not enable its next-page button for an unknown total.
- result.data.total (integer|null): Matching review count from the original page metadata; search returns null.
- result.data.requested_asin (string): ASIN requested. Individual reviews may refer to another variant in the same listing.
- result.data.items (array<object>): Up to 100 stored review records. Review IDs may repeat across ASINs; preserve both. These are not guaranteed real-time reviews. collection_no_data means no stored reviews for the filters and no user charge.
- result.data.items[].review_id (string): Public review ID; use together with asin as record identity.
- result.data.items[].asin (string): Actual reviewed variant ASIN, which may differ from requested_asin.
- result.data.items[].title (string|null): Review title.
- result.data.items[].content (string|null): Review text.
- result.data.items[].star (integer|null): Review rating, 1–5; null if unavailable.
- result.data.items[].date (string|null): Date the review was posted, YYYY-MM-DD.
- result.data.items[].verified_purchase (boolean|null): Whether Amazon marks this as a verified purchase.
- result.data.items[].collected_at (string|null): Recorded update time as reported, without an assumed timezone; distinct from the review date.
- result.data.items[].url (string|null): Canonical public review link, without tracking or credential parameters.
## get_collection_job

legacy · available · api_key, oauth

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.

One product or one page per request. Each successful request, including an empty page, is charged independently.
Listing sales are estimates and may cover multiple variants. Published ASIN sales are not exact real-time sales.
Amounts use the currency's minor unit; JPY has no fractional unit. Missing data is null, not zero.
Stored reviews may be delayed and refer to other variants. No live review collection is started.
14 marketplaces are supported by the source contract; live verification is recorded separately.

Existing pricing applies; metadata reads do not charge Credits.

Where the request declares idempotency_key, reuse it for the same operation; metadata GET is read-only.

A pending response supplies a result/status reference. Read it first; do not automatically resubmit paid execution after a timeout or ambiguous result. Correct 401/403/422 errors before retrying.

### Input schema / 输入契约

```json
{
  "properties": {
    "job_id": {
      "type": "string"
    },
    "task_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional task attribution: when provided, write one concise, self-contained task_query in the user's language and reuse that exact value in every call for the task, including discovery, search, approval retry, results, export, and status checks. For MCP calls, when omitted, Asklear records a generic non-user-specific attribution so compatible clients can still call the tool. REST calls may omit it and remain unattributed. It is a task description, not a task identifier. Do not include hidden reasoning, credentials, or direct personal identifiers such as phone numbers, email addresses, identity numbers, or street addresses.",
      "maxLength": 300
    }
  },
  "required": [
    "job_id"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "job_id": "collection-example"
}
```

### Response schema / 响应契约

```json
{
  "$defs": {
    "Schema1": {
      "additionalProperties": false,
      "description": "The limited metadata safe to store and expose with a collection result.",
      "properties": {
        "api_name": {
          "maxLength": 128,
          "minLength": 1,
          "pattern": "^[\\x21-\\x7e]+$",
          "type": "string"
        },
        "credits_charged": {
          "maximum": 1000000,
          "minimum": 0,
          "type": "integer"
        },
        "latency_ms": {
          "maximum": 120000,
          "minimum": 0,
          "type": "integer"
        },
        "request_id": {
          "maxLength": 128,
          "minLength": 1,
          "pattern": "^[\\x21-\\x7e]+$",
          "type": "string"
        }
      },
      "required": [
        "request_id",
        "api_name",
        "latency_ms",
        "credits_charged"
      ],
      "type": "object"
    }
  },
  "additionalProperties": true,
  "properties": {
    "result": {
      "additionalProperties": false,
      "properties": {
        "data": {
          "additionalProperties": true,
          "type": "object"
        },
        "meta": {
          "$ref": "#/$defs/Schema1"
        }
      },
      "required": [
        "data",
        "meta"
      ],
      "type": "object"
    }
  },
  "type": "object"
}
```

### Synthetic response / 合成响应

```json
{
  "result": {
    "data": {},
    "meta": {
      "api_name": "https://www.linkedin.com/in/example",
      "credits_charged": 0,
      "latency_ms": 0,
      "request_id": "https://www.linkedin.com/in/example"
    }
  },
  "status": "succeeded"
}
```

- result.meta.request_id (string): Asklear request identifier for tracing.
- result.meta.api_name (string): Executed collection operation name.
- result.meta.latency_ms (integer): Collection execution latency in milliseconds.
- result.meta.credits_charged (integer): Asklear user-side Credits settled for this task after completion.
- result.data.country (string): Marketplace: US, GB, DE, FR, IN, CA, JP, ES, IT, MX, AE, AU, BR or SA. Defaults to US. Source support does not imply every country was live-tested.
- result.data.page (integer): Requested page, starting at 1. One call returns one page.
- result.data.next_page (integer|null): Pass this as page with the same country and filters. For search, a full page only permits trying the next page; it does not guarantee more matches. Each successful page is charged, including an empty page.
- result.data.max_page (integer|null): Total pages when known. Search has no total and returns null; Playground does not enable its next-page button for an unknown total.
- result.data.total (integer|null): Matching review count from the original page metadata; search returns null.
- result.data.requested_asin (string): ASIN requested. Individual reviews may refer to another variant in the same listing.
- result.data.items (array<object>): Up to 100 stored review records. Review IDs may repeat across ASINs; preserve both. These are not guaranteed real-time reviews. collection_no_data means no stored reviews for the filters and no user charge.
- result.data.items[].review_id (string): Public review ID; use together with asin as record identity.
- result.data.items[].asin (string): Actual reviewed variant ASIN, which may differ from requested_asin.
- result.data.items[].title (string|null): Review title.
- result.data.items[].content (string|null): Review text.
- result.data.items[].star (integer|null): Review rating, 1–5; null if unavailable.
- result.data.items[].date (string|null): Date the review was posted, YYYY-MM-DD.
- result.data.items[].verified_purchase (boolean|null): Whether Amazon marks this as a verified purchase.
- result.data.items[].collected_at (string|null): Recorded update time as reported, without an assumed timezone; distinct from the review date.
- result.data.items[].url (string|null): Canonical public review link, without tracking or credential parameters.
## asklear collection get-job

legacy · unavailable · api_key, oauth

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.

One product or one page per request. Each successful request, including an empty page, is charged independently.
Listing sales are estimates and may cover multiple variants. Published ASIN sales are not exact real-time sales.
Amounts use the currency's minor unit; JPY has no fractional unit. Missing data is null, not zero.
Stored reviews may be delayed and refer to other variants. No live review collection is started.
14 marketplaces are supported by the source contract; live verification is recorded separately.

Existing pricing applies; metadata reads do not charge Credits.

Where the request declares idempotency_key, reuse it for the same operation; metadata GET is read-only.

A pending response supplies a result/status reference. Read it first; do not automatically resubmit paid execution after a timeout or ambiguous result. Correct 401/403/422 errors before retrying.

### Input schema / 输入契约

```json
{
  "properties": {
    "job_id": {
      "type": "string"
    },
    "task_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional task attribution: when provided, write one concise, self-contained task_query in the user's language and reuse that exact value in every call for the task, including discovery, search, approval retry, results, export, and status checks. For MCP calls, when omitted, Asklear records a generic non-user-specific attribution so compatible clients can still call the tool. REST calls may omit it and remain unattributed. It is a task description, not a task identifier. Do not include hidden reasoning, credentials, or direct personal identifiers such as phone numbers, email addresses, identity numbers, or street addresses.",
      "maxLength": 300
    }
  },
  "required": [
    "job_id"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "job_id": "collection-example"
}
```

### Response schema / 响应契约

```json
{
  "$defs": {
    "Schema1": {
      "additionalProperties": false,
      "description": "The limited metadata safe to store and expose with a collection result.",
      "properties": {
        "api_name": {
          "maxLength": 128,
          "minLength": 1,
          "pattern": "^[\\x21-\\x7e]+$",
          "type": "string"
        },
        "credits_charged": {
          "maximum": 1000000,
          "minimum": 0,
          "type": "integer"
        },
        "latency_ms": {
          "maximum": 120000,
          "minimum": 0,
          "type": "integer"
        },
        "request_id": {
          "maxLength": 128,
          "minLength": 1,
          "pattern": "^[\\x21-\\x7e]+$",
          "type": "string"
        }
      },
      "required": [
        "request_id",
        "api_name",
        "latency_ms",
        "credits_charged"
      ],
      "type": "object"
    }
  },
  "additionalProperties": true,
  "properties": {
    "result": {
      "additionalProperties": false,
      "properties": {
        "data": {
          "additionalProperties": true,
          "type": "object"
        },
        "meta": {
          "$ref": "#/$defs/Schema1"
        }
      },
      "required": [
        "data",
        "meta"
      ],
      "type": "object"
    }
  },
  "type": "object"
}
```

### Synthetic response / 合成响应

```json
{
  "result": {
    "data": {},
    "meta": {
      "api_name": "https://www.linkedin.com/in/example",
      "credits_charged": 0,
      "latency_ms": 0,
      "request_id": "https://www.linkedin.com/in/example"
    }
  },
  "status": "succeeded"
}
```

- result.meta.request_id (string): Asklear request identifier for tracing.
- result.meta.api_name (string): Executed collection operation name.
- result.meta.latency_ms (integer): Collection execution latency in milliseconds.
- result.meta.credits_charged (integer): Asklear user-side Credits settled for this task after completion.
- result.data.country (string): Marketplace: US, GB, DE, FR, IN, CA, JP, ES, IT, MX, AE, AU, BR or SA. Defaults to US. Source support does not imply every country was live-tested.
- result.data.page (integer): Requested page, starting at 1. One call returns one page.
- result.data.next_page (integer|null): Pass this as page with the same country and filters. For search, a full page only permits trying the next page; it does not guarantee more matches. Each successful page is charged, including an empty page.
- result.data.max_page (integer|null): Total pages when known. Search has no total and returns null; Playground does not enable its next-page button for an unknown total.
- result.data.total (integer|null): Matching review count from the original page metadata; search returns null.
- result.data.requested_asin (string): ASIN requested. Individual reviews may refer to another variant in the same listing.
- result.data.items (array<object>): Up to 100 stored review records. Review IDs may repeat across ASINs; preserve both. These are not guaranteed real-time reviews. collection_no_data means no stored reviews for the filters and no user charge.
- result.data.items[].review_id (string): Public review ID; use together with asin as record identity.
- result.data.items[].asin (string): Actual reviewed variant ASIN, which may differ from requested_asin.
- result.data.items[].title (string|null): Review title.
- result.data.items[].content (string|null): Review text.
- result.data.items[].star (integer|null): Review rating, 1–5; null if unavailable.
- result.data.items[].date (string|null): Date the review was posted, YYYY-MM-DD.
- result.data.items[].verified_purchase (boolean|null): Whether Amazon marks this as a verified purchase.
- result.data.items[].collected_at (string|null): Recorded update time as reported, without an assumed timezone; distinct from the review date.
- result.data.items[].url (string|null): Canonical public review link, without tracking or credential parameters.
