Search for products

POST

cURL

curl --request POST \
  --url https://app.productlasso.com/api/v1/search \
  --header "Authorization: Bearer $LASSO_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "query": "Sony wireless earbuds under $200 with USB-C charging",
    "columns": [
      {"key": "product_name", "label": "Product name", "type": "text"},
      {"key": "price", "label": "Price", "type": "number"}
    ],
    "max_results": 3
  }'

const response = await fetch("https://app.productlasso.com/api/v1/search", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LASSO_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    query: "Sony wireless earbuds under $200 with USB-C charging",
    columns: [
      { key: "product_name", label: "Product name", type: "text" },
      { key: "price", label: "Price", type: "number" },
    ],
    max_results: 3,
  }),
});

if (!response.ok) throw new Error(await response.text());
const result = await response.json();

import os
import requests

response = requests.post(
    "https://app.productlasso.com/api/v1/search",
    headers={"Authorization": f"Bearer {os.environ['LASSO_API_KEY']}"},
    json={
        "query": "Sony wireless earbuds under $200 with USB-C charging",
        "columns": [
            {"key": "product_name", "label": "Product name", "type": "text"},
            {"key": "price", "label": "Price", "type": "number"},
        ],
        "max_results": 3,
    },
    timeout=120,
)
response.raise_for_status()
result = response.json()

{
  "id": "6caa3d91-4ba7-4c14-8b31-9a7d92693ac9",
  "status": "completed",
  "query": "Sony wireless earbuds under $200 with USB-C charging",
  "results": [
    {
      "data": {
        "product_name": "Sony WF-C700N",
        "price": 119.99
      },
      "source_url": "https://example.com/products/sony-wf-c700n",
      "source_title": "Sony WF-C700N product page",
      "confidence": 0.94
    }
  ],
  "total_results": 1,
  "credits_used": 5
}

{
  "id": "<string>",
  "status": "processing",
  "estimated_credits": 123
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

Usage notes

Send either schema_id or columns, not both. Lasso uses the default Product Schema when you omit both.
max_results accepts 1 through 7 and defaults to 7.
A search costs 5 credits, independent of the number of returned products.
Without webhook_url, the request waits for a 200 response. With webhook_url, Lasso returns 202 and posts the completed result to your URL.
model is a deprecated compatibility field. The service ignores its value and uses the configured Gemini provider.
In synchronous mode, insufficient credits currently produce HTTP 200 with error: "Insufficient credits", an empty results array, and credits_used: 0.

Put product filters directly in query, for example Sony earbuds under $200 with USB-C charging.

Examples

curl --request POST \
  --url https://app.productlasso.com/api/v1/search \
  --header "Authorization: Bearer $LASSO_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "query": "Sony wireless earbuds under $200 with USB-C charging",
    "columns": [
      {"key": "product_name", "label": "Product name", "type": "text"},
      {"key": "price", "label": "Price", "type": "number"}
    ],
    "max_results": 3
  }'

const response = await fetch("https://app.productlasso.com/api/v1/search", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LASSO_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    query: "Sony wireless earbuds under $200 with USB-C charging",
    columns: [
      { key: "product_name", label: "Product name", type: "text" },
      { key: "price", label: "Price", type: "number" },
    ],
    max_results: 3,
  }),
});

if (!response.ok) throw new Error(await response.text());
const result = await response.json();

import os
import requests

response = requests.post(
    "https://app.productlasso.com/api/v1/search",
    headers={"Authorization": f"Bearer {os.environ['LASSO_API_KEY']}"},
    json={
        "query": "Sony wireless earbuds under $200 with USB-C charging",
        "columns": [
            {"key": "product_name", "label": "Product name", "type": "text"},
            {"key": "price", "label": "Price", "type": "number"},
        ],
        "max_results": 3,
    },
    timeout=120,
)
response.raise_for_status()
result = response.json()

Example response

{
  "id": "6caa3d91-4ba7-4c14-8b31-9a7d92693ac9",
  "status": "completed",
  "query": "Sony wireless earbuds under $200 with USB-C charging",
  "results": [
    {
      "data": {"product_name": "Sony WF-C700N", "price": 119.99},
      "source_url": "https://example.com/products/sony-wf-c700n",
      "source_title": "Sony WF-C700N product page",
      "confidence": 0.94
    }
  ],
  "total_results": 1,
  "credits_used": 5
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

query

string

required

Natural language search objective

schema_id

string

ID of an existing schema. Mutually exclusive with columns.

columns

object[]

Inline column definitions. Mutually exclusive with schema_id.

Show child attributes

max_results

integer

default:7

Required range: 1 <= x <= 7

model

string

deprecated

Legacy compatibility field. The service ignores the requested value and uses its configured Gemini provider.

webhook_url

string<uri>

If provided, results are delivered via webhook and 202 is returned immediately.

Response

Search results in synchronous mode. Worker failures such as insufficient credits can currently appear as an error field in this HTTP 200 response.

string

status

enum<string>

Available options:

completed

query

string

results

object[]

Show child attributes

total_results

integer

credits_used

number

error

string

Present when the worker could not complete the search, including insufficient-credit outcomes. The current synchronous handler can still return this payload with HTTP 200.

cURL

curl --request POST \
  --url https://app.productlasso.com/api/v1/search \
  --header "Authorization: Bearer $LASSO_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "query": "Sony wireless earbuds under $200 with USB-C charging",
    "columns": [
      {"key": "product_name", "label": "Product name", "type": "text"},
      {"key": "price", "label": "Price", "type": "number"}
    ],
    "max_results": 3
  }'

const response = await fetch("https://app.productlasso.com/api/v1/search", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.LASSO_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    query: "Sony wireless earbuds under $200 with USB-C charging",
    columns: [
      { key: "product_name", label: "Product name", type: "text" },
      { key: "price", label: "Price", type: "number" },
    ],
    max_results: 3,
  }),
});

if (!response.ok) throw new Error(await response.text());
const result = await response.json();

import os
import requests

response = requests.post(
    "https://app.productlasso.com/api/v1/search",
    headers={"Authorization": f"Bearer {os.environ['LASSO_API_KEY']}"},
    json={
        "query": "Sony wireless earbuds under $200 with USB-C charging",
        "columns": [
            {"key": "product_name", "label": "Product name", "type": "text"},
            {"key": "price", "label": "Price", "type": "number"},
        ],
        "max_results": 3,
    },
    timeout=120,
)
response.raise_for_status()
result = response.json()

{
  "id": "6caa3d91-4ba7-4c14-8b31-9a7d92693ac9",
  "status": "completed",
  "query": "Sony wireless earbuds under $200 with USB-C charging",
  "results": [
    {
      "data": {
        "product_name": "Sony WF-C700N",
        "price": 119.99
      },
      "source_url": "https://example.com/products/sony-wf-c700n",
      "source_title": "Sony WF-C700N product page",
      "confidence": 0.94
    }
  ],
  "total_results": 1,
  "credits_used": 5
}

{
  "id": "<string>",
  "status": "processing",
  "estimated_credits": 123
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

{
  "status_code": 123,
  "error_type": "invalid_request",
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "retryable": true,
  "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "attribute_key": "<string>",
  "details": {},
  "current_updated_at": "2023-11-07T05:31:56Z"
}

Overview

Search

Enrich

Tables

Rows

Enhance

Schemas

Attributes

Files

Glossary

Credits

Product analytics

Catalog

Catalog Webhooks

Search for products

Usage notes

Examples

Authorizations

Body

Response

​Usage notes

​Examples

Authorizations

Body

Response

Usage notes

Examples