Learn a page
/api/v1/projects/{projectId}/operations/learn Project memberLoads the trigger page 3 times and returns the requests that carry your examples, best first. Takes tens of seconds. Costs 3 credits when it returns candidates, nothing otherwise. The draft is kept 30 minutes.
{
"trigger": {
"url": "https://shop.example/search?q={query}"
},
"params": [
{
"name": "query",
"type": "string",
"examples": [
"desk lamp",
"office chair"
]
}
],
"options": {
"proxy": "auto"
}
}{
"success": true,
"data": {
"learnId": "lrn_4kQ9w2Zc",
"expiresAt": "2026-10-12T10:30:00.000Z",
"candidates": [
{
"id": "cnd_1",
"rank": 1,
"method": "GET",
"host": "api.shop.example",
"path": "/v2/search",
"graphqlOperation": null,
"format": "json",
"source": "fetch",
"reasons": [
"Both examples sit in query:q",
"JSON with a list of 24 items that hold the example"
],
"warnings": [],
"minTier": 1,
"anonymousState": "none",
"slots": [
{
"param": "query",
"at": "query:q"
}
],
"extractPath": "/results",
"list": true,
"listSize": 24,
"fields": [
{
"name": "title",
"source": "/title",
"type": "string",
"required": true,
"samples": [
"Brass desk lamp",
"Clamp lamp",
"LED desk lamp"
]
},
{
"name": "price",
"source": "/price/amount",
"type": "number",
"required": true,
"samples": [
49.9,
29,
35.5
]
},
{
"name": "url",
"source": "/link",
"type": "url",
"required": true,
"samples": [
"https://shop.example/p/1042",
"https://shop.example/p/877",
"https://shop.example/p/913"
]
}
]
}
],
"warnings": []
},
"credits": 3
}