{ "openapi": "3.1.0", "info": { "title": "Browsable API", "version": "1.0.0", "description": "Public prebuilt scraping catalogue. Task-specific and canonical execution routes are included. See /docs/api for discovery, run polling, website connections, and compatibility routes." }, "servers": [ { "url": "https://api-ingress-worker-staging.browsable-staging.workers.dev" } ], "tags": [ { "name": "Airbnb", "description": "Airbnb scraping endpoints." }, { "name": "Alibaba", "description": "Alibaba scraping endpoints." }, { "name": "AliExpress", "description": "AliExpress scraping endpoints." }, { "name": "Amazon", "description": "Amazon scraping endpoints." }, { "name": "Bandcamp", "description": "Bandcamp scraping endpoints." }, { "name": "BBC News", "description": "BBC News scraping endpoints." }, { "name": "Bluesky", "description": "Bluesky scraping endpoints." }, { "name": "Booking.com", "description": "Booking.com scraping endpoints." }, { "name": "Capterra", "description": "Capterra scraping endpoints." }, { "name": "Costco", "description": "Costco scraping endpoints." }, { "name": "Craigslist", "description": "Craigslist scraping endpoints." }, { "name": "Crunchbase", "description": "Crunchbase scraping endpoints." }, { "name": "Depop", "description": "Depop scraping endpoints." }, { "name": "Discogs", "description": "Discogs scraping endpoints." }, { "name": "eBay", "description": "eBay scraping endpoints." }, { "name": "Etsy", "description": "Etsy scraping endpoints." }, { "name": "Facebook", "description": "Facebook scraping endpoints." }, { "name": "Fantasy Premier League", "description": "Fantasy Premier League scraping endpoints." }, { "name": "G2", "description": "G2 scraping endpoints." }, { "name": "Glassdoor", "description": "Glassdoor scraping endpoints." }, { "name": "Goodreads", "description": "Goodreads scraping endpoints." }, { "name": "Google Maps", "description": "Google Maps scraping endpoints." }, { "name": "Gumtree", "description": "Gumtree scraping endpoints." }, { "name": "Hacker News", "description": "Hacker News scraping endpoints." }, { "name": "Home Depot", "description": "Home Depot scraping endpoints." }, { "name": "Hotels.com", "description": "Hotels.com scraping endpoints." }, { "name": "IMDb", "description": "IMDb scraping endpoints." }, { "name": "Indeed", "description": "Indeed scraping endpoints." }, { "name": "Instagram", "description": "Instagram scraping endpoints." }, { "name": "Kayak", "description": "Kayak scraping endpoints." }, { "name": "Kiwi", "description": "Kiwi scraping endpoints." }, { "name": "Letterboxd", "description": "Letterboxd scraping endpoints." }, { "name": "LinkedIn", "description": "LinkedIn scraping endpoints." }, { "name": "Mastodon", "description": "Mastodon scraping endpoints." }, { "name": "Medium", "description": "Medium scraping endpoints." }, { "name": "Mercari", "description": "Mercari scraping endpoints." }, { "name": "OfferUp", "description": "OfferUp scraping endpoints." }, { "name": "OLX", "description": "OLX scraping endpoints." }, { "name": "OnlyFans", "description": "OnlyFans scraping endpoints." }, { "name": "Patreon", "description": "Patreon scraping endpoints." }, { "name": "Pinterest", "description": "Pinterest scraping endpoints." }, { "name": "Product Hunt", "description": "Product Hunt scraping endpoints." }, { "name": "Quora", "description": "Quora scraping endpoints." }, { "name": "Realtor", "description": "Realtor scraping endpoints." }, { "name": "Reddit", "description": "Reddit scraping endpoints." }, { "name": "Redfin", "description": "Redfin scraping endpoints." }, { "name": "Rightmove", "description": "Rightmove scraping endpoints." }, { "name": "Skyscanner", "description": "Skyscanner scraping endpoints." }, { "name": "SoundCloud", "description": "SoundCloud scraping endpoints." }, { "name": "Spotify", "description": "Spotify scraping endpoints." }, { "name": "Stack Overflow", "description": "Stack Overflow scraping endpoints." }, { "name": "Steam", "description": "Steam scraping endpoints." }, { "name": "Substack", "description": "Substack scraping endpoints." }, { "name": "Threads", "description": "Threads scraping endpoints." }, { "name": "TikTok", "description": "TikTok scraping endpoints." }, { "name": "Tripadvisor", "description": "Tripadvisor scraping endpoints." }, { "name": "Trustpilot", "description": "Trustpilot scraping endpoints." }, { "name": "Twitch", "description": "Twitch scraping endpoints." }, { "name": "Vimeo", "description": "Vimeo scraping endpoints." }, { "name": "Vinted", "description": "Vinted scraping endpoints." }, { "name": "Walmart", "description": "Walmart scraping endpoints." }, { "name": "Wellfound", "description": "Wellfound scraping endpoints." }, { "name": "Wikipedia", "description": "Wikipedia scraping endpoints." }, { "name": "X", "description": "X scraping endpoints." }, { "name": "Yelp", "description": "Yelp scraping endpoints." }, { "name": "YouTube", "description": "YouTube scraping endpoints." }, { "name": "Zillow", "description": "Zillow scraping endpoints." }, { "name": "Zoopla", "description": "Zoopla scraping endpoints." } ], "paths": { "/v1/tasks/airbnb-calendar/runs": { "post": { "tags": [ "Airbnb" ], "summary": "Airbnb calendar", "description": "Read public calendar availability and exposed stay restrictions. Unavailable does not mean booked; prices are displayed calendar prices, not stay quotes.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "listing_id", "listing_url", "currency", "months", "request", "availability_note" ], "properties": { "months": { "type": "array", "items": { "type": "object", "required": [ "month", "year", "days" ], "properties": { "days": { "type": "array", "items": { "type": "object", "required": [ "date", "available", "available_for_checkin", "available_for_checkout", "bookable", "min_nights", "max_nights", "local_price" ], "properties": { "date": { "type": "string", "format": "date" }, "bookable": { "type": [ "boolean", "null" ] }, "available": { "type": [ "boolean", "null" ] }, "max_nights": { "type": [ "number", "null" ] }, "min_nights": { "type": [ "number", "null" ] }, "local_price": { "type": [ "string", "null" ] }, "available_for_checkin": { "type": [ "boolean", "null" ] }, "available_for_checkout": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "year": { "type": "integer" }, "month": { "type": "integer" } }, "additionalProperties": false } }, "request": { "type": "object", "required": [ "months", "start_month", "start_year" ], "properties": { "months": { "type": "integer" }, "start_year": { "type": "integer" }, "start_month": { "type": "integer" } }, "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "currency": { "type": "string" }, "fetched_at": { "type": "string", "format": "date-time" }, "listing_id": { "type": "string" }, "listing_url": { "type": "string" }, "availability_note": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-calendar", "task_name": "Airbnb calendar", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "months": [ { "days": [ { "date": "sample", "bookable": true, "available": true, "max_nights": 1.5, "min_nights": 1.5, "local_price": "180", "available_for_checkin": true, "available_for_checkout": true } ], "year": 1, "month": 1 } ], "request": { "months": 1, "start_year": 1, "start_month": 1 }, "success": true, "currency": "USD", "fetched_at": "sample", "listing_id": "id-1", "listing_url": "https://example.com/item-1", "availability_note": "sample" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "listing_id", "listing_url", "currency", "months", "request", "availability_note" ], "properties": { "months": { "type": "array", "items": { "type": "object", "required": [ "month", "year", "days" ], "properties": { "days": { "type": "array", "items": { "type": "object", "required": [ "date", "available", "available_for_checkin", "available_for_checkout", "bookable", "min_nights", "max_nights", "local_price" ], "properties": { "date": { "type": "string", "format": "date" }, "bookable": { "type": [ "boolean", "null" ] }, "available": { "type": [ "boolean", "null" ] }, "max_nights": { "type": [ "number", "null" ] }, "min_nights": { "type": [ "number", "null" ] }, "local_price": { "type": [ "string", "null" ] }, "available_for_checkin": { "type": [ "boolean", "null" ] }, "available_for_checkout": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "year": { "type": "integer" }, "month": { "type": "integer" } }, "additionalProperties": false } }, "request": { "type": "object", "required": [ "months", "start_month", "start_year" ], "properties": { "months": { "type": "integer" }, "start_year": { "type": "integer" }, "start_month": { "type": "integer" } }, "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "currency": { "type": "string" }, "fetched_at": { "type": "string", "format": "date-time" }, "listing_id": { "type": "string" }, "listing_url": { "type": "string" }, "availability_note": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-calendar", "task_name": "Airbnb calendar", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAirbnbCalendarCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://([a-z0-9-]+\\.)?airbnb\\.(com|co\\.uk|fr|de|es|it|ca|com\\.au)/rooms/[0-9]+/?([?].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public HTTPS Airbnb listing URL." }, "locale": { "type": "string", "default": "en", "description": "Language code for source content, such as en." }, "months": { "type": "integer", "default": 3, "maximum": 24, "minimum": 1, "description": "Number of calendar months to retrieve." }, "currency": { "type": "string", "default": "USD", "pattern": "^[A-Z]{3}$", "description": "Three-letter currency code, such as USD." }, "start_year": { "type": "integer", "maximum": 2100, "minimum": 2000, "description": "First calendar year to retrieve; defaults to the current year." }, "start_month": { "type": "integer", "maximum": 12, "minimum": 1, "description": "First calendar month, from 1 (January) to 12 (December); defaults to the current month." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.airbnb.com/rooms/21944286" } } } }, "x-browsable-website-login-required": false } }, "/v1/airbnb/calendar": { "post": { "tags": [ "Airbnb" ], "summary": "Airbnb calendar", "description": "Read public calendar availability and exposed stay restrictions. Unavailable does not mean booked; prices are displayed calendar prices, not stay quotes.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "listing_id", "listing_url", "currency", "months", "request", "availability_note" ], "properties": { "months": { "type": "array", "items": { "type": "object", "required": [ "month", "year", "days" ], "properties": { "days": { "type": "array", "items": { "type": "object", "required": [ "date", "available", "available_for_checkin", "available_for_checkout", "bookable", "min_nights", "max_nights", "local_price" ], "properties": { "date": { "type": "string", "format": "date" }, "bookable": { "type": [ "boolean", "null" ] }, "available": { "type": [ "boolean", "null" ] }, "max_nights": { "type": [ "number", "null" ] }, "min_nights": { "type": [ "number", "null" ] }, "local_price": { "type": [ "string", "null" ] }, "available_for_checkin": { "type": [ "boolean", "null" ] }, "available_for_checkout": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "year": { "type": "integer" }, "month": { "type": "integer" } }, "additionalProperties": false } }, "request": { "type": "object", "required": [ "months", "start_month", "start_year" ], "properties": { "months": { "type": "integer" }, "start_year": { "type": "integer" }, "start_month": { "type": "integer" } }, "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "currency": { "type": "string" }, "fetched_at": { "type": "string", "format": "date-time" }, "listing_id": { "type": "string" }, "listing_url": { "type": "string" }, "availability_note": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-calendar", "task_name": "Airbnb calendar", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "months": [ { "days": [ { "date": "sample", "bookable": true, "available": true, "max_nights": 1.5, "min_nights": 1.5, "local_price": "180", "available_for_checkin": true, "available_for_checkout": true } ], "year": 1, "month": 1 } ], "request": { "months": 1, "start_year": 1, "start_month": 1 }, "success": true, "currency": "USD", "fetched_at": "sample", "listing_id": "id-1", "listing_url": "https://example.com/item-1", "availability_note": "sample" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "listing_id", "listing_url", "currency", "months", "request", "availability_note" ], "properties": { "months": { "type": "array", "items": { "type": "object", "required": [ "month", "year", "days" ], "properties": { "days": { "type": "array", "items": { "type": "object", "required": [ "date", "available", "available_for_checkin", "available_for_checkout", "bookable", "min_nights", "max_nights", "local_price" ], "properties": { "date": { "type": "string", "format": "date" }, "bookable": { "type": [ "boolean", "null" ] }, "available": { "type": [ "boolean", "null" ] }, "max_nights": { "type": [ "number", "null" ] }, "min_nights": { "type": [ "number", "null" ] }, "local_price": { "type": [ "string", "null" ] }, "available_for_checkin": { "type": [ "boolean", "null" ] }, "available_for_checkout": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "year": { "type": "integer" }, "month": { "type": "integer" } }, "additionalProperties": false } }, "request": { "type": "object", "required": [ "months", "start_month", "start_year" ], "properties": { "months": { "type": "integer" }, "start_year": { "type": "integer" }, "start_month": { "type": "integer" } }, "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "currency": { "type": "string" }, "fetched_at": { "type": "string", "format": "date-time" }, "listing_id": { "type": "string" }, "listing_url": { "type": "string" }, "availability_note": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-calendar", "task_name": "Airbnb calendar", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAirbnbCalendarAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://([a-z0-9-]+\\.)?airbnb\\.(com|co\\.uk|fr|de|es|it|ca|com\\.au)/rooms/[0-9]+/?([?].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public HTTPS Airbnb listing URL." }, "locale": { "type": "string", "default": "en", "description": "Language code for source content, such as en." }, "months": { "type": "integer", "default": 3, "maximum": 24, "minimum": 1, "description": "Number of calendar months to retrieve." }, "currency": { "type": "string", "default": "USD", "pattern": "^[A-Z]{3}$", "description": "Three-letter currency code, such as USD." }, "start_year": { "type": "integer", "maximum": 2100, "minimum": 2000, "description": "First calendar year to retrieve; defaults to the current year." }, "start_month": { "type": "integer", "maximum": 12, "minimum": 1, "description": "First calendar month, from 1 (January) to 12 (December); defaults to the current month." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.airbnb.com/rooms/21944286" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-airbnb-calendar" }, "x-browsable-website-login-required": false } }, "/v1/tasks/airbnb-host/runs": { "post": { "tags": [ "Airbnb" ], "summary": "Airbnb host", "description": "Read a public Airbnb host profile. Only publicly exposed attributes are returned; unknown fields remain null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "host_id", "profile_url", "profile" ], "properties": { "host_id": { "type": "string" }, "profile": { "type": "object", "required": [ "name", "about", "picture_url", "is_superhost", "hosting_years", "review_count", "rating", "details" ], "properties": { "name": { "type": [ "string", "null" ] }, "about": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "label", "value" ], "properties": { "label": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "picture_url": { "type": [ "string", "null" ] }, "is_superhost": { "type": [ "boolean", "null" ] }, "review_count": { "type": [ "number", "null" ] }, "hosting_years": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "fetched_at": { "type": "string", "format": "date-time" }, "profile_url": { "type": "string" }, "host_id_type": { "enum": [ "legacy", "contextual" ], "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-host", "task_name": "Airbnb host", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "host_id": "id-1", "profile": { "name": "Stylish Shoreditch Loft with Balcony", "about": "sample", "rating": 4.91, "details": [ { "label": "Stylish Shoreditch Loft with Balcony", "value": "180" } ], "picture_url": "https://example.com/item-1", "is_superhost": true, "review_count": 1, "hosting_years": 1.5 }, "success": true, "fetched_at": "sample", "profile_url": "https://example.com/item-1", "host_id_type": "legacy" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "host_id", "profile_url", "profile" ], "properties": { "host_id": { "type": "string" }, "profile": { "type": "object", "required": [ "name", "about", "picture_url", "is_superhost", "hosting_years", "review_count", "rating", "details" ], "properties": { "name": { "type": [ "string", "null" ] }, "about": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "label", "value" ], "properties": { "label": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "picture_url": { "type": [ "string", "null" ] }, "is_superhost": { "type": [ "boolean", "null" ] }, "review_count": { "type": [ "number", "null" ] }, "hosting_years": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "fetched_at": { "type": "string", "format": "date-time" }, "profile_url": { "type": "string" }, "host_id_type": { "enum": [ "legacy", "contextual" ], "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-host", "task_name": "Airbnb host", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAirbnbHostCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://([a-z0-9-]+\\.)?airbnb\\.(com|co\\.uk|fr|de|es|it|ca|com\\.au)/users/(show|profile)/[^/?#]+/?([?].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public Airbnb host profile URL." }, "locale": { "type": "string", "default": "en", "description": "Language code for source content, such as en." }, "currency": { "type": "string", "default": "USD", "pattern": "^[A-Z]{3}$", "description": "Three-letter currency code, such as USD." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.airbnb.com/users/show/123456" } } } }, "x-browsable-website-login-required": false } }, "/v1/airbnb/host": { "post": { "tags": [ "Airbnb" ], "summary": "Airbnb host", "description": "Read a public Airbnb host profile. Only publicly exposed attributes are returned; unknown fields remain null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "host_id", "profile_url", "profile" ], "properties": { "host_id": { "type": "string" }, "profile": { "type": "object", "required": [ "name", "about", "picture_url", "is_superhost", "hosting_years", "review_count", "rating", "details" ], "properties": { "name": { "type": [ "string", "null" ] }, "about": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "label", "value" ], "properties": { "label": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "picture_url": { "type": [ "string", "null" ] }, "is_superhost": { "type": [ "boolean", "null" ] }, "review_count": { "type": [ "number", "null" ] }, "hosting_years": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "fetched_at": { "type": "string", "format": "date-time" }, "profile_url": { "type": "string" }, "host_id_type": { "enum": [ "legacy", "contextual" ], "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-host", "task_name": "Airbnb host", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "host_id": "id-1", "profile": { "name": "Stylish Shoreditch Loft with Balcony", "about": "sample", "rating": 4.91, "details": [ { "label": "Stylish Shoreditch Loft with Balcony", "value": "180" } ], "picture_url": "https://example.com/item-1", "is_superhost": true, "review_count": 1, "hosting_years": 1.5 }, "success": true, "fetched_at": "sample", "profile_url": "https://example.com/item-1", "host_id_type": "legacy" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "host_id", "profile_url", "profile" ], "properties": { "host_id": { "type": "string" }, "profile": { "type": "object", "required": [ "name", "about", "picture_url", "is_superhost", "hosting_years", "review_count", "rating", "details" ], "properties": { "name": { "type": [ "string", "null" ] }, "about": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "array", "items": { "type": "object", "required": [ "label", "value" ], "properties": { "label": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "picture_url": { "type": [ "string", "null" ] }, "is_superhost": { "type": [ "boolean", "null" ] }, "review_count": { "type": [ "number", "null" ] }, "hosting_years": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "success": { "type": "boolean", "const": true }, "fetched_at": { "type": "string", "format": "date-time" }, "profile_url": { "type": "string" }, "host_id_type": { "enum": [ "legacy", "contextual" ], "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-host", "task_name": "Airbnb host", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAirbnbHostAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://([a-z0-9-]+\\.)?airbnb\\.(com|co\\.uk|fr|de|es|it|ca|com\\.au)/users/(show|profile)/[^/?#]+/?([?].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public Airbnb host profile URL." }, "locale": { "type": "string", "default": "en", "description": "Language code for source content, such as en." }, "currency": { "type": "string", "default": "USD", "pattern": "^[A-Z]{3}$", "description": "Three-letter currency code, such as USD." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.airbnb.com/users/show/123456" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-airbnb-host" }, "x-browsable-website-login-required": false } }, "/v1/tasks/airbnb-host-listings/runs": { "post": { "tags": [ "Airbnb" ], "summary": "Airbnb host listings", "description": "Read publicly exposed stays on an Airbnb host profile, with explicit pagination and completeness. Does not infer hidden listings.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "host_id", "profile_url", "listings", "pagination", "completeness" ], "properties": { "host_id": { "type": "string" }, "success": { "type": "boolean", "const": true }, "listings": { "type": "array", "items": { "type": "object", "required": [ "listing_id", "url", "title", "picture_url", "room_type" ], "properties": { "url": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "room_type": { "type": [ "string", "null" ] }, "listing_id": { "type": "string" }, "picture_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "fetched_at": { "type": "string", "format": "date-time" }, "pagination": { "type": "object", "required": [ "total_count", "offset", "limit", "has_more", "next_offset" ], "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "profile_url": { "type": "string" }, "completeness": { "type": "object", "required": [ "status", "reason" ], "properties": { "reason": { "type": [ "string", "null" ] }, "status": { "enum": [ "complete", "partial", "unknown" ], "type": "string" } }, "additionalProperties": false }, "host_id_type": { "enum": [ "legacy", "contextual" ], "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-host-listings", "task_name": "Airbnb host listings", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "host_id": "id-1", "success": true, "listings": [ { "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "room_type": "sample", "listing_id": "id-1", "picture_url": "https://example.com/item-1" } ], "fetched_at": "sample", "pagination": { "limit": 1, "offset": 1, "has_more": true, "next_offset": 1, "total_count": 1 }, "profile_url": "https://example.com/item-1", "completeness": { "reason": "sample", "status": "complete" }, "host_id_type": "legacy" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "host_id", "profile_url", "listings", "pagination", "completeness" ], "properties": { "host_id": { "type": "string" }, "success": { "type": "boolean", "const": true }, "listings": { "type": "array", "items": { "type": "object", "required": [ "listing_id", "url", "title", "picture_url", "room_type" ], "properties": { "url": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "room_type": { "type": [ "string", "null" ] }, "listing_id": { "type": "string" }, "picture_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "fetched_at": { "type": "string", "format": "date-time" }, "pagination": { "type": "object", "required": [ "total_count", "offset", "limit", "has_more", "next_offset" ], "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "profile_url": { "type": "string" }, "completeness": { "type": "object", "required": [ "status", "reason" ], "properties": { "reason": { "type": [ "string", "null" ] }, "status": { "enum": [ "complete", "partial", "unknown" ], "type": "string" } }, "additionalProperties": false }, "host_id_type": { "enum": [ "legacy", "contextual" ], "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-host-listings", "task_name": "Airbnb host listings", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAirbnbHostListingsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://([a-z0-9-]+\\.)?airbnb\\.(com|co\\.uk|fr|de|es|it|ca|com\\.au)/users/(show|profile)/[^/?#]+/?([?].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public Airbnb host profile URL." }, "limit": { "type": "integer", "default": 20, "maximum": 50, "minimum": 1, "description": "Maximum results in this response." }, "locale": { "type": "string", "default": "en", "description": "Language code for source content, such as en." }, "offset": { "type": "integer", "default": 0, "maximum": 10000, "minimum": 0, "description": "Number of results to skip. Start at 0." }, "currency": { "type": "string", "default": "USD", "pattern": "^[A-Z]{3}$", "description": "Three-letter currency code, such as USD." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.airbnb.com/users/show/123456" } } } }, "x-browsable-website-login-required": false } }, "/v1/airbnb/host/listings": { "post": { "tags": [ "Airbnb" ], "summary": "Airbnb host listings", "description": "Read publicly exposed stays on an Airbnb host profile, with explicit pagination and completeness. Does not infer hidden listings.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "host_id", "profile_url", "listings", "pagination", "completeness" ], "properties": { "host_id": { "type": "string" }, "success": { "type": "boolean", "const": true }, "listings": { "type": "array", "items": { "type": "object", "required": [ "listing_id", "url", "title", "picture_url", "room_type" ], "properties": { "url": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "room_type": { "type": [ "string", "null" ] }, "listing_id": { "type": "string" }, "picture_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "fetched_at": { "type": "string", "format": "date-time" }, "pagination": { "type": "object", "required": [ "total_count", "offset", "limit", "has_more", "next_offset" ], "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "profile_url": { "type": "string" }, "completeness": { "type": "object", "required": [ "status", "reason" ], "properties": { "reason": { "type": [ "string", "null" ] }, "status": { "enum": [ "complete", "partial", "unknown" ], "type": "string" } }, "additionalProperties": false }, "host_id_type": { "enum": [ "legacy", "contextual" ], "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-host-listings", "task_name": "Airbnb host listings", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "host_id": "id-1", "success": true, "listings": [ { "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "room_type": "sample", "listing_id": "id-1", "picture_url": "https://example.com/item-1" } ], "fetched_at": "sample", "pagination": { "limit": 1, "offset": 1, "has_more": true, "next_offset": 1, "total_count": 1 }, "profile_url": "https://example.com/item-1", "completeness": { "reason": "sample", "status": "complete" }, "host_id_type": "legacy" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "host_id", "profile_url", "listings", "pagination", "completeness" ], "properties": { "host_id": { "type": "string" }, "success": { "type": "boolean", "const": true }, "listings": { "type": "array", "items": { "type": "object", "required": [ "listing_id", "url", "title", "picture_url", "room_type" ], "properties": { "url": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "room_type": { "type": [ "string", "null" ] }, "listing_id": { "type": "string" }, "picture_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "fetched_at": { "type": "string", "format": "date-time" }, "pagination": { "type": "object", "required": [ "total_count", "offset", "limit", "has_more", "next_offset" ], "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "profile_url": { "type": "string" }, "completeness": { "type": "object", "required": [ "status", "reason" ], "properties": { "reason": { "type": [ "string", "null" ] }, "status": { "enum": [ "complete", "partial", "unknown" ], "type": "string" } }, "additionalProperties": false }, "host_id_type": { "enum": [ "legacy", "contextual" ], "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-host-listings", "task_name": "Airbnb host listings", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAirbnbHostListingsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://([a-z0-9-]+\\.)?airbnb\\.(com|co\\.uk|fr|de|es|it|ca|com\\.au)/users/(show|profile)/[^/?#]+/?([?].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public Airbnb host profile URL." }, "limit": { "type": "integer", "default": 20, "maximum": 50, "minimum": 1, "description": "Maximum results in this response." }, "locale": { "type": "string", "default": "en", "description": "Language code for source content, such as en." }, "offset": { "type": "integer", "default": 0, "maximum": 10000, "minimum": 0, "description": "Number of results to skip. Start at 0." }, "currency": { "type": "string", "default": "USD", "pattern": "^[A-Z]{3}$", "description": "Three-letter currency code, such as USD." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.airbnb.com/users/show/123456" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-airbnb-host-listings" }, "x-browsable-website-login-required": false } }, "/v1/tasks/airbnb-reviews/runs": { "post": { "tags": [ "Airbnb" ], "summary": "Airbnb reviews", "description": "Read paginated public listing reviews, rating summary and host responses. Missing upstream review data fails explicitly.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "listing_id", "listing_url", "summary", "reviews", "pagination", "request" ], "properties": { "request": { "type": "object", "required": [ "limit", "offset", "sort", "tag_name", "tag_label" ], "properties": { "sort": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "tag_name": { "type": [ "string", "null" ] }, "tag_label": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "id", "highlight_mentions", "review_photo_urls" ], "properties": { "id": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "comments": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "response": { "type": [ "string", "null" ] }, "reviewee": { "type": "object", "required": [], "properties": { "name": { "type": [ "string", "null" ] }, "picture_url": { "type": [ "string", "null" ] }, "profile_url": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "reviewer": { "type": "object", "required": [], "properties": { "name": { "type": [ "string", "null" ] }, "picture_url": { "type": [ "string", "null" ] }, "profile_url": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "created_at": { "type": [ "string", "null" ] }, "highlight_type": { "type": [ "string", "null" ] }, "localized_date": { "type": [ "string", "null" ] }, "review_photo_urls": { "type": "array", "items": { "type": "string" } }, "reviewer_location": { "type": [ "string", "null" ] }, "highlight_mentions": { "type": "array", "items": { "type": "string" } }, "localized_responded_date": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "type": "boolean", "const": true }, "summary": { "type": "object", "required": [ "overall_rating", "overall_count", "heading_title", "heading_subtitle_html", "heading_subtitle_text", "categories", "rating_distribution", "available_tags", "available_sorts" ], "properties": { "categories": { "type": "array", "items": { "type": "object", "required": [], "properties": { "type": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "formatted_rating": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "heading_title": { "type": [ "string", "null" ] }, "overall_count": { "type": [ "number", "null" ] }, "available_tags": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "icon_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "overall_rating": { "type": [ "number", "null" ] }, "available_sorts": { "type": "array", "items": { "type": "object", "required": [ "value" ], "properties": { "title": { "type": [ "string", "null" ] }, "value": { "type": "string" } }, "additionalProperties": false } }, "rating_distribution": { "type": "array", "items": { "type": "object", "required": [], "properties": { "label": { "type": [ "string", "null" ] }, "percentage": { "type": [ "number", "null" ] }, "formatted_percentage": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "heading_subtitle_html": { "type": [ "string", "null" ] }, "heading_subtitle_text": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "fetched_at": { "type": "string", "format": "date-time" }, "listing_id": { "type": "string" }, "pagination": { "type": "object", "required": [ "total_count", "offset", "limit", "has_more", "next_offset" ], "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "listing_url": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-reviews", "task_name": "Airbnb reviews", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "request": { "sort": "sample", "limit": 1, "offset": 1, "tag_name": "Stylish Shoreditch Loft with Balcony", "tag_label": "Stylish Shoreditch Loft with Balcony" }, "reviews": [ { "id": "id-1", "rating": 4.91, "comments": "sample", "language": "sample", "response": "sample", "reviewee": { "name": "Stylish Shoreditch Loft with Balcony", "picture_url": "https://example.com/item-1", "profile_url": "https://example.com/item-1" }, "reviewer": { "name": "Stylish Shoreditch Loft with Balcony", "picture_url": "https://example.com/item-1", "profile_url": "https://example.com/item-1" }, "created_at": "2026-06-14T15:30:00Z", "highlight_type": "sample", "localized_date": "sample", "review_photo_urls": [ "https://images.example.com/review_photo_urls-1.jpg" ], "reviewer_location": "London", "highlight_mentions": [ "sample" ], "localized_responded_date": "sample" } ], "success": true, "summary": { "categories": [ { "type": "sample", "label": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "formatted_rating": "sample" } ], "heading_title": "Stylish Shoreditch Loft with Balcony", "overall_count": 1, "available_tags": [ { "name": "Stylish Shoreditch Loft with Balcony", "count": 1, "label": "Stylish Shoreditch Loft with Balcony", "icon_url": "https://images.example.com/icon_url-1.jpg" } ], "overall_rating": 4.91, "available_sorts": [ { "title": "Stylish Shoreditch Loft with Balcony", "value": "180" } ], "rating_distribution": [ { "label": "Stylish Shoreditch Loft with Balcony", "percentage": 1.5, "formatted_percentage": "Featured" } ], "heading_subtitle_html": "Stylish Shoreditch Loft with Balcony", "heading_subtitle_text": "Stylish Shoreditch Loft with Balcony" }, "fetched_at": "sample", "listing_id": "id-1", "pagination": { "limit": 1, "offset": 1, "has_more": true, "next_offset": 1, "total_count": 1 }, "listing_url": "https://example.com/item-1" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "listing_id", "listing_url", "summary", "reviews", "pagination", "request" ], "properties": { "request": { "type": "object", "required": [ "limit", "offset", "sort", "tag_name", "tag_label" ], "properties": { "sort": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "tag_name": { "type": [ "string", "null" ] }, "tag_label": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "id", "highlight_mentions", "review_photo_urls" ], "properties": { "id": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "comments": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "response": { "type": [ "string", "null" ] }, "reviewee": { "type": "object", "required": [], "properties": { "name": { "type": [ "string", "null" ] }, "picture_url": { "type": [ "string", "null" ] }, "profile_url": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "reviewer": { "type": "object", "required": [], "properties": { "name": { "type": [ "string", "null" ] }, "picture_url": { "type": [ "string", "null" ] }, "profile_url": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "created_at": { "type": [ "string", "null" ] }, "highlight_type": { "type": [ "string", "null" ] }, "localized_date": { "type": [ "string", "null" ] }, "review_photo_urls": { "type": "array", "items": { "type": "string" } }, "reviewer_location": { "type": [ "string", "null" ] }, "highlight_mentions": { "type": "array", "items": { "type": "string" } }, "localized_responded_date": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "type": "boolean", "const": true }, "summary": { "type": "object", "required": [ "overall_rating", "overall_count", "heading_title", "heading_subtitle_html", "heading_subtitle_text", "categories", "rating_distribution", "available_tags", "available_sorts" ], "properties": { "categories": { "type": "array", "items": { "type": "object", "required": [], "properties": { "type": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "formatted_rating": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "heading_title": { "type": [ "string", "null" ] }, "overall_count": { "type": [ "number", "null" ] }, "available_tags": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "icon_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "overall_rating": { "type": [ "number", "null" ] }, "available_sorts": { "type": "array", "items": { "type": "object", "required": [ "value" ], "properties": { "title": { "type": [ "string", "null" ] }, "value": { "type": "string" } }, "additionalProperties": false } }, "rating_distribution": { "type": "array", "items": { "type": "object", "required": [], "properties": { "label": { "type": [ "string", "null" ] }, "percentage": { "type": [ "number", "null" ] }, "formatted_percentage": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "heading_subtitle_html": { "type": [ "string", "null" ] }, "heading_subtitle_text": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "fetched_at": { "type": "string", "format": "date-time" }, "listing_id": { "type": "string" }, "pagination": { "type": "object", "required": [ "total_count", "offset", "limit", "has_more", "next_offset" ], "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "listing_url": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-reviews", "task_name": "Airbnb reviews", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAirbnbReviewsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tag": { "type": "string", "description": "Optional review category tag." }, "url": { "type": "string", "format": "uri", "pattern": "^https://([a-z0-9-]+\\.)?airbnb\\.(com|co\\.uk|fr|de|es|it|ca|com\\.au)/rooms/[0-9]+/?([?].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public HTTPS Airbnb listing URL." }, "sort": { "enum": [ "most_recent", "most_relevant", "highest_rated", "lowest_rated" ], "type": "string", "default": "most_recent", "description": "Sort order. Choose an allowed value below." }, "limit": { "type": "integer", "default": 24, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "locale": { "type": "string", "default": "en", "description": "Language code for source content, such as en." }, "offset": { "type": "integer", "default": 0, "maximum": 10000, "minimum": 0, "description": "Number of results to skip. Start at 0." }, "currency": { "type": "string", "default": "USD", "pattern": "^[A-Z]{3}$", "description": "Three-letter currency code, such as USD." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.airbnb.com/rooms/21944286" } } } }, "x-browsable-website-login-required": false } }, "/v1/airbnb/reviews": { "post": { "tags": [ "Airbnb" ], "summary": "Airbnb reviews", "description": "Read paginated public listing reviews, rating summary and host responses. Missing upstream review data fails explicitly.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "listing_id", "listing_url", "summary", "reviews", "pagination", "request" ], "properties": { "request": { "type": "object", "required": [ "limit", "offset", "sort", "tag_name", "tag_label" ], "properties": { "sort": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "tag_name": { "type": [ "string", "null" ] }, "tag_label": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "id", "highlight_mentions", "review_photo_urls" ], "properties": { "id": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "comments": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "response": { "type": [ "string", "null" ] }, "reviewee": { "type": "object", "required": [], "properties": { "name": { "type": [ "string", "null" ] }, "picture_url": { "type": [ "string", "null" ] }, "profile_url": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "reviewer": { "type": "object", "required": [], "properties": { "name": { "type": [ "string", "null" ] }, "picture_url": { "type": [ "string", "null" ] }, "profile_url": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "created_at": { "type": [ "string", "null" ] }, "highlight_type": { "type": [ "string", "null" ] }, "localized_date": { "type": [ "string", "null" ] }, "review_photo_urls": { "type": "array", "items": { "type": "string" } }, "reviewer_location": { "type": [ "string", "null" ] }, "highlight_mentions": { "type": "array", "items": { "type": "string" } }, "localized_responded_date": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "type": "boolean", "const": true }, "summary": { "type": "object", "required": [ "overall_rating", "overall_count", "heading_title", "heading_subtitle_html", "heading_subtitle_text", "categories", "rating_distribution", "available_tags", "available_sorts" ], "properties": { "categories": { "type": "array", "items": { "type": "object", "required": [], "properties": { "type": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "formatted_rating": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "heading_title": { "type": [ "string", "null" ] }, "overall_count": { "type": [ "number", "null" ] }, "available_tags": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "icon_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "overall_rating": { "type": [ "number", "null" ] }, "available_sorts": { "type": "array", "items": { "type": "object", "required": [ "value" ], "properties": { "title": { "type": [ "string", "null" ] }, "value": { "type": "string" } }, "additionalProperties": false } }, "rating_distribution": { "type": "array", "items": { "type": "object", "required": [], "properties": { "label": { "type": [ "string", "null" ] }, "percentage": { "type": [ "number", "null" ] }, "formatted_percentage": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "heading_subtitle_html": { "type": [ "string", "null" ] }, "heading_subtitle_text": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "fetched_at": { "type": "string", "format": "date-time" }, "listing_id": { "type": "string" }, "pagination": { "type": "object", "required": [ "total_count", "offset", "limit", "has_more", "next_offset" ], "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "listing_url": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-reviews", "task_name": "Airbnb reviews", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "request": { "sort": "sample", "limit": 1, "offset": 1, "tag_name": "Stylish Shoreditch Loft with Balcony", "tag_label": "Stylish Shoreditch Loft with Balcony" }, "reviews": [ { "id": "id-1", "rating": 4.91, "comments": "sample", "language": "sample", "response": "sample", "reviewee": { "name": "Stylish Shoreditch Loft with Balcony", "picture_url": "https://example.com/item-1", "profile_url": "https://example.com/item-1" }, "reviewer": { "name": "Stylish Shoreditch Loft with Balcony", "picture_url": "https://example.com/item-1", "profile_url": "https://example.com/item-1" }, "created_at": "2026-06-14T15:30:00Z", "highlight_type": "sample", "localized_date": "sample", "review_photo_urls": [ "https://images.example.com/review_photo_urls-1.jpg" ], "reviewer_location": "London", "highlight_mentions": [ "sample" ], "localized_responded_date": "sample" } ], "success": true, "summary": { "categories": [ { "type": "sample", "label": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "formatted_rating": "sample" } ], "heading_title": "Stylish Shoreditch Loft with Balcony", "overall_count": 1, "available_tags": [ { "name": "Stylish Shoreditch Loft with Balcony", "count": 1, "label": "Stylish Shoreditch Loft with Balcony", "icon_url": "https://images.example.com/icon_url-1.jpg" } ], "overall_rating": 4.91, "available_sorts": [ { "title": "Stylish Shoreditch Loft with Balcony", "value": "180" } ], "rating_distribution": [ { "label": "Stylish Shoreditch Loft with Balcony", "percentage": 1.5, "formatted_percentage": "Featured" } ], "heading_subtitle_html": "Stylish Shoreditch Loft with Balcony", "heading_subtitle_text": "Stylish Shoreditch Loft with Balcony" }, "fetched_at": "sample", "listing_id": "id-1", "pagination": { "limit": 1, "offset": 1, "has_more": true, "next_offset": 1, "total_count": 1 }, "listing_url": "https://example.com/item-1" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "required": [ "success", "fetched_at", "listing_id", "listing_url", "summary", "reviews", "pagination", "request" ], "properties": { "request": { "type": "object", "required": [ "limit", "offset", "sort", "tag_name", "tag_label" ], "properties": { "sort": { "type": "string" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "tag_name": { "type": [ "string", "null" ] }, "tag_label": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "id", "highlight_mentions", "review_photo_urls" ], "properties": { "id": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "comments": { "type": [ "string", "null" ] }, "language": { "type": [ "string", "null" ] }, "response": { "type": [ "string", "null" ] }, "reviewee": { "type": "object", "required": [], "properties": { "name": { "type": [ "string", "null" ] }, "picture_url": { "type": [ "string", "null" ] }, "profile_url": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "reviewer": { "type": "object", "required": [], "properties": { "name": { "type": [ "string", "null" ] }, "picture_url": { "type": [ "string", "null" ] }, "profile_url": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "created_at": { "type": [ "string", "null" ] }, "highlight_type": { "type": [ "string", "null" ] }, "localized_date": { "type": [ "string", "null" ] }, "review_photo_urls": { "type": "array", "items": { "type": "string" } }, "reviewer_location": { "type": [ "string", "null" ] }, "highlight_mentions": { "type": "array", "items": { "type": "string" } }, "localized_responded_date": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "type": "boolean", "const": true }, "summary": { "type": "object", "required": [ "overall_rating", "overall_count", "heading_title", "heading_subtitle_html", "heading_subtitle_text", "categories", "rating_distribution", "available_tags", "available_sorts" ], "properties": { "categories": { "type": "array", "items": { "type": "object", "required": [], "properties": { "type": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "formatted_rating": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "heading_title": { "type": [ "string", "null" ] }, "overall_count": { "type": [ "number", "null" ] }, "available_tags": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "icon_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "overall_rating": { "type": [ "number", "null" ] }, "available_sorts": { "type": "array", "items": { "type": "object", "required": [ "value" ], "properties": { "title": { "type": [ "string", "null" ] }, "value": { "type": "string" } }, "additionalProperties": false } }, "rating_distribution": { "type": "array", "items": { "type": "object", "required": [], "properties": { "label": { "type": [ "string", "null" ] }, "percentage": { "type": [ "number", "null" ] }, "formatted_percentage": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "heading_subtitle_html": { "type": [ "string", "null" ] }, "heading_subtitle_text": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "fetched_at": { "type": "string", "format": "date-time" }, "listing_id": { "type": "string" }, "pagination": { "type": "object", "required": [ "total_count", "offset", "limit", "has_more", "next_offset" ], "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "has_more": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "listing_url": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-reviews", "task_name": "Airbnb reviews", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAirbnbReviewsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tag": { "type": "string", "description": "Optional review category tag." }, "url": { "type": "string", "format": "uri", "pattern": "^https://([a-z0-9-]+\\.)?airbnb\\.(com|co\\.uk|fr|de|es|it|ca|com\\.au)/rooms/[0-9]+/?([?].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public HTTPS Airbnb listing URL." }, "sort": { "enum": [ "most_recent", "most_relevant", "highest_rated", "lowest_rated" ], "type": "string", "default": "most_recent", "description": "Sort order. Choose an allowed value below." }, "limit": { "type": "integer", "default": 24, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "locale": { "type": "string", "default": "en", "description": "Language code for source content, such as en." }, "offset": { "type": "integer", "default": 0, "maximum": 10000, "minimum": 0, "description": "Number of results to skip. Start at 0." }, "currency": { "type": "string", "default": "USD", "pattern": "^[A-Z]{3}$", "description": "Three-letter currency code, such as USD." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.airbnb.com/rooms/21944286" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-airbnb-reviews" }, "x-browsable-website-login-required": false } }, "/v1/tasks/airbnb-room/runs": { "post": { "tags": [ "Airbnb" ], "summary": "Airbnb room", "description": "Fetch an Airbnb room/listing page and return normalized details, photos, host info, amenities, reviews, policies, and availability.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "listing_id", "listing_url", "locale", "currency", "requested_stay", "review_request", "calendar_request", "photos", "reviews" ], "properties": { "host": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "hotel": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "offers": { "type": "array", "items": { "type": "object", "properties": { "room_id": { "type": [ "string", "null" ] }, "capacity": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "room_url": { "type": [ "string", "null" ] }, "available": { "type": [ "boolean", "null" ] }, "breakdown": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "display_price": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "room_name": { "type": [ "string", "null" ] }, "attributes": { "type": "array", "items": { "type": "string" } }, "rate_plans": { "type": "array", "items": { "type": "object", "properties": { "add_ons": { "type": "array", "items": {} }, "selected": { "type": "boolean" }, "refundable": { "type": [ "boolean", "null" ] }, "cancellation": { "type": [ "string", "null" ] }, "rate_plan_id": { "type": [ "string", "null" ] }, "price_adjustment": { "type": [ "number", "null" ] }, "cancellation_details": { "type": [ "string", "null" ] }, "price_adjustment_type": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "tax_status": { "type": [ "string", "null" ] }, "disclaimers": { "type": "array", "items": { "type": "string" } }, "price_basis": { "type": [ "string", "null" ] }, "credit_offer": { "type": [ "string", "null" ] }, "display_price": { "type": [ "string", "null" ] }, "selected_dates": { "type": [ "string", "null" ] }, "displayed_total": { "type": [ "number", "null" ] }, "price_qualifier": { "type": [ "string", "null" ] }, "selected_rate_plan_id": { "type": [ "string", "null" ] }, "total_including_taxes": { "type": [ "number", "null" ] } }, "additionalProperties": true } }, "address": { "type": [ "string", "null" ] }, "coverage": { "type": [ "string", "null" ] }, "returned_rooms": { "type": [ "number", "null" ] }, "advertised_rooms": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locale": { "type": "string" }, "photos": { "type": "object" }, "pricing": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "reviews": { "type": "object" }, "success": { "type": "boolean" }, "calendar": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "currency": { "type": "string" }, "location": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "overview": { "type": "object" }, "policies": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "amenities": { "type": "object" }, "share_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "highlights": { "type": "array", "items": { "type": "object", "properties": { "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "listing_id": { "type": "string" }, "description": { "type": "object" }, "hotel_quote": { "type": "object", "properties": { "reason": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "available": { "type": "boolean" }, "meal_plan": { "type": "object", "properties": { "evidence": { "type": [ "string", "null" ] }, "rate_add_ons": { "type": "array", "items": {} }, "breakfast_included": { "type": [ "boolean", "null" ] } }, "additionalProperties": true }, "room_name": { "type": [ "string", "null" ] }, "hotel_name": { "type": [ "string", "null" ] }, "observed_at": { "type": [ "string", "null" ] }, "price_items": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "details": { "type": "array", "items": { "type": "object" } }, "display": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "cancellation": { "type": [ "string", "null" ] }, "rate_plan_id": { "type": [ "string", "null" ] }, "room_details": { "type": "object", "properties": { "amenities": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "attributes": { "type": "array", "items": { "type": "string" } }, "photo_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "source_total": { "type": [ "number", "null" ] }, "tax_evidence": { "type": [ "string", "null" ] }, "observed_stay": { "type": "object", "properties": { "pets": { "type": [ "number", "null" ] }, "adults": { "type": [ "number", "null" ] }, "checkin": { "type": [ "string", "null" ] }, "infants": { "type": [ "number", "null" ] }, "room_id": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] }, "children": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "stay_verified": { "type": "boolean" }, "quote_complete": { "type": "boolean" }, "rate_selection": { "type": [ "string", "null" ] }, "payment_options": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "disclaimer": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "amounts_reconcile": { "type": "boolean" }, "rate_plan_verified": { "type": "boolean" }, "total_including_taxes": { "type": [ "number", "null" ] }, "cancellation_milestones": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": true }, "listing_url": { "type": "string" }, "canonical_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "property_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "summary_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "requested_stay": { "type": "object" }, "review_request": { "type": "object" }, "person_capacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "calendar_request": { "type": "object" }, "location_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sleeping_arrangements": { "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "images": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-room", "task_name": "Airbnb room", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "host": {}, "hotel": { "title": "Stylish Shoreditch Loft with Balcony", "offers": [ { "room_id": "id-1", "capacity": 1.5, "currency": "USD", "room_url": "https://example.com/item-1", "available": true, "breakdown": [ { "label": "Stylish Shoreditch Loft with Balcony", "amount": 180, "display_price": "GBP 210 total" } ], "room_name": "Stylish Shoreditch Loft with Balcony", "attributes": [ "sample" ], "rate_plans": [ { "add_ons": [ "sample" ], "selected": true, "refundable": true, "cancellation": "sample", "rate_plan_id": "id-1", "price_adjustment": 180, "cancellation_details": "2 guests", "price_adjustment_type": "180" } ], "tax_status": "sample", "disclaimers": [ "sample" ], "price_basis": "180", "credit_offer": "sample", "display_price": "GBP 210 total", "selected_dates": "sample", "displayed_total": 180, "price_qualifier": "for 1 night", "selected_rate_plan_id": "id-1", "total_including_taxes": 180 } ], "address": "sample", "coverage": "sample", "returned_rooms": 1.5, "advertised_rooms": 1.5 }, "title": "Stylish Shoreditch Loft with Balcony", "locale": "sample", "photos": {}, "pricing": {}, "reviews": {}, "success": true, "calendar": {}, "currency": "USD", "location": {}, "overview": {}, "policies": {}, "amenities": {}, "share_url": "https://example.com/item-1", "highlights": [ { "icon": "https://images.example.com/icon-1.jpg", "type": "sample", "title": "Stylish Shoreditch Loft with Balcony", "subtitle": "Stylish Shoreditch Loft with Balcony" } ], "listing_id": "id-1", "description": {}, "hotel_quote": { "reason": "sample", "source": "sample", "currency": "USD", "available": true, "meal_plan": { "evidence": "id-1", "rate_add_ons": [ "sample" ], "breakfast_included": true }, "room_name": "Stylish Shoreditch Loft with Balcony", "hotel_name": "Stylish Shoreditch Loft with Balcony", "observed_at": "sample", "price_items": [ { "type": "sample", "label": "Stylish Shoreditch Loft with Balcony", "amount": 180, "details": [ {} ], "display": "sample", "currency": "USD" } ], "cancellation": "sample", "rate_plan_id": "id-1", "room_details": { "amenities": [ { "title": "Stylish Shoreditch Loft with Balcony", "subtitle": "Stylish Shoreditch Loft with Balcony" } ], "attributes": [ "sample" ], "photo_urls": [ "https://images.example.com/photo_urls-1.jpg" ], "description": "Sample description 1" }, "source_total": 180, "tax_evidence": "id-1", "observed_stay": { "pets": 1.5, "adults": 1, "checkin": "2026-06-14", "infants": 1.5, "room_id": "id-1", "checkout": "2026-06-21", "children": 1 }, "stay_verified": true, "quote_complete": true, "rate_selection": "sample", "payment_options": [ { "type": "sample", "title": "Stylish Shoreditch Loft with Balcony", "subtitle": "Stylish Shoreditch Loft with Balcony", "disclaimer": "sample" } ], "amounts_reconcile": true, "rate_plan_verified": true, "total_including_taxes": 180, "cancellation_milestones": [ {} ] }, "listing_url": "https://example.com/item-1", "canonical_url": "https://example.com/item-1", "property_type": "sample", "summary_title": "Stylish Shoreditch Loft with Balcony", "requested_stay": {}, "review_request": {}, "person_capacity": 1.5, "calendar_request": {}, "location_summary": "Sample location_summary 1", "sleeping_arrangements": [ { "title": "Stylish Shoreditch Loft with Balcony", "images": [ { "id": "id-1", "url": "https://example.com/item-1", "caption": "sample" } ], "subtitle": "Stylish Shoreditch Loft with Balcony" } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "listing_id", "listing_url", "locale", "currency", "requested_stay", "review_request", "calendar_request", "photos", "reviews" ], "properties": { "host": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "hotel": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "offers": { "type": "array", "items": { "type": "object", "properties": { "room_id": { "type": [ "string", "null" ] }, "capacity": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "room_url": { "type": [ "string", "null" ] }, "available": { "type": [ "boolean", "null" ] }, "breakdown": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "display_price": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "room_name": { "type": [ "string", "null" ] }, "attributes": { "type": "array", "items": { "type": "string" } }, "rate_plans": { "type": "array", "items": { "type": "object", "properties": { "add_ons": { "type": "array", "items": {} }, "selected": { "type": "boolean" }, "refundable": { "type": [ "boolean", "null" ] }, "cancellation": { "type": [ "string", "null" ] }, "rate_plan_id": { "type": [ "string", "null" ] }, "price_adjustment": { "type": [ "number", "null" ] }, "cancellation_details": { "type": [ "string", "null" ] }, "price_adjustment_type": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "tax_status": { "type": [ "string", "null" ] }, "disclaimers": { "type": "array", "items": { "type": "string" } }, "price_basis": { "type": [ "string", "null" ] }, "credit_offer": { "type": [ "string", "null" ] }, "display_price": { "type": [ "string", "null" ] }, "selected_dates": { "type": [ "string", "null" ] }, "displayed_total": { "type": [ "number", "null" ] }, "price_qualifier": { "type": [ "string", "null" ] }, "selected_rate_plan_id": { "type": [ "string", "null" ] }, "total_including_taxes": { "type": [ "number", "null" ] } }, "additionalProperties": true } }, "address": { "type": [ "string", "null" ] }, "coverage": { "type": [ "string", "null" ] }, "returned_rooms": { "type": [ "number", "null" ] }, "advertised_rooms": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locale": { "type": "string" }, "photos": { "type": "object" }, "pricing": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "reviews": { "type": "object" }, "success": { "type": "boolean" }, "calendar": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "currency": { "type": "string" }, "location": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "overview": { "type": "object" }, "policies": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "amenities": { "type": "object" }, "share_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "highlights": { "type": "array", "items": { "type": "object", "properties": { "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "listing_id": { "type": "string" }, "description": { "type": "object" }, "hotel_quote": { "type": "object", "properties": { "reason": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "available": { "type": "boolean" }, "meal_plan": { "type": "object", "properties": { "evidence": { "type": [ "string", "null" ] }, "rate_add_ons": { "type": "array", "items": {} }, "breakfast_included": { "type": [ "boolean", "null" ] } }, "additionalProperties": true }, "room_name": { "type": [ "string", "null" ] }, "hotel_name": { "type": [ "string", "null" ] }, "observed_at": { "type": [ "string", "null" ] }, "price_items": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "details": { "type": "array", "items": { "type": "object" } }, "display": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "cancellation": { "type": [ "string", "null" ] }, "rate_plan_id": { "type": [ "string", "null" ] }, "room_details": { "type": "object", "properties": { "amenities": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "attributes": { "type": "array", "items": { "type": "string" } }, "photo_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "source_total": { "type": [ "number", "null" ] }, "tax_evidence": { "type": [ "string", "null" ] }, "observed_stay": { "type": "object", "properties": { "pets": { "type": [ "number", "null" ] }, "adults": { "type": [ "number", "null" ] }, "checkin": { "type": [ "string", "null" ] }, "infants": { "type": [ "number", "null" ] }, "room_id": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] }, "children": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "stay_verified": { "type": "boolean" }, "quote_complete": { "type": "boolean" }, "rate_selection": { "type": [ "string", "null" ] }, "payment_options": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "disclaimer": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "amounts_reconcile": { "type": "boolean" }, "rate_plan_verified": { "type": "boolean" }, "total_including_taxes": { "type": [ "number", "null" ] }, "cancellation_milestones": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": true }, "listing_url": { "type": "string" }, "canonical_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "property_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "summary_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "requested_stay": { "type": "object" }, "review_request": { "type": "object" }, "person_capacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "calendar_request": { "type": "object" }, "location_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sleeping_arrangements": { "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "images": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-room", "task_name": "Airbnb room", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAirbnbRoomCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.airbnb.com/rooms/21944286?check_in=2027-06-14&check_out=2027-06-21", "maxLength": 2000, "minLength": 1, "description": "Full Airbnb room URL." }, "pets": { "type": "integer", "maximum": 16, "minimum": 0, "description": "Number of pets." }, "adults": { "type": "integer", "maximum": 16, "minimum": 1, "description": "Number of adult guests or travellers." }, "checkin": { "type": "string", "format": "date", "description": "Check-in date. Overrides check_in in the URL; supply with checkout." }, "infants": { "type": "integer", "maximum": 16, "minimum": 0, "description": "Number of infant guests." }, "checkout": { "type": "string", "format": "date", "description": "Check-out date. Overrides check_out in the URL." }, "children": { "type": "integer", "maximum": 16, "minimum": 0, "description": "Number of child guests." }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Display currency; defaults to URL currency or site default." }, "rate_plan_id": { "type": "string", "pattern": "^[0-9]+$", "x-advanced": true, "description": "Optional rate plan from hotel.offers; used with include_quote." }, "include_quote": { "type": "boolean", "description": "Fetch a read-only tax-inclusive quote and full attributes for the room identified by the URL. Requires dates. Does not book." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.airbnb.com/rooms/21944286" } } } }, "x-browsable-website-login-required": false } }, "/v1/airbnb/room": { "post": { "tags": [ "Airbnb" ], "summary": "Airbnb room", "description": "Fetch an Airbnb room/listing page and return normalized details, photos, host info, amenities, reviews, policies, and availability.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "listing_id", "listing_url", "locale", "currency", "requested_stay", "review_request", "calendar_request", "photos", "reviews" ], "properties": { "host": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "hotel": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "offers": { "type": "array", "items": { "type": "object", "properties": { "room_id": { "type": [ "string", "null" ] }, "capacity": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "room_url": { "type": [ "string", "null" ] }, "available": { "type": [ "boolean", "null" ] }, "breakdown": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "display_price": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "room_name": { "type": [ "string", "null" ] }, "attributes": { "type": "array", "items": { "type": "string" } }, "rate_plans": { "type": "array", "items": { "type": "object", "properties": { "add_ons": { "type": "array", "items": {} }, "selected": { "type": "boolean" }, "refundable": { "type": [ "boolean", "null" ] }, "cancellation": { "type": [ "string", "null" ] }, "rate_plan_id": { "type": [ "string", "null" ] }, "price_adjustment": { "type": [ "number", "null" ] }, "cancellation_details": { "type": [ "string", "null" ] }, "price_adjustment_type": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "tax_status": { "type": [ "string", "null" ] }, "disclaimers": { "type": "array", "items": { "type": "string" } }, "price_basis": { "type": [ "string", "null" ] }, "credit_offer": { "type": [ "string", "null" ] }, "display_price": { "type": [ "string", "null" ] }, "selected_dates": { "type": [ "string", "null" ] }, "displayed_total": { "type": [ "number", "null" ] }, "price_qualifier": { "type": [ "string", "null" ] }, "selected_rate_plan_id": { "type": [ "string", "null" ] }, "total_including_taxes": { "type": [ "number", "null" ] } }, "additionalProperties": true } }, "address": { "type": [ "string", "null" ] }, "coverage": { "type": [ "string", "null" ] }, "returned_rooms": { "type": [ "number", "null" ] }, "advertised_rooms": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locale": { "type": "string" }, "photos": { "type": "object" }, "pricing": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "reviews": { "type": "object" }, "success": { "type": "boolean" }, "calendar": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "currency": { "type": "string" }, "location": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "overview": { "type": "object" }, "policies": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "amenities": { "type": "object" }, "share_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "highlights": { "type": "array", "items": { "type": "object", "properties": { "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "listing_id": { "type": "string" }, "description": { "type": "object" }, "hotel_quote": { "type": "object", "properties": { "reason": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "available": { "type": "boolean" }, "meal_plan": { "type": "object", "properties": { "evidence": { "type": [ "string", "null" ] }, "rate_add_ons": { "type": "array", "items": {} }, "breakfast_included": { "type": [ "boolean", "null" ] } }, "additionalProperties": true }, "room_name": { "type": [ "string", "null" ] }, "hotel_name": { "type": [ "string", "null" ] }, "observed_at": { "type": [ "string", "null" ] }, "price_items": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "details": { "type": "array", "items": { "type": "object" } }, "display": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "cancellation": { "type": [ "string", "null" ] }, "rate_plan_id": { "type": [ "string", "null" ] }, "room_details": { "type": "object", "properties": { "amenities": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "attributes": { "type": "array", "items": { "type": "string" } }, "photo_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "source_total": { "type": [ "number", "null" ] }, "tax_evidence": { "type": [ "string", "null" ] }, "observed_stay": { "type": "object", "properties": { "pets": { "type": [ "number", "null" ] }, "adults": { "type": [ "number", "null" ] }, "checkin": { "type": [ "string", "null" ] }, "infants": { "type": [ "number", "null" ] }, "room_id": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] }, "children": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "stay_verified": { "type": "boolean" }, "quote_complete": { "type": "boolean" }, "rate_selection": { "type": [ "string", "null" ] }, "payment_options": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "disclaimer": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "amounts_reconcile": { "type": "boolean" }, "rate_plan_verified": { "type": "boolean" }, "total_including_taxes": { "type": [ "number", "null" ] }, "cancellation_milestones": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": true }, "listing_url": { "type": "string" }, "canonical_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "property_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "summary_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "requested_stay": { "type": "object" }, "review_request": { "type": "object" }, "person_capacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "calendar_request": { "type": "object" }, "location_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sleeping_arrangements": { "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "images": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-room", "task_name": "Airbnb room", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "host": {}, "hotel": { "title": "Stylish Shoreditch Loft with Balcony", "offers": [ { "room_id": "id-1", "capacity": 1.5, "currency": "USD", "room_url": "https://example.com/item-1", "available": true, "breakdown": [ { "label": "Stylish Shoreditch Loft with Balcony", "amount": 180, "display_price": "GBP 210 total" } ], "room_name": "Stylish Shoreditch Loft with Balcony", "attributes": [ "sample" ], "rate_plans": [ { "add_ons": [ "sample" ], "selected": true, "refundable": true, "cancellation": "sample", "rate_plan_id": "id-1", "price_adjustment": 180, "cancellation_details": "2 guests", "price_adjustment_type": "180" } ], "tax_status": "sample", "disclaimers": [ "sample" ], "price_basis": "180", "credit_offer": "sample", "display_price": "GBP 210 total", "selected_dates": "sample", "displayed_total": 180, "price_qualifier": "for 1 night", "selected_rate_plan_id": "id-1", "total_including_taxes": 180 } ], "address": "sample", "coverage": "sample", "returned_rooms": 1.5, "advertised_rooms": 1.5 }, "title": "Stylish Shoreditch Loft with Balcony", "locale": "sample", "photos": {}, "pricing": {}, "reviews": {}, "success": true, "calendar": {}, "currency": "USD", "location": {}, "overview": {}, "policies": {}, "amenities": {}, "share_url": "https://example.com/item-1", "highlights": [ { "icon": "https://images.example.com/icon-1.jpg", "type": "sample", "title": "Stylish Shoreditch Loft with Balcony", "subtitle": "Stylish Shoreditch Loft with Balcony" } ], "listing_id": "id-1", "description": {}, "hotel_quote": { "reason": "sample", "source": "sample", "currency": "USD", "available": true, "meal_plan": { "evidence": "id-1", "rate_add_ons": [ "sample" ], "breakfast_included": true }, "room_name": "Stylish Shoreditch Loft with Balcony", "hotel_name": "Stylish Shoreditch Loft with Balcony", "observed_at": "sample", "price_items": [ { "type": "sample", "label": "Stylish Shoreditch Loft with Balcony", "amount": 180, "details": [ {} ], "display": "sample", "currency": "USD" } ], "cancellation": "sample", "rate_plan_id": "id-1", "room_details": { "amenities": [ { "title": "Stylish Shoreditch Loft with Balcony", "subtitle": "Stylish Shoreditch Loft with Balcony" } ], "attributes": [ "sample" ], "photo_urls": [ "https://images.example.com/photo_urls-1.jpg" ], "description": "Sample description 1" }, "source_total": 180, "tax_evidence": "id-1", "observed_stay": { "pets": 1.5, "adults": 1, "checkin": "2026-06-14", "infants": 1.5, "room_id": "id-1", "checkout": "2026-06-21", "children": 1 }, "stay_verified": true, "quote_complete": true, "rate_selection": "sample", "payment_options": [ { "type": "sample", "title": "Stylish Shoreditch Loft with Balcony", "subtitle": "Stylish Shoreditch Loft with Balcony", "disclaimer": "sample" } ], "amounts_reconcile": true, "rate_plan_verified": true, "total_including_taxes": 180, "cancellation_milestones": [ {} ] }, "listing_url": "https://example.com/item-1", "canonical_url": "https://example.com/item-1", "property_type": "sample", "summary_title": "Stylish Shoreditch Loft with Balcony", "requested_stay": {}, "review_request": {}, "person_capacity": 1.5, "calendar_request": {}, "location_summary": "Sample location_summary 1", "sleeping_arrangements": [ { "title": "Stylish Shoreditch Loft with Balcony", "images": [ { "id": "id-1", "url": "https://example.com/item-1", "caption": "sample" } ], "subtitle": "Stylish Shoreditch Loft with Balcony" } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "listing_id", "listing_url", "locale", "currency", "requested_stay", "review_request", "calendar_request", "photos", "reviews" ], "properties": { "host": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "hotel": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "offers": { "type": "array", "items": { "type": "object", "properties": { "room_id": { "type": [ "string", "null" ] }, "capacity": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "room_url": { "type": [ "string", "null" ] }, "available": { "type": [ "boolean", "null" ] }, "breakdown": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "display_price": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "room_name": { "type": [ "string", "null" ] }, "attributes": { "type": "array", "items": { "type": "string" } }, "rate_plans": { "type": "array", "items": { "type": "object", "properties": { "add_ons": { "type": "array", "items": {} }, "selected": { "type": "boolean" }, "refundable": { "type": [ "boolean", "null" ] }, "cancellation": { "type": [ "string", "null" ] }, "rate_plan_id": { "type": [ "string", "null" ] }, "price_adjustment": { "type": [ "number", "null" ] }, "cancellation_details": { "type": [ "string", "null" ] }, "price_adjustment_type": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "tax_status": { "type": [ "string", "null" ] }, "disclaimers": { "type": "array", "items": { "type": "string" } }, "price_basis": { "type": [ "string", "null" ] }, "credit_offer": { "type": [ "string", "null" ] }, "display_price": { "type": [ "string", "null" ] }, "selected_dates": { "type": [ "string", "null" ] }, "displayed_total": { "type": [ "number", "null" ] }, "price_qualifier": { "type": [ "string", "null" ] }, "selected_rate_plan_id": { "type": [ "string", "null" ] }, "total_including_taxes": { "type": [ "number", "null" ] } }, "additionalProperties": true } }, "address": { "type": [ "string", "null" ] }, "coverage": { "type": [ "string", "null" ] }, "returned_rooms": { "type": [ "number", "null" ] }, "advertised_rooms": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locale": { "type": "string" }, "photos": { "type": "object" }, "pricing": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "reviews": { "type": "object" }, "success": { "type": "boolean" }, "calendar": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "currency": { "type": "string" }, "location": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "overview": { "type": "object" }, "policies": { "anyOf": [ { "type": "object" }, { "type": "null" } ] }, "amenities": { "type": "object" }, "share_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "highlights": { "type": "array", "items": { "type": "object", "properties": { "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "listing_id": { "type": "string" }, "description": { "type": "object" }, "hotel_quote": { "type": "object", "properties": { "reason": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "available": { "type": "boolean" }, "meal_plan": { "type": "object", "properties": { "evidence": { "type": [ "string", "null" ] }, "rate_add_ons": { "type": "array", "items": {} }, "breakfast_included": { "type": [ "boolean", "null" ] } }, "additionalProperties": true }, "room_name": { "type": [ "string", "null" ] }, "hotel_name": { "type": [ "string", "null" ] }, "observed_at": { "type": [ "string", "null" ] }, "price_items": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "label": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "details": { "type": "array", "items": { "type": "object" } }, "display": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "cancellation": { "type": [ "string", "null" ] }, "rate_plan_id": { "type": [ "string", "null" ] }, "room_details": { "type": "object", "properties": { "amenities": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "attributes": { "type": "array", "items": { "type": "string" } }, "photo_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "source_total": { "type": [ "number", "null" ] }, "tax_evidence": { "type": [ "string", "null" ] }, "observed_stay": { "type": "object", "properties": { "pets": { "type": [ "number", "null" ] }, "adults": { "type": [ "number", "null" ] }, "checkin": { "type": [ "string", "null" ] }, "infants": { "type": [ "number", "null" ] }, "room_id": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] }, "children": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "stay_verified": { "type": "boolean" }, "quote_complete": { "type": "boolean" }, "rate_selection": { "type": [ "string", "null" ] }, "payment_options": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "subtitle": { "type": [ "string", "null" ] }, "disclaimer": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "amounts_reconcile": { "type": "boolean" }, "rate_plan_verified": { "type": "boolean" }, "total_including_taxes": { "type": [ "number", "null" ] }, "cancellation_milestones": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": true }, "listing_url": { "type": "string" }, "canonical_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "property_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "summary_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "requested_stay": { "type": "object" }, "review_request": { "type": "object" }, "person_capacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "calendar_request": { "type": "object" }, "location_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sleeping_arrangements": { "type": "array", "items": { "type": "object", "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "images": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-room", "task_name": "Airbnb room", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAirbnbRoomAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.airbnb.com/rooms/21944286?check_in=2027-06-14&check_out=2027-06-21", "maxLength": 2000, "minLength": 1, "description": "Full Airbnb room URL." }, "pets": { "type": "integer", "maximum": 16, "minimum": 0, "description": "Number of pets." }, "adults": { "type": "integer", "maximum": 16, "minimum": 1, "description": "Number of adult guests or travellers." }, "checkin": { "type": "string", "format": "date", "description": "Check-in date. Overrides check_in in the URL; supply with checkout." }, "infants": { "type": "integer", "maximum": 16, "minimum": 0, "description": "Number of infant guests." }, "checkout": { "type": "string", "format": "date", "description": "Check-out date. Overrides check_out in the URL." }, "children": { "type": "integer", "maximum": 16, "minimum": 0, "description": "Number of child guests." }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$", "description": "Display currency; defaults to URL currency or site default." }, "rate_plan_id": { "type": "string", "pattern": "^[0-9]+$", "x-advanced": true, "description": "Optional rate plan from hotel.offers; used with include_quote." }, "include_quote": { "type": "boolean", "description": "Fetch a read-only tax-inclusive quote and full attributes for the room identified by the URL. Requires dates. Does not book." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.airbnb.com/rooms/21944286" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-airbnb-room" }, "x-browsable-website-login-required": false } }, "/v1/tasks/airbnb-search/runs": { "post": { "tags": [ "Airbnb" ], "summary": "Airbnb search", "description": "Search Airbnb stay results for a destination/date combination and return normalized listings with cursor pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "checkin", "checkout", "adults", "children", "applied_filters", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "adults": { "type": "number" }, "checkin": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "badges", "payment_messages", "image_urls", "details", "price" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "display", "amount_numeric", "currency", "qualifier" ], "properties": { "display": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "qualifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "original_display": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "original_amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "string" } }, "location": { "anyOf": [ { "type": "object", "required": [ "lat", "lng" ], "properties": { "lat": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lng": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "subtitle": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "rating_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "review_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "payment_messages": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } }, "success": { "type": "boolean" }, "checkout": { "type": "string" }, "children": { "type": "number" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page", "next_page_cursor", "previous_page_cursor", "page_cursors" ], "properties": { "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "page_cursors": { "type": "array", "items": { "type": "string" } }, "has_next_page": { "type": "boolean" }, "next_page_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "previous_page_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "section_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pages_fetched": { "type": "number" }, "applied_filters": { "type": "object", "properties": { "beds": { "type": "number" }, "pets": { "type": "number" }, "bedrooms": { "type": "number" }, "tier_ids": { "type": "array", "items": { "type": "string" } }, "amenities": { "type": "array", "items": { "type": "string" } }, "bathrooms": { "type": "number" }, "price_max": { "type": "number" }, "price_min": { "type": "number" }, "room_types": { "type": "array", "items": { "type": "string" } }, "instant_book": { "type": "boolean" }, "type_of_place": { "type": "array", "items": { "type": "string" } }, "guest_favorite": { "type": "boolean" }, "host_languages": { "type": "array", "items": { "type": "string" } }, "property_types": { "type": "array", "items": { "type": "string" } }, "standout_stays": { "type": "array", "items": { "type": "string" } }, "booking_options": { "type": "array", "items": { "type": "string" } }, "bathroom_privacy": { "type": "array", "items": { "type": "string" } }, "property_type_ids": { "type": "array", "items": { "type": "string" } }, "flexible_cancellation": { "type": "boolean" }, "accessibility_features": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "pages_requested": { "type": "number" }, "search_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-search", "task_name": "Airbnb search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "query": "London", "adults": 1, "checkin": "2026-06-14", "results": [ { "id": "id-1", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "page": 1, "price": { "display": "sample", "currency": "USD", "qualifier": "for 1 night", "amount_numeric": 180, "original_display": "GBP 240 total", "accessibility_label": "GBP 210 total for 1 night", "original_amount_numeric": 180 }, "title": "Stylish Shoreditch Loft with Balcony", "badges": [ "Guest favorite" ], "rating": 4.91, "details": [ "2 guests" ], "location": { "lat": 51.5074, "lng": -0.1278 }, "subtitle": "Stylish Shoreditch Loft with Balcony", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "rating_text": "4.91 · 128 reviews", "review_count": 1, "payment_messages": [ "Free cancellation" ] } ], "success": true, "checkout": "2026-06-21", "children": 1, "pagination": { "next_page": 1, "total_pages": 1, "current_page": 1, "page_cursors": [ "cursor-page-1" ], "has_next_page": true, "next_page_cursor": "cursor-page-1", "previous_page_cursor": "cursor-page-1" }, "section_id": "EXPLORE_SEARCH_RESULTS", "pages_fetched": 1, "applied_filters": { "beds": 1, "pets": 1.5, "bedrooms": 1, "tier_ids": [ "id-1" ], "amenities": [ "Wifi" ], "bathrooms": 1, "price_max": 180, "price_min": 180, "room_types": [ "Entire home" ], "instant_book": true, "type_of_place": [ "Entire home" ], "guest_favorite": true, "host_languages": [ "English" ], "property_types": [ "Apartment" ], "standout_stays": [ "Guest favorite" ], "booking_options": [ "Instant Book" ], "bathroom_privacy": [ "Private attached bathroom" ], "property_type_ids": [ "id-1" ], "flexible_cancellation": true, "accessibility_features": [ "sample" ] }, "pages_requested": 1, "search_session_id": "search-session-1" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "checkin", "checkout", "adults", "children", "applied_filters", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "adults": { "type": "number" }, "checkin": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "badges", "payment_messages", "image_urls", "details", "price" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "display", "amount_numeric", "currency", "qualifier" ], "properties": { "display": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "qualifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "original_display": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "original_amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "string" } }, "location": { "anyOf": [ { "type": "object", "required": [ "lat", "lng" ], "properties": { "lat": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lng": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "subtitle": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "rating_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "review_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "payment_messages": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } }, "success": { "type": "boolean" }, "checkout": { "type": "string" }, "children": { "type": "number" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page", "next_page_cursor", "previous_page_cursor", "page_cursors" ], "properties": { "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "page_cursors": { "type": "array", "items": { "type": "string" } }, "has_next_page": { "type": "boolean" }, "next_page_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "previous_page_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "section_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pages_fetched": { "type": "number" }, "applied_filters": { "type": "object", "properties": { "beds": { "type": "number" }, "pets": { "type": "number" }, "bedrooms": { "type": "number" }, "tier_ids": { "type": "array", "items": { "type": "string" } }, "amenities": { "type": "array", "items": { "type": "string" } }, "bathrooms": { "type": "number" }, "price_max": { "type": "number" }, "price_min": { "type": "number" }, "room_types": { "type": "array", "items": { "type": "string" } }, "instant_book": { "type": "boolean" }, "type_of_place": { "type": "array", "items": { "type": "string" } }, "guest_favorite": { "type": "boolean" }, "host_languages": { "type": "array", "items": { "type": "string" } }, "property_types": { "type": "array", "items": { "type": "string" } }, "standout_stays": { "type": "array", "items": { "type": "string" } }, "booking_options": { "type": "array", "items": { "type": "string" } }, "bathroom_privacy": { "type": "array", "items": { "type": "string" } }, "property_type_ids": { "type": "array", "items": { "type": "string" } }, "flexible_cancellation": { "type": "boolean" }, "accessibility_features": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "pages_requested": { "type": "number" }, "search_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-search", "task_name": "Airbnb search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAirbnbSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "beds": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Minimum number of beds." }, "pets": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Pet-friendly filter as a positive count, typically 1." }, "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of paginated Airbnb result pages to fetch (1-20)." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Airbnb destination query, such as a city or neighborhood name." }, "adults": { "type": "integer", "default": 1, "maximum": 16, "minimum": 1, "description": "Number of adult guests." }, "cursor": { "type": "string", "description": "Optional Airbnb pagination cursor from a search URL or previous response to start from a later result page." }, "checkin": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Check-in date in YYYY-MM-DD format." }, "bedrooms": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Minimum number of bedrooms." }, "checkout": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Check-out date in YYYY-MM-DD format." }, "children": { "type": "integer", "default": 0, "maximum": 16, "minimum": 0, "description": "Number of child guests." }, "tier_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Raw Airbnb tier IDs, or labels such as \"Luxe\" when the option is available." }, "amenities": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Amenity labels from Airbnb such as \"Wifi\", \"Kitchen\", or \"Free parking\". Raw Airbnb amenity IDs are also accepted." }, "bathrooms": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Minimum number of bathrooms." }, "price_max": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Maximum nightly price filter from an Airbnb search URL." }, "price_min": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Minimum nightly price filter from an Airbnb search URL." }, "room_types": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Room type labels such as \"Room\" or \"Entire home\". Raw Airbnb values like \"Private room\" are also accepted." }, "instant_book": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "number" } ], "description": "Instant Book filter. Accepts true/false or 1/0." }, "type_of_place": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Type of place labels from Airbnb such as \"Room\" or \"Entire home\". Accepts a comma-separated string or an array." }, "guest_favorite": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "number" } ], "description": "Guest favorite filter. Accepts true/false or 1/0." }, "host_languages": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Host language labels such as \"English\", \"French\", or \"Sign Language\". Raw language codes like en and fr are also accepted." }, "property_types": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Property type labels from Airbnb such as \"House\", \"Apartment\", or \"Guesthouse\". Accepts a comma-separated string or an array." }, "standout_stays": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Standout stay labels from Airbnb such as \"Guest favorite\" or \"Luxe\". Accepts a comma-separated string or an array." }, "booking_options": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Booking option labels from Airbnb such as \"Instant Book\", \"Self check-in\", \"Free cancellation\", or \"Allows pets\". Accepts a comma-separated string or an array." }, "bathroom_privacy": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Bathroom privacy labels or raw values such as \"Private attached bathroom\" or \"ENSUITE\". Accepts a comma-separated string or an array." }, "property_type_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Raw Airbnb property type IDs. Prefer property_types for human-readable labels." }, "flexible_cancellation": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "number" } ], "description": "Flexible cancellation filter. Accepts true/false or 1/0." }, "accessibility_features": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Accessibility feature labels from Airbnb such as \"Step-free access\" or \"Disabled parking spot\". Accepts a comma-separated string or an array." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query", "checkin", "checkout" ] }, "example": { "query": "London", "checkin": "2027-06-14", "checkout": "2027-06-21" } } } }, "x-browsable-website-login-required": false } }, "/v1/airbnb/search": { "post": { "tags": [ "Airbnb" ], "summary": "Airbnb search", "description": "Search Airbnb stay results for a destination/date combination and return normalized listings with cursor pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "checkin", "checkout", "adults", "children", "applied_filters", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "adults": { "type": "number" }, "checkin": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "badges", "payment_messages", "image_urls", "details", "price" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "display", "amount_numeric", "currency", "qualifier" ], "properties": { "display": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "qualifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "original_display": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "original_amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "string" } }, "location": { "anyOf": [ { "type": "object", "required": [ "lat", "lng" ], "properties": { "lat": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lng": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "subtitle": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "rating_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "review_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "payment_messages": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } }, "success": { "type": "boolean" }, "checkout": { "type": "string" }, "children": { "type": "number" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page", "next_page_cursor", "previous_page_cursor", "page_cursors" ], "properties": { "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "page_cursors": { "type": "array", "items": { "type": "string" } }, "has_next_page": { "type": "boolean" }, "next_page_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "previous_page_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "section_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pages_fetched": { "type": "number" }, "applied_filters": { "type": "object", "properties": { "beds": { "type": "number" }, "pets": { "type": "number" }, "bedrooms": { "type": "number" }, "tier_ids": { "type": "array", "items": { "type": "string" } }, "amenities": { "type": "array", "items": { "type": "string" } }, "bathrooms": { "type": "number" }, "price_max": { "type": "number" }, "price_min": { "type": "number" }, "room_types": { "type": "array", "items": { "type": "string" } }, "instant_book": { "type": "boolean" }, "type_of_place": { "type": "array", "items": { "type": "string" } }, "guest_favorite": { "type": "boolean" }, "host_languages": { "type": "array", "items": { "type": "string" } }, "property_types": { "type": "array", "items": { "type": "string" } }, "standout_stays": { "type": "array", "items": { "type": "string" } }, "booking_options": { "type": "array", "items": { "type": "string" } }, "bathroom_privacy": { "type": "array", "items": { "type": "string" } }, "property_type_ids": { "type": "array", "items": { "type": "string" } }, "flexible_cancellation": { "type": "boolean" }, "accessibility_features": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "pages_requested": { "type": "number" }, "search_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-search", "task_name": "Airbnb search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "query": "London", "adults": 1, "checkin": "2026-06-14", "results": [ { "id": "id-1", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "page": 1, "price": { "display": "sample", "currency": "USD", "qualifier": "for 1 night", "amount_numeric": 180, "original_display": "GBP 240 total", "accessibility_label": "GBP 210 total for 1 night", "original_amount_numeric": 180 }, "title": "Stylish Shoreditch Loft with Balcony", "badges": [ "Guest favorite" ], "rating": 4.91, "details": [ "2 guests" ], "location": { "lat": 51.5074, "lng": -0.1278 }, "subtitle": "Stylish Shoreditch Loft with Balcony", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "rating_text": "4.91 · 128 reviews", "review_count": 1, "payment_messages": [ "Free cancellation" ] } ], "success": true, "checkout": "2026-06-21", "children": 1, "pagination": { "next_page": 1, "total_pages": 1, "current_page": 1, "page_cursors": [ "cursor-page-1" ], "has_next_page": true, "next_page_cursor": "cursor-page-1", "previous_page_cursor": "cursor-page-1" }, "section_id": "EXPLORE_SEARCH_RESULTS", "pages_fetched": 1, "applied_filters": { "beds": 1, "pets": 1.5, "bedrooms": 1, "tier_ids": [ "id-1" ], "amenities": [ "Wifi" ], "bathrooms": 1, "price_max": 180, "price_min": 180, "room_types": [ "Entire home" ], "instant_book": true, "type_of_place": [ "Entire home" ], "guest_favorite": true, "host_languages": [ "English" ], "property_types": [ "Apartment" ], "standout_stays": [ "Guest favorite" ], "booking_options": [ "Instant Book" ], "bathroom_privacy": [ "Private attached bathroom" ], "property_type_ids": [ "id-1" ], "flexible_cancellation": true, "accessibility_features": [ "sample" ] }, "pages_requested": 1, "search_session_id": "search-session-1" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "checkin", "checkout", "adults", "children", "applied_filters", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "adults": { "type": "number" }, "checkin": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "badges", "payment_messages", "image_urls", "details", "price" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "display", "amount_numeric", "currency", "qualifier" ], "properties": { "display": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "qualifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "original_display": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "original_amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "details": { "type": "array", "items": { "type": "string" } }, "location": { "anyOf": [ { "type": "object", "required": [ "lat", "lng" ], "properties": { "lat": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lng": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "subtitle": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "rating_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "review_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "payment_messages": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } }, "success": { "type": "boolean" }, "checkout": { "type": "string" }, "children": { "type": "number" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page", "next_page_cursor", "previous_page_cursor", "page_cursors" ], "properties": { "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "page_cursors": { "type": "array", "items": { "type": "string" } }, "has_next_page": { "type": "boolean" }, "next_page_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "previous_page_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "section_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pages_fetched": { "type": "number" }, "applied_filters": { "type": "object", "properties": { "beds": { "type": "number" }, "pets": { "type": "number" }, "bedrooms": { "type": "number" }, "tier_ids": { "type": "array", "items": { "type": "string" } }, "amenities": { "type": "array", "items": { "type": "string" } }, "bathrooms": { "type": "number" }, "price_max": { "type": "number" }, "price_min": { "type": "number" }, "room_types": { "type": "array", "items": { "type": "string" } }, "instant_book": { "type": "boolean" }, "type_of_place": { "type": "array", "items": { "type": "string" } }, "guest_favorite": { "type": "boolean" }, "host_languages": { "type": "array", "items": { "type": "string" } }, "property_types": { "type": "array", "items": { "type": "string" } }, "standout_stays": { "type": "array", "items": { "type": "string" } }, "booking_options": { "type": "array", "items": { "type": "string" } }, "bathroom_privacy": { "type": "array", "items": { "type": "string" } }, "property_type_ids": { "type": "array", "items": { "type": "string" } }, "flexible_cancellation": { "type": "boolean" }, "accessibility_features": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "pages_requested": { "type": "number" }, "search_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "airbnb-search", "task_name": "Airbnb search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAirbnbSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "beds": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Minimum number of beds." }, "pets": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Pet-friendly filter as a positive count, typically 1." }, "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of paginated Airbnb result pages to fetch (1-20)." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Airbnb destination query, such as a city or neighborhood name." }, "adults": { "type": "integer", "default": 1, "maximum": 16, "minimum": 1, "description": "Number of adult guests." }, "cursor": { "type": "string", "description": "Optional Airbnb pagination cursor from a search URL or previous response to start from a later result page." }, "checkin": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Check-in date in YYYY-MM-DD format." }, "bedrooms": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Minimum number of bedrooms." }, "checkout": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "description": "Check-out date in YYYY-MM-DD format." }, "children": { "type": "integer", "default": 0, "maximum": 16, "minimum": 0, "description": "Number of child guests." }, "tier_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Raw Airbnb tier IDs, or labels such as \"Luxe\" when the option is available." }, "amenities": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Amenity labels from Airbnb such as \"Wifi\", \"Kitchen\", or \"Free parking\". Raw Airbnb amenity IDs are also accepted." }, "bathrooms": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Minimum number of bathrooms." }, "price_max": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Maximum nightly price filter from an Airbnb search URL." }, "price_min": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "description": "Minimum nightly price filter from an Airbnb search URL." }, "room_types": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Room type labels such as \"Room\" or \"Entire home\". Raw Airbnb values like \"Private room\" are also accepted." }, "instant_book": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "number" } ], "description": "Instant Book filter. Accepts true/false or 1/0." }, "type_of_place": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Type of place labels from Airbnb such as \"Room\" or \"Entire home\". Accepts a comma-separated string or an array." }, "guest_favorite": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "number" } ], "description": "Guest favorite filter. Accepts true/false or 1/0." }, "host_languages": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Host language labels such as \"English\", \"French\", or \"Sign Language\". Raw language codes like en and fr are also accepted." }, "property_types": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Property type labels from Airbnb such as \"House\", \"Apartment\", or \"Guesthouse\". Accepts a comma-separated string or an array." }, "standout_stays": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Standout stay labels from Airbnb such as \"Guest favorite\" or \"Luxe\". Accepts a comma-separated string or an array." }, "booking_options": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Booking option labels from Airbnb such as \"Instant Book\", \"Self check-in\", \"Free cancellation\", or \"Allows pets\". Accepts a comma-separated string or an array." }, "bathroom_privacy": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Bathroom privacy labels or raw values such as \"Private attached bathroom\" or \"ENSUITE\". Accepts a comma-separated string or an array." }, "property_type_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Raw Airbnb property type IDs. Prefer property_types for human-readable labels." }, "flexible_cancellation": { "anyOf": [ { "type": "boolean" }, { "type": "string" }, { "type": "number" } ], "description": "Flexible cancellation filter. Accepts true/false or 1/0." }, "accessibility_features": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "description": "Accessibility feature labels from Airbnb such as \"Step-free access\" or \"Disabled parking spot\". Accepts a comma-separated string or an array." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query", "checkin", "checkout" ] }, "example": { "query": "London", "checkin": "2027-06-14", "checkout": "2027-06-21" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-airbnb-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/alibaba-product/runs": { "post": { "tags": [ "Alibaba" ], "summary": "Alibaba Product API", "description": "Scrape a public Alibaba product detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "alibaba-product", "task_name": "Alibaba Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "alibaba-product", "task_name": "Alibaba Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAlibabaProductCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Alibaba product URL returned by alibaba/search.", "x-placeholder": "e.g. https://www.alibaba.com/product-detail/custom-packaging-boxes_1600000000000.html" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.alibaba.com/product-detail/custom-packaging-boxes_1600000000000.html" } } } }, "x-browsable-website-login-required": false } }, "/v1/alibaba/product": { "post": { "tags": [ "Alibaba" ], "summary": "Alibaba Product API", "description": "Scrape a public Alibaba product detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "alibaba-product", "task_name": "Alibaba Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "alibaba-product", "task_name": "Alibaba Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAlibabaProductAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Alibaba product URL returned by alibaba/search.", "x-placeholder": "e.g. https://www.alibaba.com/product-detail/custom-packaging-boxes_1600000000000.html" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.alibaba.com/product-detail/custom-packaging-boxes_1600000000000.html" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-alibaba-product" }, "x-browsable-website-login-required": false } }, "/v1/tasks/alibaba-search/runs": { "post": { "tags": [ "Alibaba" ], "summary": "Alibaba API", "description": "Scrape public Alibaba showroom product pages by query.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "alibaba-search", "task_name": "Alibaba API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "alibaba-search", "task_name": "Alibaba API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAlibabaSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "custom packaging boxes", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. custom packaging boxes" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "custom packaging boxes" } } } }, "x-browsable-website-login-required": false } }, "/v1/alibaba/search": { "post": { "tags": [ "Alibaba" ], "summary": "Alibaba API", "description": "Scrape public Alibaba showroom product pages by query.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "alibaba-search", "task_name": "Alibaba API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "alibaba-search", "task_name": "Alibaba API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAlibabaSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "custom packaging boxes", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. custom packaging boxes" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "custom packaging boxes" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-alibaba-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/aliexpress-item/runs": { "post": { "tags": [ "AliExpress" ], "summary": "AliExpress Item API", "description": "Scrape a public AliExpress item detail page from a search result URL or item id.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "aliexpress-item", "task_name": "AliExpress Item API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "aliexpress-item", "task_name": "AliExpress Item API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAliexpressItemCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "AliExpress item id, or the id value returned by aliexpress/search.", "x-placeholder": "e.g. 1005010149274942" }, "url": { "type": "string", "x-sample": "https://www.aliexpress.com/item/1005010149274942.html", "maxLength": 2000, "minLength": 1, "description": "AliExpress item URL returned by aliexpress/search.", "x-placeholder": "e.g. https://www.aliexpress.com/item/1005010149274942.html" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://www.aliexpress.com/item/1005010149274942.html" } } } }, "x-browsable-website-login-required": false } }, "/v1/aliexpress/item": { "post": { "tags": [ "AliExpress" ], "summary": "AliExpress Item API", "description": "Scrape a public AliExpress item detail page from a search result URL or item id.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "aliexpress-item", "task_name": "AliExpress Item API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "aliexpress-item", "task_name": "AliExpress Item API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAliexpressItemAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "AliExpress item id, or the id value returned by aliexpress/search.", "x-placeholder": "e.g. 1005010149274942" }, "url": { "type": "string", "x-sample": "https://www.aliexpress.com/item/1005010149274942.html", "maxLength": 2000, "minLength": 1, "description": "AliExpress item URL returned by aliexpress/search.", "x-placeholder": "e.g. https://www.aliexpress.com/item/1005010149274942.html" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://www.aliexpress.com/item/1005010149274942.html" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-aliexpress-item" }, "x-browsable-website-login-required": false } }, "/v1/tasks/aliexpress-search/runs": { "post": { "tags": [ "AliExpress" ], "summary": "AliExpress API", "description": "Scrape public AliExpress search result pages by query with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "aliexpress-search", "task_name": "AliExpress API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "aliexpress-search", "task_name": "AliExpress API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAliexpressSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "phone case", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. phone case" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "phone case" } } } }, "x-browsable-website-login-required": false } }, "/v1/aliexpress/search": { "post": { "tags": [ "AliExpress" ], "summary": "AliExpress API", "description": "Scrape public AliExpress search result pages by query with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "aliexpress-search", "task_name": "AliExpress API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "aliexpress-search", "task_name": "AliExpress API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAliexpressSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "phone case", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. phone case" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "phone case" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-aliexpress-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/amazon-asin/runs": { "post": { "tags": [ "Amazon" ], "summary": "Amazon ASIN Lookup API", "description": "Fetch product details, specifications, images, price and availability by ASIN or URL. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-asin" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-asin", "task_name": "Amazon ASIN Lookup API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "details": {}, "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "marketplace": "amazon.com", "availability": "sample", "price_amount": "180", "review_count": 1, "price_currency": "GBP", "availability_text": "Sample availability_text 1", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-asin", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "details": {}, "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "marketplace": "amazon.com", "availability": "sample", "price_amount": "180", "review_count": 1, "price_currency": "GBP", "availability_text": "Sample availability_text 1", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-asin" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-asin", "task_name": "Amazon ASIN Lookup API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonAsinCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://", "x-sample": "https://www.amazon.com/dp/B0C3HCD34R", "maxLength": 2000, "minLength": 1, "description": "Product URL on a supported Amazon marketplace." }, "asin": { "type": "string", "pattern": "^[a-zA-Z0-9]{10}$", "x-sample": "B0C3HCD34R", "description": "Amazon product ASIN." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "asin" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.amazon.com/dp/B0C3HCD34R" } } } }, "x-browsable-website-login-required": false } }, "/v1/amazon/asin": { "post": { "tags": [ "Amazon" ], "summary": "Amazon ASIN Lookup API", "description": "Fetch product details, specifications, images, price and availability by ASIN or URL. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-asin" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-asin", "task_name": "Amazon ASIN Lookup API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "details": {}, "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "marketplace": "amazon.com", "availability": "sample", "price_amount": "180", "review_count": 1, "price_currency": "GBP", "availability_text": "Sample availability_text 1", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-asin", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "details": {}, "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "marketplace": "amazon.com", "availability": "sample", "price_amount": "180", "review_count": 1, "price_currency": "GBP", "availability_text": "Sample availability_text 1", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-asin" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-asin", "task_name": "Amazon ASIN Lookup API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonAsinAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://", "x-sample": "https://www.amazon.com/dp/B0C3HCD34R", "maxLength": 2000, "minLength": 1, "description": "Product URL on a supported Amazon marketplace." }, "asin": { "type": "string", "pattern": "^[a-zA-Z0-9]{10}$", "x-sample": "B0C3HCD34R", "description": "Amazon product ASIN." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "asin" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.amazon.com/dp/B0C3HCD34R" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-amazon-asin" }, "x-browsable-website-login-required": false } }, "/v1/tasks/amazon-best-sellers/runs": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Best Sellers API", "description": "Fetch Amazon Best Sellers by category with continuation cursors. Empty lists are returned when Amazon explicitly reports no entries. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-best-sellers" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-best-sellers", "task_name": "Amazon Best Sellers API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "notice": "sample", "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-best-sellers", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "rank": 1, "tags": [ "Featured" ], "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "image_url": "https://example.com/item-1", "deal_badge": "sample", "list_price": "180", "sales_rank": 1, "is_sponsored": true, "price_amount": "180", "price_currency": "GBP", "numberOfReviews": 1, "previous_sales_rank": 1, "rank_change_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-best-sellers" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-best-sellers", "task_name": "Amazon Best Sellers API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonBestSellersCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "category": { "type": "string", "x-sample": "electronics", "maxLength": 100, "minLength": 1, "description": "Department such as electronics, kitchen, books, beauty or pet supplies. Unsupported departments fail explicitly." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "x-browsable-website-login-required": false } }, "/v1/amazon/best-sellers": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Best Sellers API", "description": "Fetch Amazon Best Sellers by category with continuation cursors. Empty lists are returned when Amazon explicitly reports no entries. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-best-sellers" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-best-sellers", "task_name": "Amazon Best Sellers API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "notice": "sample", "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-best-sellers", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "rank": 1, "tags": [ "Featured" ], "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "image_url": "https://example.com/item-1", "deal_badge": "sample", "list_price": "180", "sales_rank": 1, "is_sponsored": true, "price_amount": "180", "price_currency": "GBP", "numberOfReviews": 1, "previous_sales_rank": 1, "rank_change_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-best-sellers" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-best-sellers", "task_name": "Amazon Best Sellers API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonBestSellersAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "category": { "type": "string", "x-sample": "electronics", "maxLength": 100, "minLength": 1, "description": "Department such as electronics, kitchen, books, beauty or pet supplies. Unsupported departments fail explicitly." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-amazon-best-sellers" }, "x-browsable-website-login-required": false } }, "/v1/tasks/amazon-deals/runs": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Deals API", "description": "Fetch public deals, or search for products with active deal badges. Query pages can be empty after filtering; continue while next_cursor is present. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-deals" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-deals", "task_name": "Amazon Deals API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "notice": "sample", "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-deals", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "rank": 1, "tags": [ "Featured" ], "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "image_url": "https://example.com/item-1", "deal_badge": "sample", "list_price": "180", "sales_rank": 1, "is_sponsored": true, "price_amount": "180", "price_currency": "GBP", "numberOfReviews": 1, "previous_sales_rank": 1, "rank_change_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-deals" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-deals", "task_name": "Amazon Deals API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonDealsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "sort": { "enum": [ "relevance", "price_asc", "price_desc", "rating", "newest" ], "type": "string", "default": "relevance", "description": "Sort order. Choose an allowed value below." }, "brand": { "type": "string", "pattern": "^[^:,]+$", "maxLength": 100, "minLength": 1, "description": "Single brand name." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "query": { "type": "string", "x-sample": "wireless headphones", "maxLength": 500, "minLength": 1, "description": "Search text." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "category": { "type": "string", "x-sample": "electronics", "maxLength": 100, "minLength": 1, "description": "Department such as electronics, kitchen, books, beauty or pet supplies. Unsupported departments fail explicitly." }, "max_price": { "type": "number", "minimum": 0, "description": "Maximum item price in the marketplace currency." }, "min_price": { "type": "number", "minimum": 0, "description": "Minimum item price in the marketplace currency." }, "min_rating": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "Minimum product star rating." }, "category_id": { "type": "string", "pattern": "^[0-9]{1,20}$", "x-advanced": true, "description": "Amazon browse node ID for a more specific category." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "x-browsable-website-login-required": false } }, "/v1/amazon/deals": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Deals API", "description": "Fetch public deals, or search for products with active deal badges. Query pages can be empty after filtering; continue while next_cursor is present. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-deals" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-deals", "task_name": "Amazon Deals API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "notice": "sample", "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-deals", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "rank": 1, "tags": [ "Featured" ], "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "image_url": "https://example.com/item-1", "deal_badge": "sample", "list_price": "180", "sales_rank": 1, "is_sponsored": true, "price_amount": "180", "price_currency": "GBP", "numberOfReviews": 1, "previous_sales_rank": 1, "rank_change_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-deals" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-deals", "task_name": "Amazon Deals API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonDealsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "sort": { "enum": [ "relevance", "price_asc", "price_desc", "rating", "newest" ], "type": "string", "default": "relevance", "description": "Sort order. Choose an allowed value below." }, "brand": { "type": "string", "pattern": "^[^:,]+$", "maxLength": 100, "minLength": 1, "description": "Single brand name." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "query": { "type": "string", "x-sample": "wireless headphones", "maxLength": 500, "minLength": 1, "description": "Search text." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "category": { "type": "string", "x-sample": "electronics", "maxLength": 100, "minLength": 1, "description": "Department such as electronics, kitchen, books, beauty or pet supplies. Unsupported departments fail explicitly." }, "max_price": { "type": "number", "minimum": 0, "description": "Maximum item price in the marketplace currency." }, "min_price": { "type": "number", "minimum": 0, "description": "Minimum item price in the marketplace currency." }, "min_rating": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "Minimum product star rating." }, "category_id": { "type": "string", "pattern": "^[0-9]{1,20}$", "x-advanced": true, "description": "Amazon browse node ID for a more specific category." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-amazon-deals" }, "x-browsable-website-login-required": false } }, "/v1/tasks/amazon-movers-and-shakers/runs": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Movers and Shakers API", "description": "Fetch Amazon Movers and Shakers by category with continuation cursors. Empty lists are returned when Amazon explicitly reports no entries. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-movers-and-shakers" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-movers-and-shakers", "task_name": "Amazon Movers and Shakers API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "notice": "sample", "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-movers-and-shakers", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "rank": 1, "tags": [ "Featured" ], "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "image_url": "https://example.com/item-1", "deal_badge": "sample", "list_price": "180", "sales_rank": 1, "is_sponsored": true, "price_amount": "180", "price_currency": "GBP", "numberOfReviews": 1, "previous_sales_rank": 1, "rank_change_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-movers-and-shakers" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-movers-and-shakers", "task_name": "Amazon Movers and Shakers API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonMoversAndShakersCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "category": { "type": "string", "x-sample": "electronics", "maxLength": 100, "minLength": 1, "description": "Department such as electronics, kitchen, books, beauty or pet supplies. Unsupported departments fail explicitly." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "x-browsable-website-login-required": false } }, "/v1/amazon/movers-and-shakers": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Movers and Shakers API", "description": "Fetch Amazon Movers and Shakers by category with continuation cursors. Empty lists are returned when Amazon explicitly reports no entries. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-movers-and-shakers" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-movers-and-shakers", "task_name": "Amazon Movers and Shakers API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "notice": "sample", "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-movers-and-shakers", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "rank": 1, "tags": [ "Featured" ], "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "image_url": "https://example.com/item-1", "deal_badge": "sample", "list_price": "180", "sales_rank": 1, "is_sponsored": true, "price_amount": "180", "price_currency": "GBP", "numberOfReviews": 1, "previous_sales_rank": 1, "rank_change_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-movers-and-shakers" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-movers-and-shakers", "task_name": "Amazon Movers and Shakers API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonMoversAndShakersAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "category": { "type": "string", "x-sample": "electronics", "maxLength": 100, "minLength": 1, "description": "Department such as electronics, kitchen, books, beauty or pet supplies. Unsupported departments fail explicitly." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-amazon-movers-and-shakers" }, "x-browsable-website-login-required": false } }, "/v1/tasks/amazon-new-releases/runs": { "post": { "tags": [ "Amazon" ], "summary": "Amazon New Releases API", "description": "Fetch Amazon New Releases by category with continuation cursors. Empty lists are returned when Amazon explicitly reports no entries. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-new-releases" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-new-releases", "task_name": "Amazon New Releases API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "notice": "sample", "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-new-releases", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "rank": 1, "tags": [ "Featured" ], "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "image_url": "https://example.com/item-1", "deal_badge": "sample", "list_price": "180", "sales_rank": 1, "is_sponsored": true, "price_amount": "180", "price_currency": "GBP", "numberOfReviews": 1, "previous_sales_rank": 1, "rank_change_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-new-releases" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-new-releases", "task_name": "Amazon New Releases API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonNewReleasesCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "category": { "type": "string", "x-sample": "electronics", "maxLength": 100, "minLength": 1, "description": "Department such as electronics, kitchen, books, beauty or pet supplies. Unsupported departments fail explicitly." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "x-browsable-website-login-required": false } }, "/v1/amazon/new-releases": { "post": { "tags": [ "Amazon" ], "summary": "Amazon New Releases API", "description": "Fetch Amazon New Releases by category with continuation cursors. Empty lists are returned when Amazon explicitly reports no entries. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-new-releases" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-new-releases", "task_name": "Amazon New Releases API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "notice": "sample", "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-new-releases", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "rank": 1, "tags": [ "Featured" ], "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "image_url": "https://example.com/item-1", "deal_badge": "sample", "list_price": "180", "sales_rank": 1, "is_sponsored": true, "price_amount": "180", "price_currency": "GBP", "numberOfReviews": 1, "previous_sales_rank": 1, "rank_change_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-new-releases" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-new-releases", "task_name": "Amazon New Releases API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonNewReleasesAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "category": { "type": "string", "x-sample": "electronics", "maxLength": 100, "minLength": 1, "description": "Department such as electronics, kitchen, books, beauty or pet supplies. Unsupported departments fail explicitly." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-amazon-new-releases" }, "x-browsable-website-login-required": false } }, "/v1/tasks/amazon-price/runs": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Product Price API", "description": "Fetch the current product price and availability by ASIN or URL. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-price" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-price", "task_name": "Amazon Product Price API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "details": {}, "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "marketplace": "amazon.com", "availability": "sample", "price_amount": "180", "review_count": 1, "price_currency": "GBP", "availability_text": "Sample availability_text 1", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-price", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "details": {}, "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "marketplace": "amazon.com", "availability": "sample", "price_amount": "180", "review_count": 1, "price_currency": "GBP", "availability_text": "Sample availability_text 1", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-price" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-price", "task_name": "Amazon Product Price API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonPriceCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://", "x-sample": "https://www.amazon.com/dp/B0C3HCD34R", "maxLength": 2000, "minLength": 1, "description": "Product URL on a supported Amazon marketplace." }, "asin": { "type": "string", "pattern": "^[a-zA-Z0-9]{10}$", "x-sample": "B0C3HCD34R", "description": "Amazon product ASIN." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "asin" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.amazon.com/dp/B0C3HCD34R" } } } }, "x-browsable-website-login-required": false } }, "/v1/amazon/price": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Product Price API", "description": "Fetch the current product price and availability by ASIN or URL. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-price" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-price", "task_name": "Amazon Product Price API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "details": {}, "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "marketplace": "amazon.com", "availability": "sample", "price_amount": "180", "review_count": 1, "price_currency": "GBP", "availability_text": "Sample availability_text 1", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-price", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "details": {}, "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "marketplace": "amazon.com", "availability": "sample", "price_amount": "180", "review_count": 1, "price_currency": "GBP", "availability_text": "Sample availability_text 1", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-price" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-price", "task_name": "Amazon Product Price API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonPriceAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://", "x-sample": "https://www.amazon.com/dp/B0C3HCD34R", "maxLength": 2000, "minLength": 1, "description": "Product URL on a supported Amazon marketplace." }, "asin": { "type": "string", "pattern": "^[a-zA-Z0-9]{10}$", "x-sample": "B0C3HCD34R", "description": "Amazon product ASIN." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "asin" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.amazon.com/dp/B0C3HCD34R" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-amazon-price" }, "x-browsable-website-login-required": false } }, "/v1/tasks/amazon-product-offers/runs": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Product Offers API", "description": "Compare public seller offers, item condition, shipping and Featured Offer status for a product. Total prices are null when shipping cannot be determined. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location", "asin", "total_offers" ], "properties": { "asin": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "total_offers": { "type": [ "integer", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-product-offers" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "seller_id", "seller_name", "seller_url", "ships_from", "condition", "condition_notes", "price", "price_amount", "price_currency", "shipping_price", "shipping_amount", "shipping_text", "total_amount", "is_featured_offer", "seller_rating_text", "marketplace" ], "properties": { "id": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "seller_id": { "type": [ "string", "null" ] }, "seller_url": { "type": [ "string", "null" ] }, "ships_from": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "seller_name": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "total_amount": { "type": [ "string", "null" ] }, "shipping_text": { "type": [ "string", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "shipping_price": { "type": [ "string", "null" ] }, "condition_notes": { "type": [ "string", "null" ] }, "shipping_amount": { "type": [ "string", "null" ] }, "is_featured_offer": { "type": "boolean" }, "seller_rating_text": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-product-offers", "task_name": "Amazon Product Offers API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "asin": "sample", "marketplace": "amazon.com", "total_offers": 180, "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-product-offers", "results": [ { "id": "id-1", "asin": "sample", "price": "180", "condition": "sample", "seller_id": "id-1", "seller_url": "https://example.com/item-1", "ships_from": "sample", "marketplace": "amazon.com", "seller_name": "Stylish Shoreditch Loft with Balcony", "price_amount": "180", "total_amount": "180", "shipping_text": "Sample shipping_text 1", "price_currency": "GBP", "shipping_price": "180", "condition_notes": "sample", "shipping_amount": "180", "is_featured_offer": true, "seller_rating_text": "4.91 · 128 reviews" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location", "asin", "total_offers" ], "properties": { "asin": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "total_offers": { "type": [ "integer", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-product-offers" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "seller_id", "seller_name", "seller_url", "ships_from", "condition", "condition_notes", "price", "price_amount", "price_currency", "shipping_price", "shipping_amount", "shipping_text", "total_amount", "is_featured_offer", "seller_rating_text", "marketplace" ], "properties": { "id": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "seller_id": { "type": [ "string", "null" ] }, "seller_url": { "type": [ "string", "null" ] }, "ships_from": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "seller_name": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "total_amount": { "type": [ "string", "null" ] }, "shipping_text": { "type": [ "string", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "shipping_price": { "type": [ "string", "null" ] }, "condition_notes": { "type": [ "string", "null" ] }, "shipping_amount": { "type": [ "string", "null" ] }, "is_featured_offer": { "type": "boolean" }, "seller_rating_text": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-product-offers", "task_name": "Amazon Product Offers API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonProductOffersCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://", "x-sample": "https://www.amazon.com/dp/B0C3HCD34R", "maxLength": 2000, "minLength": 1, "description": "Product URL on a supported Amazon marketplace." }, "asin": { "type": "string", "pattern": "^[a-zA-Z0-9]{10}$", "x-sample": "B0C3HCD34R", "description": "Amazon product ASIN." }, "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "condition": { "enum": [ "all", "new", "used", "renewed" ], "type": "string", "default": "all", "description": "Filter by an allowed product condition." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "asin" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.amazon.com/dp/B0C3HCD34R" } } } }, "x-browsable-website-login-required": false } }, "/v1/amazon/product/offers": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Product Offers API", "description": "Compare public seller offers, item condition, shipping and Featured Offer status for a product. Total prices are null when shipping cannot be determined. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location", "asin", "total_offers" ], "properties": { "asin": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "total_offers": { "type": [ "integer", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-product-offers" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "seller_id", "seller_name", "seller_url", "ships_from", "condition", "condition_notes", "price", "price_amount", "price_currency", "shipping_price", "shipping_amount", "shipping_text", "total_amount", "is_featured_offer", "seller_rating_text", "marketplace" ], "properties": { "id": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "seller_id": { "type": [ "string", "null" ] }, "seller_url": { "type": [ "string", "null" ] }, "ships_from": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "seller_name": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "total_amount": { "type": [ "string", "null" ] }, "shipping_text": { "type": [ "string", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "shipping_price": { "type": [ "string", "null" ] }, "condition_notes": { "type": [ "string", "null" ] }, "shipping_amount": { "type": [ "string", "null" ] }, "is_featured_offer": { "type": "boolean" }, "seller_rating_text": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-product-offers", "task_name": "Amazon Product Offers API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "asin": "sample", "marketplace": "amazon.com", "total_offers": 180, "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-product-offers", "results": [ { "id": "id-1", "asin": "sample", "price": "180", "condition": "sample", "seller_id": "id-1", "seller_url": "https://example.com/item-1", "ships_from": "sample", "marketplace": "amazon.com", "seller_name": "Stylish Shoreditch Loft with Balcony", "price_amount": "180", "total_amount": "180", "shipping_text": "Sample shipping_text 1", "price_currency": "GBP", "shipping_price": "180", "condition_notes": "sample", "shipping_amount": "180", "is_featured_offer": true, "seller_rating_text": "4.91 · 128 reviews" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location", "asin", "total_offers" ], "properties": { "asin": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "total_offers": { "type": [ "integer", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-product-offers" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "seller_id", "seller_name", "seller_url", "ships_from", "condition", "condition_notes", "price", "price_amount", "price_currency", "shipping_price", "shipping_amount", "shipping_text", "total_amount", "is_featured_offer", "seller_rating_text", "marketplace" ], "properties": { "id": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "seller_id": { "type": [ "string", "null" ] }, "seller_url": { "type": [ "string", "null" ] }, "ships_from": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "seller_name": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "total_amount": { "type": [ "string", "null" ] }, "shipping_text": { "type": [ "string", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "shipping_price": { "type": [ "string", "null" ] }, "condition_notes": { "type": [ "string", "null" ] }, "shipping_amount": { "type": [ "string", "null" ] }, "is_featured_offer": { "type": "boolean" }, "seller_rating_text": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-product-offers", "task_name": "Amazon Product Offers API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonProductOffersAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://", "x-sample": "https://www.amazon.com/dp/B0C3HCD34R", "maxLength": 2000, "minLength": 1, "description": "Product URL on a supported Amazon marketplace." }, "asin": { "type": "string", "pattern": "^[a-zA-Z0-9]{10}$", "x-sample": "B0C3HCD34R", "description": "Amazon product ASIN." }, "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "condition": { "enum": [ "all", "new", "used", "renewed" ], "type": "string", "default": "all", "description": "Filter by an allowed product condition." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "asin" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.amazon.com/dp/B0C3HCD34R" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-amazon-product-offers" }, "x-browsable-website-login-required": false } }, "/v1/tasks/amazon-product-reviews/runs": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Reviews", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "avatar": { "type": [ "string", "null" ] }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "content": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "styleName": { "type": [ "string", "null" ] }, "helpfulCount": { "type": [ "integer", "null" ] }, "verifiedPurchase": { "type": "boolean" } } } } } }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-product-reviews", "task_name": "Amazon Reviews", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "results": [ { "date": "sample", "title": "Stylish Shoreditch Loft with Balcony", "avatar": "https://images.example.com/avatar-1.jpg", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "content": "Sample content 1", "location": "London", "username": "Stylish Shoreditch Loft with Balcony", "styleName": "Stylish Shoreditch Loft with Balcony", "helpfulCount": 1, "verifiedPurchase": true } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "avatar": { "type": [ "string", "null" ] }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "content": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "styleName": { "type": [ "string", "null" ] }, "helpfulCount": { "type": [ "integer", "null" ] }, "verifiedPurchase": { "type": "boolean" } } } } } }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-product-reviews", "task_name": "Amazon Reviews", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonProductReviewsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.amazon.com/dp/B004XAKAYE", "maxLength": 2000, "minLength": 1, "description": "Amazon product URL (alternative to ASIN)", "x-placeholder": "https://www.amazon.com/dp/B004XAKAYE" }, "asin": { "type": "string", "description": "Amazon product ASIN (10-character alphanumeric code)" }, "limit": { "type": "integer", "description": "Maximum number of reviews to scrape (omit for all reviews) Preferred name; maxReviews remains supported." }, "domain": { "type": "string", "default": "amazon.com", "description": "Amazon domain (e.g., amazon.com, amazon.co.uk)" }, "maxReviews": { "type": "integer", "x-advanced": true, "description": "Maximum number of reviews to scrape (omit for all reviews) You can also use limit." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "x-browsable-website-login-required": true } }, "/v1/amazon/product/reviews": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Reviews", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "avatar": { "type": [ "string", "null" ] }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "content": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "styleName": { "type": [ "string", "null" ] }, "helpfulCount": { "type": [ "integer", "null" ] }, "verifiedPurchase": { "type": "boolean" } } } } } }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-product-reviews", "task_name": "Amazon Reviews", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "results": [ { "date": "sample", "title": "Stylish Shoreditch Loft with Balcony", "avatar": "https://images.example.com/avatar-1.jpg", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "content": "Sample content 1", "location": "London", "username": "Stylish Shoreditch Loft with Balcony", "styleName": "Stylish Shoreditch Loft with Balcony", "helpfulCount": 1, "verifiedPurchase": true } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "avatar": { "type": [ "string", "null" ] }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "content": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "styleName": { "type": [ "string", "null" ] }, "helpfulCount": { "type": [ "integer", "null" ] }, "verifiedPurchase": { "type": "boolean" } } } } } }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-product-reviews", "task_name": "Amazon Reviews", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonProductReviewsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.amazon.com/dp/B004XAKAYE", "maxLength": 2000, "minLength": 1, "description": "Amazon product URL (alternative to ASIN)", "x-placeholder": "https://www.amazon.com/dp/B004XAKAYE" }, "asin": { "type": "string", "description": "Amazon product ASIN (10-character alphanumeric code)" }, "limit": { "type": "integer", "description": "Maximum number of reviews to scrape (omit for all reviews) Preferred name; maxReviews remains supported." }, "domain": { "type": "string", "default": "amazon.com", "description": "Amazon domain (e.g., amazon.com, amazon.co.uk)" }, "maxReviews": { "type": "integer", "x-advanced": true, "description": "Maximum number of reviews to scrape (omit for all reviews) You can also use limit." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-amazon-product-reviews" }, "x-browsable-website-login-required": true } }, "/v1/tasks/amazon-product-variations/runs": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Product Variations API", "description": "List related child ASINs and their size, colour and style attributes. Set include_details to fetch each variant's current price and availability (maximum 10 per request). Without it, only the selected variant has product details. Costs 10 credits. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location", "parent_asin", "dimensions", "has_variations", "total_variations", "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "asin", "message" ], "properties": { "asin": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } }, "dimensions": { "type": "array", "items": { "type": "string" } }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "parent_asin": { "type": [ "string", "null" ] }, "has_variations": { "type": "boolean" }, "total_variations": { "type": "integer", "minimum": 0 }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-product-variations" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "parent_asin", "attributes", "is_selected", "title", "price", "price_amount", "price_currency", "availability", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "is_selected": { "type": "boolean" }, "parent_asin": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-product-variations", "task_name": "Amazon Product Variations API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "errors": [ { "asin": "sample", "message": "sample" } ], "dimensions": [ "sample" ], "marketplace": "amazon.com", "parent_asin": "180", "has_variations": true, "total_variations": 180, "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-product-variations", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "image_url": "https://example.com/item-1", "attributes": {}, "is_selected": true, "parent_asin": "180", "availability": "sample", "price_amount": "180", "price_currency": "GBP" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location", "parent_asin", "dimensions", "has_variations", "total_variations", "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "asin", "message" ], "properties": { "asin": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } }, "dimensions": { "type": "array", "items": { "type": "string" } }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "parent_asin": { "type": [ "string", "null" ] }, "has_variations": { "type": "boolean" }, "total_variations": { "type": "integer", "minimum": 0 }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-product-variations" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "parent_asin", "attributes", "is_selected", "title", "price", "price_amount", "price_currency", "availability", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "is_selected": { "type": "boolean" }, "parent_asin": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-product-variations", "task_name": "Amazon Product Variations API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonProductVariationsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://", "x-sample": "https://www.amazon.com/dp/B0C3HCD34R", "maxLength": 2000, "minLength": 1, "description": "Product URL on a supported Amazon marketplace." }, "asin": { "type": "string", "pattern": "^[a-zA-Z0-9]{10}$", "x-sample": "B0C3HCD34R", "description": "Amazon product ASIN." }, "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "include_details": { "type": "boolean", "default": false, "description": "Include price and availability details for variants; limited to 10 variants per request." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "asin" ] }, { "required": [ "url" ] } ], "allOf": [ { "anyOf": [ { "properties": { "include_details": { "const": false } } }, { "required": [ "include_details" ], "properties": { "limit": { "maximum": 10 }, "include_details": { "const": true } } } ] } ] }, "example": { "url": "https://www.amazon.com/dp/B0C3HCD34R" } } } }, "x-browsable-website-login-required": false } }, "/v1/amazon/product/variations": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Product Variations API", "description": "List related child ASINs and their size, colour and style attributes. Set include_details to fetch each variant's current price and availability (maximum 10 per request). Without it, only the selected variant has product details. Costs 10 credits. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location", "parent_asin", "dimensions", "has_variations", "total_variations", "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "asin", "message" ], "properties": { "asin": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } }, "dimensions": { "type": "array", "items": { "type": "string" } }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "parent_asin": { "type": [ "string", "null" ] }, "has_variations": { "type": "boolean" }, "total_variations": { "type": "integer", "minimum": 0 }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-product-variations" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "parent_asin", "attributes", "is_selected", "title", "price", "price_amount", "price_currency", "availability", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "is_selected": { "type": "boolean" }, "parent_asin": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-product-variations", "task_name": "Amazon Product Variations API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "errors": [ { "asin": "sample", "message": "sample" } ], "dimensions": [ "sample" ], "marketplace": "amazon.com", "parent_asin": "180", "has_variations": true, "total_variations": 180, "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-product-variations", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "image_url": "https://example.com/item-1", "attributes": {}, "is_selected": true, "parent_asin": "180", "availability": "sample", "price_amount": "180", "price_currency": "GBP" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location", "parent_asin", "dimensions", "has_variations", "total_variations", "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "asin", "message" ], "properties": { "asin": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } }, "dimensions": { "type": "array", "items": { "type": "string" } }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "parent_asin": { "type": [ "string", "null" ] }, "has_variations": { "type": "boolean" }, "total_variations": { "type": "integer", "minimum": 0 }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-product-variations" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "parent_asin", "attributes", "is_selected", "title", "price", "price_amount", "price_currency", "availability", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } }, "is_selected": { "type": "boolean" }, "parent_asin": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-product-variations", "task_name": "Amazon Product Variations API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonProductVariationsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "pattern": "^https://", "x-sample": "https://www.amazon.com/dp/B0C3HCD34R", "maxLength": 2000, "minLength": 1, "description": "Product URL on a supported Amazon marketplace." }, "asin": { "type": "string", "pattern": "^[a-zA-Z0-9]{10}$", "x-sample": "B0C3HCD34R", "description": "Amazon product ASIN." }, "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "include_details": { "type": "boolean", "default": false, "description": "Include price and availability details for variants; limited to 10 variants per request." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "asin" ] }, { "required": [ "url" ] } ], "allOf": [ { "anyOf": [ { "properties": { "include_details": { "const": false } } }, { "required": [ "include_details" ], "properties": { "limit": { "maximum": 10 }, "include_details": { "const": true } } } ] } ] }, "example": { "url": "https://www.amazon.com/dp/B0C3HCD34R" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-amazon-product-variations" }, "x-browsable-website-login-required": false } }, "/v1/tasks/amazon-products-batch/runs": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Products Batch API", "description": "Fetch up to 10 products by ASIN. Duplicate ASINs are fetched once. Partial batches include per-product errors; all-failed batches fail. Costs 10 credits. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location", "requested", "succeeded", "failed", "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "asin", "code", "message" ], "properties": { "asin": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } }, "failed": { "type": "integer", "minimum": 0 }, "requested": { "type": "integer", "minimum": 0 }, "succeeded": { "type": "integer", "minimum": 0 }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-products-batch" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-products-batch", "task_name": "Amazon Products Batch API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "errors": [ { "asin": "sample", "code": "sample", "message": "sample" } ], "failed": 1, "requested": 1, "succeeded": 1, "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-products-batch", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "details": {}, "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "marketplace": "amazon.com", "availability": "sample", "price_amount": "180", "review_count": 1, "price_currency": "GBP", "availability_text": "Sample availability_text 1", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location", "requested", "succeeded", "failed", "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "asin", "code", "message" ], "properties": { "asin": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } }, "failed": { "type": "integer", "minimum": 0 }, "requested": { "type": "integer", "minimum": 0 }, "succeeded": { "type": "integer", "minimum": 0 }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-products-batch" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-products-batch", "task_name": "Amazon Products Batch API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonProductsBatchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "asins": { "type": "array", "items": { "type": "string", "pattern": "^[a-zA-Z0-9]{10}$", "x-sample": "B0C3HCD34R", "description": "Amazon product ASIN." }, "maxItems": 10, "minItems": 1, "x-sample": [ "B0C3HCD34R", "B085DV8T75" ], "description": "Between 1 and 10 Amazon product ASINs. Each ASIN has 10 letters or digits. Errors are reported per product." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "asins" ] }, "example": { "asins": [ "B0C3HCD34R", "B085DV8T75" ] } } } }, "x-browsable-website-login-required": false } }, "/v1/amazon/products/batch": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Products Batch API", "description": "Fetch up to 10 products by ASIN. Duplicate ASINs are fetched once. Partial batches include per-product errors; all-failed batches fail. Costs 10 credits. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location", "requested", "succeeded", "failed", "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "asin", "code", "message" ], "properties": { "asin": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } }, "failed": { "type": "integer", "minimum": 0 }, "requested": { "type": "integer", "minimum": 0 }, "succeeded": { "type": "integer", "minimum": 0 }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-products-batch" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-products-batch", "task_name": "Amazon Products Batch API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "errors": [ { "asin": "sample", "code": "sample", "message": "sample" } ], "failed": 1, "requested": 1, "succeeded": 1, "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-products-batch", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "details": {}, "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "marketplace": "amazon.com", "availability": "sample", "price_amount": "180", "review_count": 1, "price_currency": "GBP", "availability_text": "Sample availability_text 1", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location", "requested", "succeeded", "failed", "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "asin", "code", "message" ], "properties": { "asin": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "additionalProperties": false } }, "failed": { "type": "integer", "minimum": 0 }, "requested": { "type": "integer", "minimum": 0 }, "succeeded": { "type": "integer", "minimum": 0 }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-products-batch" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "url", "title", "description", "price", "price_amount", "price_currency", "availability", "availability_text", "rating", "review_count", "image_url", "image_urls", "details", "marketplace", "delivery_location" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "number", "null" ] }, "details": { "type": "object", "additionalProperties": { "type": "string" } }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "review_count": { "type": [ "integer", "null" ] }, "price_currency": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-products-batch", "task_name": "Amazon Products Batch API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonProductsBatchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "asins": { "type": "array", "items": { "type": "string", "pattern": "^[a-zA-Z0-9]{10}$", "x-sample": "B0C3HCD34R", "description": "Amazon product ASIN." }, "maxItems": 10, "minItems": 1, "x-sample": [ "B0C3HCD34R", "B085DV8T75" ], "description": "Between 1 and 10 Amazon product ASINs. Each ASIN has 10 letters or digits. Errors are reported per product." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "asins" ] }, "example": { "asins": [ "B0C3HCD34R", "B085DV8T75" ] } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-amazon-products-batch" }, "x-browsable-website-login-required": false } }, "/v1/tasks/amazon-search/runs": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Search API", "description": "Search Amazon products with price, rating, brand and category filters, sorting, and continuation cursors. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-search", "task_name": "Amazon Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "notice": "sample", "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-search", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "rank": 1, "tags": [ "Featured" ], "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "image_url": "https://example.com/item-1", "deal_badge": "sample", "list_price": "180", "sales_rank": 1, "is_sponsored": true, "price_amount": "180", "price_currency": "GBP", "numberOfReviews": 1, "previous_sales_rank": 1, "rank_change_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-search", "task_name": "Amazon Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "sort": { "enum": [ "relevance", "price_asc", "price_desc", "rating", "newest" ], "type": "string", "default": "relevance", "description": "Sort order. Choose an allowed value below." }, "brand": { "type": "string", "pattern": "^[^:,]+$", "maxLength": 100, "minLength": 1, "description": "Single brand name." }, "limit": { "type": "integer", "default": 100, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "query": { "type": "string", "x-sample": "wireless headphones", "maxLength": 500, "minLength": 1, "description": "Search text." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "domain": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Compatibility alias for marketplace." }, "category": { "type": "string", "x-sample": "electronics", "maxLength": 100, "minLength": 1, "description": "Department such as electronics, kitchen, books, beauty or pet supplies. Unsupported departments fail explicitly." }, "max_price": { "type": "number", "minimum": 0, "description": "Maximum item price in the marketplace currency." }, "min_price": { "type": "number", "minimum": 0, "description": "Minimum item price in the marketplace currency." }, "maxResults": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Compatibility alias for limit." }, "min_rating": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "Minimum product star rating." }, "category_id": { "type": "string", "pattern": "^[0-9]{1,20}$", "x-advanced": true, "description": "Amazon browse node ID for a more specific category." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "wireless headphones" } } } }, "x-browsable-website-login-required": false } }, "/v1/amazon/search": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Search API", "description": "Search Amazon products with price, rating, brand and category filters, sorting, and continuation cursors. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-search", "task_name": "Amazon Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "notice": "sample", "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-search", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "rank": 1, "tags": [ "Featured" ], "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "image_url": "https://example.com/item-1", "deal_badge": "sample", "list_price": "180", "sales_rank": 1, "is_sponsored": true, "price_amount": "180", "price_currency": "GBP", "numberOfReviews": 1, "previous_sales_rank": 1, "rank_change_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-search", "task_name": "Amazon Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "sort": { "enum": [ "relevance", "price_asc", "price_desc", "rating", "newest" ], "type": "string", "default": "relevance", "description": "Sort order. Choose an allowed value below." }, "brand": { "type": "string", "pattern": "^[^:,]+$", "maxLength": 100, "minLength": 1, "description": "Single brand name." }, "limit": { "type": "integer", "default": 100, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "query": { "type": "string", "x-sample": "wireless headphones", "maxLength": 500, "minLength": 1, "description": "Search text." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "domain": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Compatibility alias for marketplace." }, "category": { "type": "string", "x-sample": "electronics", "maxLength": 100, "minLength": 1, "description": "Department such as electronics, kitchen, books, beauty or pet supplies. Unsupported departments fail explicitly." }, "max_price": { "type": "number", "minimum": 0, "description": "Maximum item price in the marketplace currency." }, "min_price": { "type": "number", "minimum": 0, "description": "Minimum item price in the marketplace currency." }, "maxResults": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Compatibility alias for limit." }, "min_rating": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "Minimum product star rating." }, "category_id": { "type": "string", "pattern": "^[0-9]{1,20}$", "x-advanced": true, "description": "Amazon browse node ID for a more specific category." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "wireless headphones" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-amazon-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/amazon-seller-products/runs": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Seller Products API", "description": "Browse a public seller's product catalogue by merchant ID, with optional search, filters, sorting and continuation cursors. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-seller-products" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-seller-products", "task_name": "Amazon Seller Products API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "notice": "sample", "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-seller-products", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "rank": 1, "tags": [ "Featured" ], "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "image_url": "https://example.com/item-1", "deal_badge": "sample", "list_price": "180", "sales_rank": 1, "is_sponsored": true, "price_amount": "180", "price_currency": "GBP", "numberOfReviews": 1, "previous_sales_rank": 1, "rank_change_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-seller-products" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-seller-products", "task_name": "Amazon Seller Products API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonSellerProductsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "sort": { "enum": [ "relevance", "price_asc", "price_desc", "rating", "newest" ], "type": "string", "default": "relevance", "description": "Sort order. Choose an allowed value below." }, "brand": { "type": "string", "pattern": "^[^:,]+$", "maxLength": 100, "minLength": 1, "description": "Single brand name." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "query": { "type": "string", "x-sample": "wireless headphones", "maxLength": 500, "minLength": 1, "description": "Search text." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "category": { "type": "string", "x-sample": "electronics", "maxLength": 100, "minLength": 1, "description": "Department such as electronics, kitchen, books, beauty or pet supplies. Unsupported departments fail explicitly." }, "max_price": { "type": "number", "minimum": 0, "description": "Maximum item price in the marketplace currency." }, "min_price": { "type": "number", "minimum": 0, "description": "Minimum item price in the marketplace currency." }, "seller_id": { "type": "string", "pattern": "^[A-Z0-9]{8,32}$", "x-sample": "A294P4X9EWVXLJ", "x-advanced": true, "description": "Merchant ID from a public Amazon seller URL or product offer." }, "min_rating": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "Minimum product star rating." }, "seller_url": { "type": "string", "format": "uri", "x-sample": "https://www.amazon.com/sp?seller=A294P4X9EWVXLJ", "maxLength": 500, "minLength": 1, "description": "Public Amazon seller URL containing seller= or me=. The merchant ID and marketplace are resolved automatically." }, "category_id": { "type": "string", "pattern": "^[0-9]{1,20}$", "x-advanced": true, "description": "Amazon browse node ID for a more specific category." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "seller_url" ] }, { "required": [ "seller_id" ] } ] }, "example": { "seller_url": "https://www.amazon.com/sp?seller=A294P4X9EWVXLJ" } } } }, "x-browsable-website-login-required": false } }, "/v1/amazon/seller/products": { "post": { "tags": [ "Amazon" ], "summary": "Amazon Seller Products API", "description": "Browse a public seller's product catalogue by merchant ID, with optional search, filters, sorting and continuation cursors. No Amazon sign-in required. Prices and availability reflect the marketplace and delivery location; unavailable fields are null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-seller-products" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-seller-products", "task_name": "Amazon Seller Products API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "notice": "sample", "marketplace": "amazon.com", "delivery_location": { "applied": true, "displayed": "sample", "postal_code": "sample" } }, "count": 1, "query": "London", "source": "amazon-seller-products", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "asin": "sample", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "rank": 1, "tags": [ "Featured" ], "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "images": [ "https://images.example.com/images-1.jpg" ], "rating": 4.91, "image_url": "https://example.com/item-1", "deal_badge": "sample", "list_price": "180", "sales_rank": 1, "is_sponsored": true, "price_amount": "180", "price_currency": "GBP", "numberOfReviews": 1, "previous_sales_rank": 1, "rank_change_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "none", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "delivery_location" ], "properties": { "notice": { "type": "string" }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string" }, "delivery_location": { "type": "object", "required": [ "postal_code", "applied", "displayed" ], "properties": { "applied": { "type": "boolean" }, "displayed": { "type": [ "string", "null" ] }, "postal_code": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "amazon-seller-products" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "asin", "title", "url", "price", "price_amount", "price_currency", "list_price", "rating", "image_url", "deal_badge", "rank", "sales_rank", "previous_sales_rank", "rank_change_percent", "is_sponsored", "name", "link", "images", "tags", "numberOfReviews" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "asin": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "deal_badge": { "type": [ "string", "null" ] }, "list_price": { "type": [ "string", "null" ] }, "sales_rank": { "type": [ "integer", "null" ] }, "is_sponsored": { "type": "boolean" }, "price_amount": { "type": [ "string", "null" ], "description": "Decimal amount in the marketplace currency, without grouping separators; null when unavailable." }, "price_currency": { "type": [ "string", "null" ] }, "numberOfReviews": { "type": [ "integer", "null" ] }, "previous_sales_rank": { "type": [ "integer", "null" ] }, "rank_change_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "enum": [ "none", "cursor" ], "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "amazon-seller-products", "task_name": "Amazon Seller Products API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runAmazonSellerProductsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 1000, "minimum": 1, "description": "Starting upstream page. Prefer cursor to retain unused results and avoid duplicates." }, "sort": { "enum": [ "relevance", "price_asc", "price_desc", "rating", "newest" ], "type": "string", "default": "relevance", "description": "Sort order. Choose an allowed value below." }, "brand": { "type": "string", "pattern": "^[^:,]+$", "maxLength": 100, "minLength": 1, "description": "Single brand name." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "query": { "type": "string", "x-sample": "wireless headphones", "maxLength": 500, "minLength": 1, "description": "Search text." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from a prior response using the same filters and marketplace." }, "category": { "type": "string", "x-sample": "electronics", "maxLength": 100, "minLength": 1, "description": "Department such as electronics, kitchen, books, beauty or pet supplies. Unsupported departments fail explicitly." }, "max_price": { "type": "number", "minimum": 0, "description": "Maximum item price in the marketplace currency." }, "min_price": { "type": "number", "minimum": 0, "description": "Minimum item price in the marketplace currency." }, "seller_id": { "type": "string", "pattern": "^[A-Z0-9]{8,32}$", "x-sample": "A294P4X9EWVXLJ", "x-advanced": true, "description": "Merchant ID from a public Amazon seller URL or product offer." }, "min_rating": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "Minimum product star rating." }, "seller_url": { "type": "string", "format": "uri", "x-sample": "https://www.amazon.com/sp?seller=A294P4X9EWVXLJ", "maxLength": 500, "minLength": 1, "description": "Public Amazon seller URL containing seller= or me=. The merchant ID and marketplace are resolved automatically." }, "category_id": { "type": "string", "pattern": "^[0-9]{1,20}$", "x-advanced": true, "description": "Amazon browse node ID for a more specific category." }, "marketplace": { "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "x-sample": "amazon.com", "description": "Amazon marketplace. Defaults to the product URL's marketplace, or amazon.com." }, "postal_code": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9 -]+$", "x-sample": "10001", "maxLength": 16, "minLength": 2, "description": "Delivery postal code. The request fails if Amazon cannot apply it; responses include the displayed delivery location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "seller_url" ] }, { "required": [ "seller_id" ] } ] }, "example": { "seller_url": "https://www.amazon.com/sp?seller=A294P4X9EWVXLJ" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-amazon-seller-products" }, "x-browsable-website-login-required": false } }, "/v1/tasks/bandcamp-page/runs": { "post": { "tags": [ "Bandcamp" ], "summary": "Bandcamp Page API", "description": "Scrape a public Bandcamp artist, album, or track page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bandcamp-page", "task_name": "Bandcamp Page API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bandcamp-page", "task_name": "Bandcamp Page API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBandcampPageCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://artist.bandcamp.com/album/example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://artist.bandcamp.com/album/example" } } } }, "x-browsable-website-login-required": false } }, "/v1/bandcamp/page": { "post": { "tags": [ "Bandcamp" ], "summary": "Bandcamp Page API", "description": "Scrape a public Bandcamp artist, album, or track page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bandcamp-page", "task_name": "Bandcamp Page API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bandcamp-page", "task_name": "Bandcamp Page API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBandcampPageAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://artist.bandcamp.com/album/example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://artist.bandcamp.com/album/example" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-bandcamp-page" }, "x-browsable-website-login-required": false } }, "/v1/tasks/bandcamp-search/runs": { "post": { "tags": [ "Bandcamp" ], "summary": "Bandcamp API", "description": "Scrape public Bandcamp search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bandcamp-search", "task_name": "Bandcamp API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bandcamp-search", "task_name": "Bandcamp API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBandcampSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "ambient techno", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. ambient techno" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "ambient techno" } } } }, "x-browsable-website-login-required": false } }, "/v1/bandcamp/search": { "post": { "tags": [ "Bandcamp" ], "summary": "Bandcamp API", "description": "Scrape public Bandcamp search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bandcamp-search", "task_name": "Bandcamp API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bandcamp-search", "task_name": "Bandcamp API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBandcampSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "ambient techno", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. ambient techno" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "ambient techno" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-bandcamp-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/bbc-news-article/runs": { "post": { "tags": [ "BBC News" ], "summary": "BBC News Article API", "description": "Scrape a public BBC article page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bbc-news-article", "task_name": "BBC News Article API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bbc-news-article", "task_name": "BBC News Article API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBbcNewsArticleCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.bbc.com/news/articles/example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.bbc.com/news/articles/example" } } } }, "x-browsable-website-login-required": false } }, "/v1/bbc-news/article": { "post": { "tags": [ "BBC News" ], "summary": "BBC News Article API", "description": "Scrape a public BBC article page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bbc-news-article", "task_name": "BBC News Article API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bbc-news-article", "task_name": "BBC News Article API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBbcNewsArticleAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.bbc.com/news/articles/example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.bbc.com/news/articles/example" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-bbc-news-article" }, "x-browsable-website-login-required": false } }, "/v1/tasks/bbc-news-search/runs": { "post": { "tags": [ "BBC News" ], "summary": "BBC News API", "description": "Scrape public BBC search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bbc-news-search", "task_name": "BBC News API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bbc-news-search", "task_name": "BBC News API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBbcNewsSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "climate policy", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. climate policy" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "climate policy" } } } }, "x-browsable-website-login-required": false } }, "/v1/bbc-news/search": { "post": { "tags": [ "BBC News" ], "summary": "BBC News API", "description": "Scrape public BBC search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bbc-news-search", "task_name": "BBC News API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bbc-news-search", "task_name": "BBC News API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBbcNewsSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "climate policy", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. climate policy" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "climate policy" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-bbc-news-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/bluesky-profile/runs": { "post": { "tags": [ "Bluesky" ], "summary": "Bluesky Profile API", "description": "Fetch a public Bluesky profile by handle, DID, or profile URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bluesky-profile", "task_name": "Bluesky Profile API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bluesky-profile", "task_name": "Bluesky Profile API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBlueskyProfileCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "username": { "type": "string", "x-sample": "bsky.app", "maxLength": 2000, "minLength": 1, "description": "Bluesky handle or DID.", "x-placeholder": "e.g. bsky.app" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "bsky.app" } } } }, "x-browsable-website-login-required": false } }, "/v1/bluesky/profile": { "post": { "tags": [ "Bluesky" ], "summary": "Bluesky Profile API", "description": "Fetch a public Bluesky profile by handle, DID, or profile URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bluesky-profile", "task_name": "Bluesky Profile API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bluesky-profile", "task_name": "Bluesky Profile API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBlueskyProfileAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "username": { "type": "string", "x-sample": "bsky.app", "maxLength": 2000, "minLength": 1, "description": "Bluesky handle or DID.", "x-placeholder": "e.g. bsky.app" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "bsky.app" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-bluesky-profile" }, "x-browsable-website-login-required": false } }, "/v1/tasks/bluesky-search/runs": { "post": { "tags": [ "Bluesky" ], "summary": "Bluesky API", "description": "Search public Bluesky profiles through the public AppView API.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bluesky-search", "task_name": "Bluesky API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bluesky-search", "task_name": "Bluesky API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBlueskySearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "design", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. design" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "design" } } } }, "x-browsable-website-login-required": false } }, "/v1/bluesky/search": { "post": { "tags": [ "Bluesky" ], "summary": "Bluesky API", "description": "Search public Bluesky profiles through the public AppView API.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bluesky-search", "task_name": "Bluesky API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "bluesky-search", "task_name": "Bluesky API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBlueskySearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "design", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. design" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "design" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-bluesky-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/booking-hotel/runs": { "post": { "tags": [ "Booking.com" ], "summary": "Booking.com Hotel API", "description": "Scrape hotel details and dated room offers with occupancy, cancellation, meals, payment and tax text. Supply checkin, checkout, group_adults, group_children, no_rooms and selected_currency in the URL. Displayed prices may exclude taxes. Returns public discovery metadata; undated prices are not stay-specific quotes. This endpoint does not accept stay dates or occupancy; check a dated search on the source website for stay-specific prices.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "properties": { "price": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "price_value": { "type": [ "number", "null" ] }, "room_offers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "beds": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "taxes": { "type": [ "string", "null" ] }, "nights": { "type": [ "number", "null" ] }, "payment": { "type": [ "string", "null" ] }, "room_id": { "type": [ "string", "null" ] }, "capacity": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "breakfast": { "type": [ "string", "null" ] }, "meal_plan": { "type": [ "string", "null" ] }, "occupancy": { "type": [ "string", "null" ] }, "room_name": { "type": [ "string", "null" ] }, "conditions": { "type": [ "string", "null" ] }, "refundable": { "type": [ "boolean", "null" ] }, "tax_status": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "cancellation": { "type": [ "string", "null" ] }, "quote_source": { "type": [ "string", "null" ] }, "room_details": { "type": [ "object", "null" ], "properties": { "source": { "type": "string" }, "room_id": { "type": "string" }, "capacity": { "type": [ "number", "null" ] }, "facilities": { "type": "array", "items": { "type": "object" } }, "descriptions": {}, "room_area_m2": { "type": [ "number", "null" ] }, "bed_configurations": { "type": "array", "items": { "type": "object" } } } }, "source_total": { "type": [ "number", "null" ] }, "quote_room_id": { "type": [ "string", "null" ] }, "room_features": { "type": "array", "items": { "type": "string" } }, "hotel_currency": { "type": [ "string", "null" ] }, "policy_details": { "type": [ "string", "null" ] }, "quote_complete": { "type": "boolean" }, "quote_currency": { "type": [ "string", "null" ] }, "rate_is_genius": { "type": "boolean" }, "tax_exceptions": { "type": "array", "items": {} }, "displayed_total": { "type": [ "number", "null" ] }, "quote_room_name": { "type": [ "string", "null" ] }, "source_capacity": { "type": [ "number", "null" ] }, "source_subtotal": { "type": [ "number", "null" ] }, "excluded_charges": { "type": "array", "items": { "type": "object" } }, "included_charges": { "type": "array", "items": { "type": "object" } }, "optional_charges": { "type": "array", "items": { "type": "object" } }, "breakfast_included": { "type": [ "boolean", "null" ] }, "source_hotel_total": { "type": [ "number", "null" ] }, "conditional_charges": { "type": "array", "items": { "type": "object" } }, "max_selectable_rooms": { "type": [ "number", "null" ] }, "source_payment_terms": { "type": "object" }, "source_hotel_subtotal": { "type": [ "number", "null" ] }, "total_including_taxes": { "type": [ "number", "null" ] }, "matches_requested_stay": { "type": [ "boolean", "null" ] }, "observed_stay_verified": { "type": "boolean" }, "matches_requested_occupancy": { "type": [ "boolean", "null" ] } }, "additionalProperties": true } }, "observed_stay": { "type": "object", "properties": { "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "offers_status": { "type": [ "string", "null" ] }, "price_offer_id": { "type": [ "string", "null" ] }, "requested_stay": { "type": "object", "properties": { "rooms": { "type": [ "number", "null" ] }, "adults": { "type": [ "number", "null" ] }, "nights": { "type": [ "number", "null" ] }, "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] }, "children": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "room_details_status": { "type": [ "string", "null" ] }, "quote_display_currency": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "price_value": { "type": [ "number", "null" ] }, "room_offers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "beds": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "taxes": { "type": [ "string", "null" ] }, "nights": { "type": [ "number", "null" ] }, "payment": { "type": [ "string", "null" ] }, "room_id": { "type": [ "string", "null" ] }, "capacity": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "breakfast": { "type": [ "string", "null" ] }, "meal_plan": { "type": [ "string", "null" ] }, "occupancy": { "type": [ "string", "null" ] }, "room_name": { "type": [ "string", "null" ] }, "conditions": { "type": [ "string", "null" ] }, "refundable": { "type": [ "boolean", "null" ] }, "tax_status": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "cancellation": { "type": [ "string", "null" ] }, "quote_source": { "type": [ "string", "null" ] }, "room_details": { "type": [ "object", "null" ], "properties": { "source": { "type": "string" }, "room_id": { "type": "string" }, "capacity": { "type": [ "number", "null" ] }, "facilities": { "type": "array", "items": { "type": "object" } }, "descriptions": {}, "room_area_m2": { "type": [ "number", "null" ] }, "bed_configurations": { "type": "array", "items": { "type": "object" } } } }, "source_total": { "type": [ "number", "null" ] }, "quote_room_id": { "type": [ "string", "null" ] }, "room_features": { "type": "array", "items": { "type": "string" } }, "hotel_currency": { "type": [ "string", "null" ] }, "policy_details": { "type": [ "string", "null" ] }, "quote_complete": { "type": "boolean" }, "quote_currency": { "type": [ "string", "null" ] }, "rate_is_genius": { "type": "boolean" }, "tax_exceptions": { "type": "array", "items": {} }, "displayed_total": { "type": [ "number", "null" ] }, "quote_room_name": { "type": [ "string", "null" ] }, "source_capacity": { "type": [ "number", "null" ] }, "source_subtotal": { "type": [ "number", "null" ] }, "excluded_charges": { "type": "array", "items": { "type": "object" } }, "included_charges": { "type": "array", "items": { "type": "object" } }, "optional_charges": { "type": "array", "items": { "type": "object" } }, "breakfast_included": { "type": [ "boolean", "null" ] }, "source_hotel_total": { "type": [ "number", "null" ] }, "conditional_charges": { "type": "array", "items": { "type": "object" } }, "max_selectable_rooms": { "type": [ "number", "null" ] }, "source_payment_terms": { "type": "object" }, "source_hotel_subtotal": { "type": [ "number", "null" ] }, "total_including_taxes": { "type": [ "number", "null" ] }, "matches_requested_stay": { "type": [ "boolean", "null" ] }, "observed_stay_verified": { "type": "boolean" }, "matches_requested_occupancy": { "type": [ "boolean", "null" ] } }, "additionalProperties": true } }, "observed_stay": { "type": "object", "properties": { "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "offers_status": { "type": [ "string", "null" ] }, "price_offer_id": { "type": [ "string", "null" ] }, "requested_stay": { "type": "object", "properties": { "rooms": { "type": [ "number", "null" ] }, "adults": { "type": [ "number", "null" ] }, "nights": { "type": [ "number", "null" ] }, "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] }, "children": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "room_details_status": { "type": [ "string", "null" ] }, "quote_display_currency": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "booking-hotel", "task_name": "Booking.com Hotel API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "price": "180", "currency": "USD", "price_basis": "180", "price_value": 180, "room_offers": [ { "id": "id-1", "beds": "sample", "price": "180", "taxes": "sample", "nights": 1.5, "payment": "sample", "room_id": "id-1", "capacity": 1.5, "currency": "USD", "breakfast": "sample", "meal_plan": "sample", "occupancy": "sample", "room_name": "Stylish Shoreditch Loft with Balcony", "conditions": "sample", "refundable": true, "tax_status": "sample", "price_basis": "180", "cancellation": "sample", "quote_source": "sample", "room_details": { "source": "sample", "room_id": "id-1", "capacity": 1.5, "facilities": [ {} ], "descriptions": "sample", "room_area_m2": 1.5, "bed_configurations": [ {} ] }, "source_total": 180, "quote_room_id": "id-1", "room_features": [ "sample" ], "hotel_currency": "USD", "policy_details": "2 guests", "quote_complete": true, "quote_currency": "USD", "rate_is_genius": true, "tax_exceptions": [ "sample" ], "displayed_total": 180, "quote_room_name": "Stylish Shoreditch Loft with Balcony", "source_capacity": 1.5, "source_subtotal": 180, "excluded_charges": [ {} ], "included_charges": [ {} ], "optional_charges": [ {} ], "breakfast_included": true, "source_hotel_total": 180, "conditional_charges": [ {} ], "max_selectable_rooms": 1.5, "source_payment_terms": {}, "source_hotel_subtotal": 180, "total_including_taxes": 180, "matches_requested_stay": true, "observed_stay_verified": true, "matches_requested_occupancy": true } ], "observed_stay": { "checkin": "2026-06-14", "checkout": "2026-06-21" }, "offers_status": "sample", "price_offer_id": "180", "requested_stay": { "rooms": 1.5, "adults": 1, "nights": 1.5, "checkin": "2026-06-14", "checkout": "2026-06-21", "children": 1 }, "room_details_status": "2 guests", "quote_display_currency": "USD" }, "count": 1, "query": "London", "source": "sample", "results": [ { "price": "180", "currency": "USD", "price_basis": "180", "price_value": 180, "room_offers": [ { "id": "id-1", "beds": "sample", "price": "180", "taxes": "sample", "nights": 1.5, "payment": "sample", "room_id": "id-1", "capacity": 1.5, "currency": "USD", "breakfast": "sample", "meal_plan": "sample", "occupancy": "sample", "room_name": "Stylish Shoreditch Loft with Balcony", "conditions": "sample", "refundable": true, "tax_status": "sample", "price_basis": "180", "cancellation": "sample", "quote_source": "sample", "room_details": { "source": "sample", "room_id": "id-1", "capacity": 1.5, "facilities": [ {} ], "descriptions": "sample", "room_area_m2": 1.5, "bed_configurations": [ {} ] }, "source_total": 180, "quote_room_id": "id-1", "room_features": [ "sample" ], "hotel_currency": "USD", "policy_details": "2 guests", "quote_complete": true, "quote_currency": "USD", "rate_is_genius": true, "tax_exceptions": [ "sample" ], "displayed_total": 180, "quote_room_name": "Stylish Shoreditch Loft with Balcony", "source_capacity": 1.5, "source_subtotal": 180, "excluded_charges": [ {} ], "included_charges": [ {} ], "optional_charges": [ {} ], "breakfast_included": true, "source_hotel_total": 180, "conditional_charges": [ {} ], "max_selectable_rooms": 1.5, "source_payment_terms": {}, "source_hotel_subtotal": 180, "total_including_taxes": 180, "matches_requested_stay": true, "observed_stay_verified": true, "matches_requested_occupancy": true } ], "observed_stay": { "checkin": "2026-06-14", "checkout": "2026-06-21" }, "offers_status": "sample", "price_offer_id": "180", "requested_stay": { "rooms": 1.5, "adults": 1, "nights": 1.5, "checkin": "2026-06-14", "checkout": "2026-06-21", "children": 1 }, "room_details_status": "2 guests", "quote_display_currency": "USD" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "properties": { "price": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "price_value": { "type": [ "number", "null" ] }, "room_offers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "beds": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "taxes": { "type": [ "string", "null" ] }, "nights": { "type": [ "number", "null" ] }, "payment": { "type": [ "string", "null" ] }, "room_id": { "type": [ "string", "null" ] }, "capacity": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "breakfast": { "type": [ "string", "null" ] }, "meal_plan": { "type": [ "string", "null" ] }, "occupancy": { "type": [ "string", "null" ] }, "room_name": { "type": [ "string", "null" ] }, "conditions": { "type": [ "string", "null" ] }, "refundable": { "type": [ "boolean", "null" ] }, "tax_status": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "cancellation": { "type": [ "string", "null" ] }, "quote_source": { "type": [ "string", "null" ] }, "room_details": { "type": [ "object", "null" ], "properties": { "source": { "type": "string" }, "room_id": { "type": "string" }, "capacity": { "type": [ "number", "null" ] }, "facilities": { "type": "array", "items": { "type": "object" } }, "descriptions": {}, "room_area_m2": { "type": [ "number", "null" ] }, "bed_configurations": { "type": "array", "items": { "type": "object" } } } }, "source_total": { "type": [ "number", "null" ] }, "quote_room_id": { "type": [ "string", "null" ] }, "room_features": { "type": "array", "items": { "type": "string" } }, "hotel_currency": { "type": [ "string", "null" ] }, "policy_details": { "type": [ "string", "null" ] }, "quote_complete": { "type": "boolean" }, "quote_currency": { "type": [ "string", "null" ] }, "rate_is_genius": { "type": "boolean" }, "tax_exceptions": { "type": "array", "items": {} }, "displayed_total": { "type": [ "number", "null" ] }, "quote_room_name": { "type": [ "string", "null" ] }, "source_capacity": { "type": [ "number", "null" ] }, "source_subtotal": { "type": [ "number", "null" ] }, "excluded_charges": { "type": "array", "items": { "type": "object" } }, "included_charges": { "type": "array", "items": { "type": "object" } }, "optional_charges": { "type": "array", "items": { "type": "object" } }, "breakfast_included": { "type": [ "boolean", "null" ] }, "source_hotel_total": { "type": [ "number", "null" ] }, "conditional_charges": { "type": "array", "items": { "type": "object" } }, "max_selectable_rooms": { "type": [ "number", "null" ] }, "source_payment_terms": { "type": "object" }, "source_hotel_subtotal": { "type": [ "number", "null" ] }, "total_including_taxes": { "type": [ "number", "null" ] }, "matches_requested_stay": { "type": [ "boolean", "null" ] }, "observed_stay_verified": { "type": "boolean" }, "matches_requested_occupancy": { "type": [ "boolean", "null" ] } }, "additionalProperties": true } }, "observed_stay": { "type": "object", "properties": { "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "offers_status": { "type": [ "string", "null" ] }, "price_offer_id": { "type": [ "string", "null" ] }, "requested_stay": { "type": "object", "properties": { "rooms": { "type": [ "number", "null" ] }, "adults": { "type": [ "number", "null" ] }, "nights": { "type": [ "number", "null" ] }, "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] }, "children": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "room_details_status": { "type": [ "string", "null" ] }, "quote_display_currency": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "price_value": { "type": [ "number", "null" ] }, "room_offers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "beds": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "taxes": { "type": [ "string", "null" ] }, "nights": { "type": [ "number", "null" ] }, "payment": { "type": [ "string", "null" ] }, "room_id": { "type": [ "string", "null" ] }, "capacity": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "breakfast": { "type": [ "string", "null" ] }, "meal_plan": { "type": [ "string", "null" ] }, "occupancy": { "type": [ "string", "null" ] }, "room_name": { "type": [ "string", "null" ] }, "conditions": { "type": [ "string", "null" ] }, "refundable": { "type": [ "boolean", "null" ] }, "tax_status": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "cancellation": { "type": [ "string", "null" ] }, "quote_source": { "type": [ "string", "null" ] }, "room_details": { "type": [ "object", "null" ], "properties": { "source": { "type": "string" }, "room_id": { "type": "string" }, "capacity": { "type": [ "number", "null" ] }, "facilities": { "type": "array", "items": { "type": "object" } }, "descriptions": {}, "room_area_m2": { "type": [ "number", "null" ] }, "bed_configurations": { "type": "array", "items": { "type": "object" } } } }, "source_total": { "type": [ "number", "null" ] }, "quote_room_id": { "type": [ "string", "null" ] }, "room_features": { "type": "array", "items": { "type": "string" } }, "hotel_currency": { "type": [ "string", "null" ] }, "policy_details": { "type": [ "string", "null" ] }, "quote_complete": { "type": "boolean" }, "quote_currency": { "type": [ "string", "null" ] }, "rate_is_genius": { "type": "boolean" }, "tax_exceptions": { "type": "array", "items": {} }, "displayed_total": { "type": [ "number", "null" ] }, "quote_room_name": { "type": [ "string", "null" ] }, "source_capacity": { "type": [ "number", "null" ] }, "source_subtotal": { "type": [ "number", "null" ] }, "excluded_charges": { "type": "array", "items": { "type": "object" } }, "included_charges": { "type": "array", "items": { "type": "object" } }, "optional_charges": { "type": "array", "items": { "type": "object" } }, "breakfast_included": { "type": [ "boolean", "null" ] }, "source_hotel_total": { "type": [ "number", "null" ] }, "conditional_charges": { "type": "array", "items": { "type": "object" } }, "max_selectable_rooms": { "type": [ "number", "null" ] }, "source_payment_terms": { "type": "object" }, "source_hotel_subtotal": { "type": [ "number", "null" ] }, "total_including_taxes": { "type": [ "number", "null" ] }, "matches_requested_stay": { "type": [ "boolean", "null" ] }, "observed_stay_verified": { "type": "boolean" }, "matches_requested_occupancy": { "type": [ "boolean", "null" ] } }, "additionalProperties": true } }, "observed_stay": { "type": "object", "properties": { "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "offers_status": { "type": [ "string", "null" ] }, "price_offer_id": { "type": [ "string", "null" ] }, "requested_stay": { "type": "object", "properties": { "rooms": { "type": [ "number", "null" ] }, "adults": { "type": [ "number", "null" ] }, "nights": { "type": [ "number", "null" ] }, "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] }, "children": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "room_details_status": { "type": [ "string", "null" ] }, "quote_display_currency": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "booking-hotel", "task_name": "Booking.com Hotel API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBookingHotelCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.booking.com/hotel/gb/example.html" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.booking.com/hotel/gb/example.html" } } } }, "x-browsable-website-login-required": false } }, "/v1/booking/hotel": { "post": { "tags": [ "Booking.com" ], "summary": "Booking.com Hotel API", "description": "Scrape hotel details and dated room offers with occupancy, cancellation, meals, payment and tax text. Supply checkin, checkout, group_adults, group_children, no_rooms and selected_currency in the URL. Displayed prices may exclude taxes. Returns public discovery metadata; undated prices are not stay-specific quotes. This endpoint does not accept stay dates or occupancy; check a dated search on the source website for stay-specific prices.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "properties": { "price": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "price_value": { "type": [ "number", "null" ] }, "room_offers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "beds": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "taxes": { "type": [ "string", "null" ] }, "nights": { "type": [ "number", "null" ] }, "payment": { "type": [ "string", "null" ] }, "room_id": { "type": [ "string", "null" ] }, "capacity": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "breakfast": { "type": [ "string", "null" ] }, "meal_plan": { "type": [ "string", "null" ] }, "occupancy": { "type": [ "string", "null" ] }, "room_name": { "type": [ "string", "null" ] }, "conditions": { "type": [ "string", "null" ] }, "refundable": { "type": [ "boolean", "null" ] }, "tax_status": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "cancellation": { "type": [ "string", "null" ] }, "quote_source": { "type": [ "string", "null" ] }, "room_details": { "type": [ "object", "null" ], "properties": { "source": { "type": "string" }, "room_id": { "type": "string" }, "capacity": { "type": [ "number", "null" ] }, "facilities": { "type": "array", "items": { "type": "object" } }, "descriptions": {}, "room_area_m2": { "type": [ "number", "null" ] }, "bed_configurations": { "type": "array", "items": { "type": "object" } } } }, "source_total": { "type": [ "number", "null" ] }, "quote_room_id": { "type": [ "string", "null" ] }, "room_features": { "type": "array", "items": { "type": "string" } }, "hotel_currency": { "type": [ "string", "null" ] }, "policy_details": { "type": [ "string", "null" ] }, "quote_complete": { "type": "boolean" }, "quote_currency": { "type": [ "string", "null" ] }, "rate_is_genius": { "type": "boolean" }, "tax_exceptions": { "type": "array", "items": {} }, "displayed_total": { "type": [ "number", "null" ] }, "quote_room_name": { "type": [ "string", "null" ] }, "source_capacity": { "type": [ "number", "null" ] }, "source_subtotal": { "type": [ "number", "null" ] }, "excluded_charges": { "type": "array", "items": { "type": "object" } }, "included_charges": { "type": "array", "items": { "type": "object" } }, "optional_charges": { "type": "array", "items": { "type": "object" } }, "breakfast_included": { "type": [ "boolean", "null" ] }, "source_hotel_total": { "type": [ "number", "null" ] }, "conditional_charges": { "type": "array", "items": { "type": "object" } }, "max_selectable_rooms": { "type": [ "number", "null" ] }, "source_payment_terms": { "type": "object" }, "source_hotel_subtotal": { "type": [ "number", "null" ] }, "total_including_taxes": { "type": [ "number", "null" ] }, "matches_requested_stay": { "type": [ "boolean", "null" ] }, "observed_stay_verified": { "type": "boolean" }, "matches_requested_occupancy": { "type": [ "boolean", "null" ] } }, "additionalProperties": true } }, "observed_stay": { "type": "object", "properties": { "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "offers_status": { "type": [ "string", "null" ] }, "price_offer_id": { "type": [ "string", "null" ] }, "requested_stay": { "type": "object", "properties": { "rooms": { "type": [ "number", "null" ] }, "adults": { "type": [ "number", "null" ] }, "nights": { "type": [ "number", "null" ] }, "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] }, "children": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "room_details_status": { "type": [ "string", "null" ] }, "quote_display_currency": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "price_value": { "type": [ "number", "null" ] }, "room_offers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "beds": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "taxes": { "type": [ "string", "null" ] }, "nights": { "type": [ "number", "null" ] }, "payment": { "type": [ "string", "null" ] }, "room_id": { "type": [ "string", "null" ] }, "capacity": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "breakfast": { "type": [ "string", "null" ] }, "meal_plan": { "type": [ "string", "null" ] }, "occupancy": { "type": [ "string", "null" ] }, "room_name": { "type": [ "string", "null" ] }, "conditions": { "type": [ "string", "null" ] }, "refundable": { "type": [ "boolean", "null" ] }, "tax_status": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "cancellation": { "type": [ "string", "null" ] }, "quote_source": { "type": [ "string", "null" ] }, "room_details": { "type": [ "object", "null" ], "properties": { "source": { "type": "string" }, "room_id": { "type": "string" }, "capacity": { "type": [ "number", "null" ] }, "facilities": { "type": "array", "items": { "type": "object" } }, "descriptions": {}, "room_area_m2": { "type": [ "number", "null" ] }, "bed_configurations": { "type": "array", "items": { "type": "object" } } } }, "source_total": { "type": [ "number", "null" ] }, "quote_room_id": { "type": [ "string", "null" ] }, "room_features": { "type": "array", "items": { "type": "string" } }, "hotel_currency": { "type": [ "string", "null" ] }, "policy_details": { "type": [ "string", "null" ] }, "quote_complete": { "type": "boolean" }, "quote_currency": { "type": [ "string", "null" ] }, "rate_is_genius": { "type": "boolean" }, "tax_exceptions": { "type": "array", "items": {} }, "displayed_total": { "type": [ "number", "null" ] }, "quote_room_name": { "type": [ "string", "null" ] }, "source_capacity": { "type": [ "number", "null" ] }, "source_subtotal": { "type": [ "number", "null" ] }, "excluded_charges": { "type": "array", "items": { "type": "object" } }, "included_charges": { "type": "array", "items": { "type": "object" } }, "optional_charges": { "type": "array", "items": { "type": "object" } }, "breakfast_included": { "type": [ "boolean", "null" ] }, "source_hotel_total": { "type": [ "number", "null" ] }, "conditional_charges": { "type": "array", "items": { "type": "object" } }, "max_selectable_rooms": { "type": [ "number", "null" ] }, "source_payment_terms": { "type": "object" }, "source_hotel_subtotal": { "type": [ "number", "null" ] }, "total_including_taxes": { "type": [ "number", "null" ] }, "matches_requested_stay": { "type": [ "boolean", "null" ] }, "observed_stay_verified": { "type": "boolean" }, "matches_requested_occupancy": { "type": [ "boolean", "null" ] } }, "additionalProperties": true } }, "observed_stay": { "type": "object", "properties": { "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "offers_status": { "type": [ "string", "null" ] }, "price_offer_id": { "type": [ "string", "null" ] }, "requested_stay": { "type": "object", "properties": { "rooms": { "type": [ "number", "null" ] }, "adults": { "type": [ "number", "null" ] }, "nights": { "type": [ "number", "null" ] }, "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] }, "children": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "room_details_status": { "type": [ "string", "null" ] }, "quote_display_currency": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "booking-hotel", "task_name": "Booking.com Hotel API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "price": "180", "currency": "USD", "price_basis": "180", "price_value": 180, "room_offers": [ { "id": "id-1", "beds": "sample", "price": "180", "taxes": "sample", "nights": 1.5, "payment": "sample", "room_id": "id-1", "capacity": 1.5, "currency": "USD", "breakfast": "sample", "meal_plan": "sample", "occupancy": "sample", "room_name": "Stylish Shoreditch Loft with Balcony", "conditions": "sample", "refundable": true, "tax_status": "sample", "price_basis": "180", "cancellation": "sample", "quote_source": "sample", "room_details": { "source": "sample", "room_id": "id-1", "capacity": 1.5, "facilities": [ {} ], "descriptions": "sample", "room_area_m2": 1.5, "bed_configurations": [ {} ] }, "source_total": 180, "quote_room_id": "id-1", "room_features": [ "sample" ], "hotel_currency": "USD", "policy_details": "2 guests", "quote_complete": true, "quote_currency": "USD", "rate_is_genius": true, "tax_exceptions": [ "sample" ], "displayed_total": 180, "quote_room_name": "Stylish Shoreditch Loft with Balcony", "source_capacity": 1.5, "source_subtotal": 180, "excluded_charges": [ {} ], "included_charges": [ {} ], "optional_charges": [ {} ], "breakfast_included": true, "source_hotel_total": 180, "conditional_charges": [ {} ], "max_selectable_rooms": 1.5, "source_payment_terms": {}, "source_hotel_subtotal": 180, "total_including_taxes": 180, "matches_requested_stay": true, "observed_stay_verified": true, "matches_requested_occupancy": true } ], "observed_stay": { "checkin": "2026-06-14", "checkout": "2026-06-21" }, "offers_status": "sample", "price_offer_id": "180", "requested_stay": { "rooms": 1.5, "adults": 1, "nights": 1.5, "checkin": "2026-06-14", "checkout": "2026-06-21", "children": 1 }, "room_details_status": "2 guests", "quote_display_currency": "USD" }, "count": 1, "query": "London", "source": "sample", "results": [ { "price": "180", "currency": "USD", "price_basis": "180", "price_value": 180, "room_offers": [ { "id": "id-1", "beds": "sample", "price": "180", "taxes": "sample", "nights": 1.5, "payment": "sample", "room_id": "id-1", "capacity": 1.5, "currency": "USD", "breakfast": "sample", "meal_plan": "sample", "occupancy": "sample", "room_name": "Stylish Shoreditch Loft with Balcony", "conditions": "sample", "refundable": true, "tax_status": "sample", "price_basis": "180", "cancellation": "sample", "quote_source": "sample", "room_details": { "source": "sample", "room_id": "id-1", "capacity": 1.5, "facilities": [ {} ], "descriptions": "sample", "room_area_m2": 1.5, "bed_configurations": [ {} ] }, "source_total": 180, "quote_room_id": "id-1", "room_features": [ "sample" ], "hotel_currency": "USD", "policy_details": "2 guests", "quote_complete": true, "quote_currency": "USD", "rate_is_genius": true, "tax_exceptions": [ "sample" ], "displayed_total": 180, "quote_room_name": "Stylish Shoreditch Loft with Balcony", "source_capacity": 1.5, "source_subtotal": 180, "excluded_charges": [ {} ], "included_charges": [ {} ], "optional_charges": [ {} ], "breakfast_included": true, "source_hotel_total": 180, "conditional_charges": [ {} ], "max_selectable_rooms": 1.5, "source_payment_terms": {}, "source_hotel_subtotal": 180, "total_including_taxes": 180, "matches_requested_stay": true, "observed_stay_verified": true, "matches_requested_occupancy": true } ], "observed_stay": { "checkin": "2026-06-14", "checkout": "2026-06-21" }, "offers_status": "sample", "price_offer_id": "180", "requested_stay": { "rooms": 1.5, "adults": 1, "nights": 1.5, "checkin": "2026-06-14", "checkout": "2026-06-21", "children": 1 }, "room_details_status": "2 guests", "quote_display_currency": "USD" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "properties": { "price": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "price_value": { "type": [ "number", "null" ] }, "room_offers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "beds": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "taxes": { "type": [ "string", "null" ] }, "nights": { "type": [ "number", "null" ] }, "payment": { "type": [ "string", "null" ] }, "room_id": { "type": [ "string", "null" ] }, "capacity": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "breakfast": { "type": [ "string", "null" ] }, "meal_plan": { "type": [ "string", "null" ] }, "occupancy": { "type": [ "string", "null" ] }, "room_name": { "type": [ "string", "null" ] }, "conditions": { "type": [ "string", "null" ] }, "refundable": { "type": [ "boolean", "null" ] }, "tax_status": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "cancellation": { "type": [ "string", "null" ] }, "quote_source": { "type": [ "string", "null" ] }, "room_details": { "type": [ "object", "null" ], "properties": { "source": { "type": "string" }, "room_id": { "type": "string" }, "capacity": { "type": [ "number", "null" ] }, "facilities": { "type": "array", "items": { "type": "object" } }, "descriptions": {}, "room_area_m2": { "type": [ "number", "null" ] }, "bed_configurations": { "type": "array", "items": { "type": "object" } } } }, "source_total": { "type": [ "number", "null" ] }, "quote_room_id": { "type": [ "string", "null" ] }, "room_features": { "type": "array", "items": { "type": "string" } }, "hotel_currency": { "type": [ "string", "null" ] }, "policy_details": { "type": [ "string", "null" ] }, "quote_complete": { "type": "boolean" }, "quote_currency": { "type": [ "string", "null" ] }, "rate_is_genius": { "type": "boolean" }, "tax_exceptions": { "type": "array", "items": {} }, "displayed_total": { "type": [ "number", "null" ] }, "quote_room_name": { "type": [ "string", "null" ] }, "source_capacity": { "type": [ "number", "null" ] }, "source_subtotal": { "type": [ "number", "null" ] }, "excluded_charges": { "type": "array", "items": { "type": "object" } }, "included_charges": { "type": "array", "items": { "type": "object" } }, "optional_charges": { "type": "array", "items": { "type": "object" } }, "breakfast_included": { "type": [ "boolean", "null" ] }, "source_hotel_total": { "type": [ "number", "null" ] }, "conditional_charges": { "type": "array", "items": { "type": "object" } }, "max_selectable_rooms": { "type": [ "number", "null" ] }, "source_payment_terms": { "type": "object" }, "source_hotel_subtotal": { "type": [ "number", "null" ] }, "total_including_taxes": { "type": [ "number", "null" ] }, "matches_requested_stay": { "type": [ "boolean", "null" ] }, "observed_stay_verified": { "type": "boolean" }, "matches_requested_occupancy": { "type": [ "boolean", "null" ] } }, "additionalProperties": true } }, "observed_stay": { "type": "object", "properties": { "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "offers_status": { "type": [ "string", "null" ] }, "price_offer_id": { "type": [ "string", "null" ] }, "requested_stay": { "type": "object", "properties": { "rooms": { "type": [ "number", "null" ] }, "adults": { "type": [ "number", "null" ] }, "nights": { "type": [ "number", "null" ] }, "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] }, "children": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "room_details_status": { "type": [ "string", "null" ] }, "quote_display_currency": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "properties": { "price": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "price_value": { "type": [ "number", "null" ] }, "room_offers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "beds": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "taxes": { "type": [ "string", "null" ] }, "nights": { "type": [ "number", "null" ] }, "payment": { "type": [ "string", "null" ] }, "room_id": { "type": [ "string", "null" ] }, "capacity": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "breakfast": { "type": [ "string", "null" ] }, "meal_plan": { "type": [ "string", "null" ] }, "occupancy": { "type": [ "string", "null" ] }, "room_name": { "type": [ "string", "null" ] }, "conditions": { "type": [ "string", "null" ] }, "refundable": { "type": [ "boolean", "null" ] }, "tax_status": { "type": [ "string", "null" ] }, "price_basis": { "type": [ "string", "null" ] }, "cancellation": { "type": [ "string", "null" ] }, "quote_source": { "type": [ "string", "null" ] }, "room_details": { "type": [ "object", "null" ], "properties": { "source": { "type": "string" }, "room_id": { "type": "string" }, "capacity": { "type": [ "number", "null" ] }, "facilities": { "type": "array", "items": { "type": "object" } }, "descriptions": {}, "room_area_m2": { "type": [ "number", "null" ] }, "bed_configurations": { "type": "array", "items": { "type": "object" } } } }, "source_total": { "type": [ "number", "null" ] }, "quote_room_id": { "type": [ "string", "null" ] }, "room_features": { "type": "array", "items": { "type": "string" } }, "hotel_currency": { "type": [ "string", "null" ] }, "policy_details": { "type": [ "string", "null" ] }, "quote_complete": { "type": "boolean" }, "quote_currency": { "type": [ "string", "null" ] }, "rate_is_genius": { "type": "boolean" }, "tax_exceptions": { "type": "array", "items": {} }, "displayed_total": { "type": [ "number", "null" ] }, "quote_room_name": { "type": [ "string", "null" ] }, "source_capacity": { "type": [ "number", "null" ] }, "source_subtotal": { "type": [ "number", "null" ] }, "excluded_charges": { "type": "array", "items": { "type": "object" } }, "included_charges": { "type": "array", "items": { "type": "object" } }, "optional_charges": { "type": "array", "items": { "type": "object" } }, "breakfast_included": { "type": [ "boolean", "null" ] }, "source_hotel_total": { "type": [ "number", "null" ] }, "conditional_charges": { "type": "array", "items": { "type": "object" } }, "max_selectable_rooms": { "type": [ "number", "null" ] }, "source_payment_terms": { "type": "object" }, "source_hotel_subtotal": { "type": [ "number", "null" ] }, "total_including_taxes": { "type": [ "number", "null" ] }, "matches_requested_stay": { "type": [ "boolean", "null" ] }, "observed_stay_verified": { "type": "boolean" }, "matches_requested_occupancy": { "type": [ "boolean", "null" ] } }, "additionalProperties": true } }, "observed_stay": { "type": "object", "properties": { "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "offers_status": { "type": [ "string", "null" ] }, "price_offer_id": { "type": [ "string", "null" ] }, "requested_stay": { "type": "object", "properties": { "rooms": { "type": [ "number", "null" ] }, "adults": { "type": [ "number", "null" ] }, "nights": { "type": [ "number", "null" ] }, "checkin": { "type": [ "string", "null" ] }, "checkout": { "type": [ "string", "null" ] }, "children": { "type": [ "number", "null" ] } }, "additionalProperties": true }, "room_details_status": { "type": [ "string", "null" ] }, "quote_display_currency": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "booking-hotel", "task_name": "Booking.com Hotel API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBookingHotelAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.booking.com/hotel/gb/example.html" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.booking.com/hotel/gb/example.html" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-booking-hotel" }, "x-browsable-website-login-required": false } }, "/v1/tasks/booking-search/runs": { "post": { "tags": [ "Booking.com" ], "summary": "Booking.com API", "description": "Scrape public Booking.com accommodation search results by destination. Returns public discovery metadata; undated prices are not stay-specific quotes. This endpoint does not accept stay dates or occupancy; check a dated search on the source website for stay-specific prices.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "booking-search", "task_name": "Booking.com API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "booking-search", "task_name": "Booking.com API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBookingSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "London", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. London" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "x-browsable-website-login-required": false } }, "/v1/booking/search": { "post": { "tags": [ "Booking.com" ], "summary": "Booking.com API", "description": "Scrape public Booking.com accommodation search results by destination. Returns public discovery metadata; undated prices are not stay-specific quotes. This endpoint does not accept stay dates or occupancy; check a dated search on the source website for stay-specific prices.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "booking-search", "task_name": "Booking.com API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "booking-search", "task_name": "Booking.com API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runBookingSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "London", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. London" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-booking-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/capterra-product/runs": { "post": { "tags": [ "Capterra" ], "summary": "Capterra Product API", "description": "Scrape a public Capterra product page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "capterra-product", "task_name": "Capterra Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "capterra-product", "task_name": "Capterra Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCapterraProductCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.capterra.com/p/123456/example/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.capterra.com/p/123456/example/" } } } }, "x-browsable-website-login-required": false } }, "/v1/capterra/product": { "post": { "tags": [ "Capterra" ], "summary": "Capterra Product API", "description": "Scrape a public Capterra product page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "capterra-product", "task_name": "Capterra Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "capterra-product", "task_name": "Capterra Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCapterraProductAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.capterra.com/p/123456/example/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.capterra.com/p/123456/example/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-capterra-product" }, "x-browsable-website-login-required": false } }, "/v1/tasks/capterra-search/runs": { "post": { "tags": [ "Capterra" ], "summary": "Capterra API", "description": "Scrape public Capterra software search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "capterra-search", "task_name": "Capterra API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "capterra-search", "task_name": "Capterra API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCapterraSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "project management", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. project management" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "project management" } } } }, "x-browsable-website-login-required": false } }, "/v1/capterra/search": { "post": { "tags": [ "Capterra" ], "summary": "Capterra API", "description": "Scrape public Capterra software search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "capterra-search", "task_name": "Capterra API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "capterra-search", "task_name": "Capterra API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCapterraSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "project management", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. project management" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "project management" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-capterra-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/costco-product/runs": { "post": { "tags": [ "Costco" ], "summary": "Costco Product API", "description": "Scrape a public Costco product detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "costco-product", "task_name": "Costco Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "costco-product", "task_name": "Costco Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCostcoProductCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Costco product URL returned by costco/search.", "x-placeholder": "e.g. https://www.costco.com/example.product.1234567.html" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.costco.com/example.product.1234567.html" } } } }, "x-browsable-website-login-required": false } }, "/v1/costco/product": { "post": { "tags": [ "Costco" ], "summary": "Costco Product API", "description": "Scrape a public Costco product detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "costco-product", "task_name": "Costco Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "costco-product", "task_name": "Costco Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCostcoProductAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Costco product URL returned by costco/search.", "x-placeholder": "e.g. https://www.costco.com/example.product.1234567.html" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.costco.com/example.product.1234567.html" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-costco-product" }, "x-browsable-website-login-required": false } }, "/v1/tasks/costco-search/runs": { "post": { "tags": [ "Costco" ], "summary": "Costco API", "description": "Scrape public Costco search result pages by query.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "costco-search", "task_name": "Costco API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "costco-search", "task_name": "Costco API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCostcoSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "paper towels", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. paper towels" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "paper towels" } } } }, "x-browsable-website-login-required": false } }, "/v1/costco/search": { "post": { "tags": [ "Costco" ], "summary": "Costco API", "description": "Scrape public Costco search result pages by query.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "costco-search", "task_name": "Costco API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "costco-search", "task_name": "Costco API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCostcoSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "paper towels", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. paper towels" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "paper towels" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-costco-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/craigslist-post/runs": { "post": { "tags": [ "Craigslist" ], "summary": "Craigslist Post API", "description": "Scrape a public Craigslist result detail page from a search result URL or post id.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "craigslist-post", "task_name": "Craigslist Post API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "craigslist-post", "task_name": "Craigslist Post API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCraigslistPostCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Craigslist post id or search result id. URL is preferred when available.", "x-placeholder": "e.g. 7933608346" }, "url": { "type": "string", "x-sample": "https://sfbay.craigslist.org/scz/tls/d/santa-cruz-electric-lawnmower/7933608346.html", "maxLength": 2000, "minLength": 1, "description": "Craigslist result URL returned by craigslist/search.", "x-placeholder": "e.g. https://sfbay.craigslist.org/scz/tls/d/santa-cruz-electric-lawnmower/7933608346.html" }, "site": { "type": "string", "default": "sfbay", "description": "Craigslist subdomain to use when resolving an id without a URL.", "x-placeholder": "e.g. sfbay" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://sfbay.craigslist.org/scz/tls/d/santa-cruz-electric-lawnmower/7933608346.html" } } } }, "x-browsable-website-login-required": false } }, "/v1/craigslist/post": { "post": { "tags": [ "Craigslist" ], "summary": "Craigslist Post API", "description": "Scrape a public Craigslist result detail page from a search result URL or post id.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "craigslist-post", "task_name": "Craigslist Post API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "craigslist-post", "task_name": "Craigslist Post API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCraigslistPostAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Craigslist post id or search result id. URL is preferred when available.", "x-placeholder": "e.g. 7933608346" }, "url": { "type": "string", "x-sample": "https://sfbay.craigslist.org/scz/tls/d/santa-cruz-electric-lawnmower/7933608346.html", "maxLength": 2000, "minLength": 1, "description": "Craigslist result URL returned by craigslist/search.", "x-placeholder": "e.g. https://sfbay.craigslist.org/scz/tls/d/santa-cruz-electric-lawnmower/7933608346.html" }, "site": { "type": "string", "default": "sfbay", "description": "Craigslist subdomain to use when resolving an id without a URL.", "x-placeholder": "e.g. sfbay" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://sfbay.craigslist.org/scz/tls/d/santa-cruz-electric-lawnmower/7933608346.html" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-craigslist-post" }, "x-browsable-website-login-required": false } }, "/v1/tasks/craigslist-search/runs": { "post": { "tags": [ "Craigslist" ], "summary": "Craigslist API", "description": "Scrape public Craigslist search results by query and site with offset pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "craigslist-search", "task_name": "Craigslist API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "craigslist-search", "task_name": "Craigslist API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCraigslistSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "site": { "type": "string", "x-advanced": true, "description": "Advanced regional Craigslist subdomain, such as sfbay. Use location for a city name.", "x-placeholder": "e.g. sfbay" }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "lawnmower", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. lawnmower" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "location": { "type": "string", "x-sample": "San Francisco, CA", "maxLength": 500, "minLength": 1, "description": "City or region name, such as San Francisco, CA or New York, NY. No region is assumed." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ], "anyOf": [ { "required": [ "location" ] }, { "required": [ "site" ] } ] }, "example": { "query": "lawnmower", "location": "San Francisco, CA" } } } }, "x-browsable-website-login-required": false } }, "/v1/craigslist/search": { "post": { "tags": [ "Craigslist" ], "summary": "Craigslist API", "description": "Scrape public Craigslist search results by query and site with offset pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "craigslist-search", "task_name": "Craigslist API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "craigslist-search", "task_name": "Craigslist API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCraigslistSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "site": { "type": "string", "x-advanced": true, "description": "Advanced regional Craigslist subdomain, such as sfbay. Use location for a city name.", "x-placeholder": "e.g. sfbay" }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "lawnmower", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. lawnmower" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "location": { "type": "string", "x-sample": "San Francisco, CA", "maxLength": 500, "minLength": 1, "description": "City or region name, such as San Francisco, CA or New York, NY. No region is assumed." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ], "anyOf": [ { "required": [ "location" ] }, { "required": [ "site" ] } ] }, "example": { "query": "lawnmower", "location": "San Francisco, CA" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-craigslist-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/crunchbase-organization/runs": { "post": { "tags": [ "Crunchbase" ], "summary": "Crunchbase Organization API", "description": "Scrape a public Crunchbase organization profile.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "crunchbase-organization", "task_name": "Crunchbase Organization API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "crunchbase-organization", "task_name": "Crunchbase Organization API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCrunchbaseOrganizationCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.crunchbase.com/organization/stripe", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.crunchbase.com/organization/stripe" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.crunchbase.com/organization/stripe" } } } }, "x-browsable-website-login-required": false } }, "/v1/crunchbase/organization": { "post": { "tags": [ "Crunchbase" ], "summary": "Crunchbase Organization API", "description": "Scrape a public Crunchbase organization profile.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "crunchbase-organization", "task_name": "Crunchbase Organization API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "crunchbase-organization", "task_name": "Crunchbase Organization API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCrunchbaseOrganizationAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.crunchbase.com/organization/stripe", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.crunchbase.com/organization/stripe" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.crunchbase.com/organization/stripe" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-crunchbase-organization" }, "x-browsable-website-login-required": false } }, "/v1/tasks/crunchbase-search/runs": { "post": { "tags": [ "Crunchbase" ], "summary": "Crunchbase API", "description": "Scrape public Crunchbase organization search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "crunchbase-search", "task_name": "Crunchbase API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "crunchbase-search", "task_name": "Crunchbase API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCrunchbaseSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Stripe", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Stripe" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Stripe" } } } }, "x-browsable-website-login-required": false } }, "/v1/crunchbase/search": { "post": { "tags": [ "Crunchbase" ], "summary": "Crunchbase API", "description": "Scrape public Crunchbase organization search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "crunchbase-search", "task_name": "Crunchbase API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "crunchbase-search", "task_name": "Crunchbase API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runCrunchbaseSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Stripe", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Stripe" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Stripe" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-crunchbase-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/depop-listing/runs": { "post": { "tags": [ "Depop" ], "summary": "Depop Listing API", "description": "Scrape a public Depop product page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "depop-listing", "task_name": "Depop Listing API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "depop-listing", "task_name": "Depop Listing API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runDepopListingCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.depop.com/products/seller-example-item/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.depop.com/products/seller-example-item/" } } } }, "x-browsable-website-login-required": false } }, "/v1/depop/listing": { "post": { "tags": [ "Depop" ], "summary": "Depop Listing API", "description": "Scrape a public Depop product page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "depop-listing", "task_name": "Depop Listing API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "depop-listing", "task_name": "Depop Listing API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runDepopListingAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.depop.com/products/seller-example-item/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.depop.com/products/seller-example-item/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-depop-listing" }, "x-browsable-website-login-required": false } }, "/v1/tasks/depop-search/runs": { "post": { "tags": [ "Depop" ], "summary": "Depop API", "description": "Scrape public Depop listing search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "depop-search", "task_name": "Depop API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "depop-search", "task_name": "Depop API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runDepopSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "leather boots", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. leather boots" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "leather boots" } } } }, "x-browsable-website-login-required": false } }, "/v1/depop/search": { "post": { "tags": [ "Depop" ], "summary": "Depop API", "description": "Scrape public Depop listing search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "depop-search", "task_name": "Depop API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "depop-search", "task_name": "Depop API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runDepopSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "leather boots", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. leather boots" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "leather boots" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-depop-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/discogs-release/runs": { "post": { "tags": [ "Discogs" ], "summary": "Discogs Release API", "description": "Scrape a public Discogs release, master, or artist page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "discogs-release", "task_name": "Discogs Release API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "discogs-release", "task_name": "Discogs Release API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runDiscogsReleaseCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.discogs.com/release/123456-example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.discogs.com/release/123456-example" } } } }, "x-browsable-website-login-required": false } }, "/v1/discogs/release": { "post": { "tags": [ "Discogs" ], "summary": "Discogs Release API", "description": "Scrape a public Discogs release, master, or artist page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "discogs-release", "task_name": "Discogs Release API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "discogs-release", "task_name": "Discogs Release API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runDiscogsReleaseAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.discogs.com/release/123456-example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.discogs.com/release/123456-example" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-discogs-release" }, "x-browsable-website-login-required": false } }, "/v1/tasks/discogs-search/runs": { "post": { "tags": [ "Discogs" ], "summary": "Discogs API", "description": "Scrape public Discogs marketplace and catalog search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "discogs-search", "task_name": "Discogs API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "discogs-search", "task_name": "Discogs API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runDiscogsSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Miles Davis Kind of Blue", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Miles Davis Kind of Blue" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Miles Davis Kind of Blue" } } } }, "x-browsable-website-login-required": false } }, "/v1/discogs/search": { "post": { "tags": [ "Discogs" ], "summary": "Discogs API", "description": "Scrape public Discogs marketplace and catalog search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "discogs-search", "task_name": "Discogs API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "discogs-search", "task_name": "Discogs API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runDiscogsSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Miles Davis Kind of Blue", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Miles Davis Kind of Blue" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Miles Davis Kind of Blue" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-discogs-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/ebay-item/runs": { "post": { "tags": [ "eBay" ], "summary": "eBay Item API", "description": "Read the exact public ebay.com listing by item URL or id, including displayed price, condition, images and seller feedback. Listing sold counters are not a transaction history. eBay may restrict anonymous access.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "item_id", "variation_id", "url", "title", "price", "price_amount", "price_currency", "condition", "availability", "availability_text", "quantity_text", "sold_count_text", "watchers_text", "brand", "gtin13", "description", "image_url", "seller", "seller_url", "seller_positive_feedback", "shipping", "delivery", "returns", "payments", "location", "category", "sold_count", "watchers_count", "rating", "review_count", "seller_feedback_score", "image_urls", "breadcrumbs", "item_specifics", "shipping_cost" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "gtin13": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "seller": { "type": [ "string", "null" ] }, "item_id": { "type": "string" }, "returns": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "delivery": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "payments": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "seller_url": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "breadcrumbs": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ] }, "review_count": { "type": [ "number", "null" ] }, "variation_id": { "type": [ "string", "null" ] }, "quantity_text": { "type": [ "string", "null" ] }, "shipping_cost": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": false } ] }, "watchers_text": { "type": [ "string", "null" ] }, "item_specifics": { "type": "object", "additionalProperties": { "type": "string" } }, "price_currency": { "type": [ "string", "null" ] }, "watchers_count": { "type": [ "number", "null" ] }, "sold_count_text": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "seller_description": { "type": [ "string", "null" ] }, "seller_feedback_score": { "type": [ "number", "null" ] }, "seller_positive_feedback": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-item" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "item_id", "variation_id", "url", "title", "price", "price_amount", "price_currency", "condition", "availability", "availability_text", "quantity_text", "sold_count_text", "watchers_text", "brand", "gtin13", "description", "image_url", "seller", "seller_url", "seller_positive_feedback", "shipping", "delivery", "returns", "payments", "location", "category", "sold_count", "watchers_count", "rating", "review_count", "seller_feedback_score", "image_urls", "breadcrumbs", "item_specifics", "shipping_cost" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "gtin13": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "seller": { "type": [ "string", "null" ] }, "item_id": { "type": "string" }, "returns": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "delivery": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "payments": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "seller_url": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "breadcrumbs": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ] }, "review_count": { "type": [ "number", "null" ] }, "variation_id": { "type": [ "string", "null" ] }, "quantity_text": { "type": [ "string", "null" ] }, "shipping_cost": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": false } ] }, "watchers_text": { "type": [ "string", "null" ] }, "item_specifics": { "type": "object", "additionalProperties": { "type": "string" } }, "price_currency": { "type": [ "string", "null" ] }, "watchers_count": { "type": [ "number", "null" ] }, "sold_count_text": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "seller_description": { "type": [ "string", "null" ] }, "seller_feedback_score": { "type": [ "number", "null" ] }, "seller_positive_feedback": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-item", "task_name": "eBay Item API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "brand": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "gtin13": "sample", "rating": 4.91, "seller": "sample", "item_id": "id-1", "returns": "sample", "category": "sample", "delivery": "sample", "location": "London", "payments": "sample", "shipping": "sample", "condition": "sample", "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "seller_url": "https://example.com/item-1", "sold_count": 1, "breadcrumbs": [ "sample" ], "description": "Sample description 1", "availability": "sample", "price_amount": "180", "review_count": 1, "variation_id": "id-1", "quantity_text": "Sample quantity_text 1", "shipping_cost": null, "watchers_text": "Sample watchers_text 1", "item_specifics": {}, "price_currency": "GBP", "watchers_count": 1, "sold_count_text": "Sample sold_count_text 1", "availability_text": "Sample availability_text 1", "seller_description": "Sample seller_description 1", "seller_feedback_score": 1.5, "seller_positive_feedback": "sample" }, "count": 1, "query": "London", "source": "ebay-item", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "brand": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "gtin13": "sample", "rating": 4.91, "seller": "sample", "item_id": "id-1", "returns": "sample", "category": "sample", "delivery": "sample", "location": "London", "payments": "sample", "shipping": "sample", "condition": "sample", "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "seller_url": "https://example.com/item-1", "sold_count": 1, "breadcrumbs": [ "sample" ], "description": "Sample description 1", "availability": "sample", "price_amount": "180", "review_count": 1, "variation_id": "id-1", "quantity_text": "Sample quantity_text 1", "shipping_cost": null, "watchers_text": "Sample watchers_text 1", "item_specifics": {}, "price_currency": "GBP", "watchers_count": 1, "sold_count_text": "Sample sold_count_text 1", "availability_text": "Sample availability_text 1", "seller_description": "Sample seller_description 1", "seller_feedback_score": 1.5, "seller_positive_feedback": "sample" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "item_id", "variation_id", "url", "title", "price", "price_amount", "price_currency", "condition", "availability", "availability_text", "quantity_text", "sold_count_text", "watchers_text", "brand", "gtin13", "description", "image_url", "seller", "seller_url", "seller_positive_feedback", "shipping", "delivery", "returns", "payments", "location", "category", "sold_count", "watchers_count", "rating", "review_count", "seller_feedback_score", "image_urls", "breadcrumbs", "item_specifics", "shipping_cost" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "gtin13": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "seller": { "type": [ "string", "null" ] }, "item_id": { "type": "string" }, "returns": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "delivery": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "payments": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "seller_url": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "breadcrumbs": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ] }, "review_count": { "type": [ "number", "null" ] }, "variation_id": { "type": [ "string", "null" ] }, "quantity_text": { "type": [ "string", "null" ] }, "shipping_cost": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": false } ] }, "watchers_text": { "type": [ "string", "null" ] }, "item_specifics": { "type": "object", "additionalProperties": { "type": "string" } }, "price_currency": { "type": [ "string", "null" ] }, "watchers_count": { "type": [ "number", "null" ] }, "sold_count_text": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "seller_description": { "type": [ "string", "null" ] }, "seller_feedback_score": { "type": [ "number", "null" ] }, "seller_positive_feedback": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-item" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "item_id", "variation_id", "url", "title", "price", "price_amount", "price_currency", "condition", "availability", "availability_text", "quantity_text", "sold_count_text", "watchers_text", "brand", "gtin13", "description", "image_url", "seller", "seller_url", "seller_positive_feedback", "shipping", "delivery", "returns", "payments", "location", "category", "sold_count", "watchers_count", "rating", "review_count", "seller_feedback_score", "image_urls", "breadcrumbs", "item_specifics", "shipping_cost" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "gtin13": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "seller": { "type": [ "string", "null" ] }, "item_id": { "type": "string" }, "returns": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "delivery": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "payments": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "seller_url": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "breadcrumbs": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ] }, "review_count": { "type": [ "number", "null" ] }, "variation_id": { "type": [ "string", "null" ] }, "quantity_text": { "type": [ "string", "null" ] }, "shipping_cost": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": false } ] }, "watchers_text": { "type": [ "string", "null" ] }, "item_specifics": { "type": "object", "additionalProperties": { "type": "string" } }, "price_currency": { "type": [ "string", "null" ] }, "watchers_count": { "type": [ "number", "null" ] }, "sold_count_text": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "seller_description": { "type": [ "string", "null" ] }, "seller_feedback_score": { "type": [ "number", "null" ] }, "seller_positive_feedback": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-item", "task_name": "eBay Item API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEbayItemCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^(?:[0-9]{8,20}|(?:www-)?ebay-com-itm-(?:[a-zA-Z0-9-]+-)?[0-9]{8,20})$", "description": "Numeric eBay item id returned by search. Older Browsable item ids remain supported." }, "url": { "type": "string", "pattern": "^https://(?:www\\.)?ebay\\.com/itm/(?:[^/?#]+/)?[0-9]{8,20}/?(?:[?#].*)?$", "x-sample": "https://www.ebay.com/itm/389640259363", "maxLength": 2000, "minLength": 1, "description": "HTTPS ebay.com item URL returned by search." }, "marketplace": { "enum": [ "ebay.com" ], "type": "string", "description": "Public endpoints currently support ebay.com." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://www.ebay.com/itm/389640259363" } } } }, "x-browsable-website-login-required": false } }, "/v1/ebay/item": { "post": { "tags": [ "eBay" ], "summary": "eBay Item API", "description": "Read the exact public ebay.com listing by item URL or id, including displayed price, condition, images and seller feedback. Listing sold counters are not a transaction history. eBay may restrict anonymous access.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "item_id", "variation_id", "url", "title", "price", "price_amount", "price_currency", "condition", "availability", "availability_text", "quantity_text", "sold_count_text", "watchers_text", "brand", "gtin13", "description", "image_url", "seller", "seller_url", "seller_positive_feedback", "shipping", "delivery", "returns", "payments", "location", "category", "sold_count", "watchers_count", "rating", "review_count", "seller_feedback_score", "image_urls", "breadcrumbs", "item_specifics", "shipping_cost" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "gtin13": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "seller": { "type": [ "string", "null" ] }, "item_id": { "type": "string" }, "returns": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "delivery": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "payments": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "seller_url": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "breadcrumbs": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ] }, "review_count": { "type": [ "number", "null" ] }, "variation_id": { "type": [ "string", "null" ] }, "quantity_text": { "type": [ "string", "null" ] }, "shipping_cost": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": false } ] }, "watchers_text": { "type": [ "string", "null" ] }, "item_specifics": { "type": "object", "additionalProperties": { "type": "string" } }, "price_currency": { "type": [ "string", "null" ] }, "watchers_count": { "type": [ "number", "null" ] }, "sold_count_text": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "seller_description": { "type": [ "string", "null" ] }, "seller_feedback_score": { "type": [ "number", "null" ] }, "seller_positive_feedback": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-item" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "item_id", "variation_id", "url", "title", "price", "price_amount", "price_currency", "condition", "availability", "availability_text", "quantity_text", "sold_count_text", "watchers_text", "brand", "gtin13", "description", "image_url", "seller", "seller_url", "seller_positive_feedback", "shipping", "delivery", "returns", "payments", "location", "category", "sold_count", "watchers_count", "rating", "review_count", "seller_feedback_score", "image_urls", "breadcrumbs", "item_specifics", "shipping_cost" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "gtin13": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "seller": { "type": [ "string", "null" ] }, "item_id": { "type": "string" }, "returns": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "delivery": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "payments": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "seller_url": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "breadcrumbs": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ] }, "review_count": { "type": [ "number", "null" ] }, "variation_id": { "type": [ "string", "null" ] }, "quantity_text": { "type": [ "string", "null" ] }, "shipping_cost": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": false } ] }, "watchers_text": { "type": [ "string", "null" ] }, "item_specifics": { "type": "object", "additionalProperties": { "type": "string" } }, "price_currency": { "type": [ "string", "null" ] }, "watchers_count": { "type": [ "number", "null" ] }, "sold_count_text": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "seller_description": { "type": [ "string", "null" ] }, "seller_feedback_score": { "type": [ "number", "null" ] }, "seller_positive_feedback": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-item", "task_name": "eBay Item API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "brand": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "gtin13": "sample", "rating": 4.91, "seller": "sample", "item_id": "id-1", "returns": "sample", "category": "sample", "delivery": "sample", "location": "London", "payments": "sample", "shipping": "sample", "condition": "sample", "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "seller_url": "https://example.com/item-1", "sold_count": 1, "breadcrumbs": [ "sample" ], "description": "Sample description 1", "availability": "sample", "price_amount": "180", "review_count": 1, "variation_id": "id-1", "quantity_text": "Sample quantity_text 1", "shipping_cost": null, "watchers_text": "Sample watchers_text 1", "item_specifics": {}, "price_currency": "GBP", "watchers_count": 1, "sold_count_text": "Sample sold_count_text 1", "availability_text": "Sample availability_text 1", "seller_description": "Sample seller_description 1", "seller_feedback_score": 1.5, "seller_positive_feedback": "sample" }, "count": 1, "query": "London", "source": "ebay-item", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "brand": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "gtin13": "sample", "rating": 4.91, "seller": "sample", "item_id": "id-1", "returns": "sample", "category": "sample", "delivery": "sample", "location": "London", "payments": "sample", "shipping": "sample", "condition": "sample", "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "seller_url": "https://example.com/item-1", "sold_count": 1, "breadcrumbs": [ "sample" ], "description": "Sample description 1", "availability": "sample", "price_amount": "180", "review_count": 1, "variation_id": "id-1", "quantity_text": "Sample quantity_text 1", "shipping_cost": null, "watchers_text": "Sample watchers_text 1", "item_specifics": {}, "price_currency": "GBP", "watchers_count": 1, "sold_count_text": "Sample sold_count_text 1", "availability_text": "Sample availability_text 1", "seller_description": "Sample seller_description 1", "seller_feedback_score": 1.5, "seller_positive_feedback": "sample" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "item_id", "variation_id", "url", "title", "price", "price_amount", "price_currency", "condition", "availability", "availability_text", "quantity_text", "sold_count_text", "watchers_text", "brand", "gtin13", "description", "image_url", "seller", "seller_url", "seller_positive_feedback", "shipping", "delivery", "returns", "payments", "location", "category", "sold_count", "watchers_count", "rating", "review_count", "seller_feedback_score", "image_urls", "breadcrumbs", "item_specifics", "shipping_cost" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "gtin13": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "seller": { "type": [ "string", "null" ] }, "item_id": { "type": "string" }, "returns": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "delivery": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "payments": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "seller_url": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "breadcrumbs": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ] }, "review_count": { "type": [ "number", "null" ] }, "variation_id": { "type": [ "string", "null" ] }, "quantity_text": { "type": [ "string", "null" ] }, "shipping_cost": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": false } ] }, "watchers_text": { "type": [ "string", "null" ] }, "item_specifics": { "type": "object", "additionalProperties": { "type": "string" } }, "price_currency": { "type": [ "string", "null" ] }, "watchers_count": { "type": [ "number", "null" ] }, "sold_count_text": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "seller_description": { "type": [ "string", "null" ] }, "seller_feedback_score": { "type": [ "number", "null" ] }, "seller_positive_feedback": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-item" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "item_id", "variation_id", "url", "title", "price", "price_amount", "price_currency", "condition", "availability", "availability_text", "quantity_text", "sold_count_text", "watchers_text", "brand", "gtin13", "description", "image_url", "seller", "seller_url", "seller_positive_feedback", "shipping", "delivery", "returns", "payments", "location", "category", "sold_count", "watchers_count", "rating", "review_count", "seller_feedback_score", "image_urls", "breadcrumbs", "item_specifics", "shipping_cost" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "gtin13": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] }, "seller": { "type": [ "string", "null" ] }, "item_id": { "type": "string" }, "returns": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "delivery": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "payments": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "seller_url": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "breadcrumbs": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] }, "price_amount": { "type": [ "string", "null" ] }, "review_count": { "type": [ "number", "null" ] }, "variation_id": { "type": [ "string", "null" ] }, "quantity_text": { "type": [ "string", "null" ] }, "shipping_cost": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] } }, "additionalProperties": false } ] }, "watchers_text": { "type": [ "string", "null" ] }, "item_specifics": { "type": "object", "additionalProperties": { "type": "string" } }, "price_currency": { "type": [ "string", "null" ] }, "watchers_count": { "type": [ "number", "null" ] }, "sold_count_text": { "type": [ "string", "null" ] }, "availability_text": { "type": [ "string", "null" ] }, "seller_description": { "type": [ "string", "null" ] }, "seller_feedback_score": { "type": [ "number", "null" ] }, "seller_positive_feedback": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-item", "task_name": "eBay Item API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEbayItemAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^(?:[0-9]{8,20}|(?:www-)?ebay-com-itm-(?:[a-zA-Z0-9-]+-)?[0-9]{8,20})$", "description": "Numeric eBay item id returned by search. Older Browsable item ids remain supported." }, "url": { "type": "string", "pattern": "^https://(?:www\\.)?ebay\\.com/itm/(?:[^/?#]+/)?[0-9]{8,20}/?(?:[?#].*)?$", "x-sample": "https://www.ebay.com/itm/389640259363", "maxLength": 2000, "minLength": 1, "description": "HTTPS ebay.com item URL returned by search." }, "marketplace": { "enum": [ "ebay.com" ], "type": "string", "description": "Public endpoints currently support ebay.com." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://www.ebay.com/itm/389640259363" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-ebay-item" }, "x-browsable-website-login-required": false } }, "/v1/tasks/ebay-search/runs": { "post": { "tags": [ "eBay" ], "summary": "eBay Search API", "description": "Search public active ebay.com listings, including displayed prices and seller feedback when available. Does not search sold/completed listings. eBay may restrict anonymous access.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace" ], "properties": { "marketplace": { "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "url", "rating", "summary", "image_url", "price", "condition", "shipping", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "string", "null" ] }, "seller": { "type": "object", "required": [ "username", "feedback_count", "positive_feedback_percent" ], "properties": { "username": { "type": [ "string", "null" ] }, "feedback_count": { "type": [ "number", "null" ] }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "summary": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-search", "task_name": "eBay Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "marketplace": "sample" }, "count": 1, "query": "London", "source": "ebay-search", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": "sample", "seller": { "username": "Stylish Shoreditch Loft with Balcony", "feedback_count": 1, "positive_feedback_percent": 1.5 }, "summary": "Sample summary 1", "shipping": "sample", "condition": "sample", "image_url": "https://example.com/item-1" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace" ], "properties": { "marketplace": { "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "url", "rating", "summary", "image_url", "price", "condition", "shipping", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "string", "null" ] }, "seller": { "type": "object", "required": [ "username", "feedback_count", "positive_feedback_percent" ], "properties": { "username": { "type": [ "string", "null" ] }, "feedback_count": { "type": [ "number", "null" ] }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "summary": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-search", "task_name": "eBay Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEbaySearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 10000, "minimum": 1, "description": "Starting page; omit when continuing with a cursor." }, "sort": { "enum": [ "best_match", "newest", "price_low", "price_high", "ending_soon" ], "type": "string", "description": "Sort order. Choose an allowed value below." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "query": { "type": "string", "pattern": "\\S", "x-sample": "iphone 13", "maxLength": 500, "minLength": 1, "description": "Search text." }, "cursor": { "type": "string", "pattern": "^(?:[0-9]+|[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]{43})$", "maxLength": 131072, "description": "next_cursor from the previous response. Keep query, marketplace and limit unchanged. Expires after 30 minutes." }, "condition": { "enum": [ "new", "used", "for_parts" ], "type": "string", "description": "Listing condition. for_parts selects For parts or not working." }, "max_price": { "type": "number", "maximum": 1000000000, "minimum": 0, "description": "Maximum displayed listing price in USD." }, "min_price": { "type": "number", "maximum": 1000000000, "minimum": 0, "description": "Minimum displayed listing price in USD." }, "category_id": { "type": "string", "pattern": "^[0-9]{1,12}$", "x-advanced": true, "description": "Numeric eBay category id, such as 9355 for cell phones." }, "marketplace": { "enum": [ "ebay.com" ], "type": "string", "default": "ebay.com", "description": "Public endpoints currently support ebay.com." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "iphone 13" } } } }, "x-browsable-website-login-required": false } }, "/v1/ebay/search": { "post": { "tags": [ "eBay" ], "summary": "eBay Search API", "description": "Search public active ebay.com listings, including displayed prices and seller feedback when available. Does not search sold/completed listings. eBay may restrict anonymous access.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace" ], "properties": { "marketplace": { "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "url", "rating", "summary", "image_url", "price", "condition", "shipping", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "string", "null" ] }, "seller": { "type": "object", "required": [ "username", "feedback_count", "positive_feedback_percent" ], "properties": { "username": { "type": [ "string", "null" ] }, "feedback_count": { "type": [ "number", "null" ] }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "summary": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-search", "task_name": "eBay Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "marketplace": "sample" }, "count": 1, "query": "London", "source": "ebay-search", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": "sample", "seller": { "username": "Stylish Shoreditch Loft with Balcony", "feedback_count": 1, "positive_feedback_percent": 1.5 }, "summary": "Sample summary 1", "shipping": "sample", "condition": "sample", "image_url": "https://example.com/item-1" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace" ], "properties": { "marketplace": { "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "url", "rating", "summary", "image_url", "price", "condition", "shipping", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "string", "null" ] }, "seller": { "type": "object", "required": [ "username", "feedback_count", "positive_feedback_percent" ], "properties": { "username": { "type": [ "string", "null" ] }, "feedback_count": { "type": [ "number", "null" ] }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "summary": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-search", "task_name": "eBay Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEbaySearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "maximum": 10000, "minimum": 1, "description": "Starting page; omit when continuing with a cursor." }, "sort": { "enum": [ "best_match", "newest", "price_low", "price_high", "ending_soon" ], "type": "string", "description": "Sort order. Choose an allowed value below." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results in this response." }, "query": { "type": "string", "pattern": "\\S", "x-sample": "iphone 13", "maxLength": 500, "minLength": 1, "description": "Search text." }, "cursor": { "type": "string", "pattern": "^(?:[0-9]+|[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]{43})$", "maxLength": 131072, "description": "next_cursor from the previous response. Keep query, marketplace and limit unchanged. Expires after 30 minutes." }, "condition": { "enum": [ "new", "used", "for_parts" ], "type": "string", "description": "Listing condition. for_parts selects For parts or not working." }, "max_price": { "type": "number", "maximum": 1000000000, "minimum": 0, "description": "Maximum displayed listing price in USD." }, "min_price": { "type": "number", "maximum": 1000000000, "minimum": 0, "description": "Minimum displayed listing price in USD." }, "category_id": { "type": "string", "pattern": "^[0-9]{1,12}$", "x-advanced": true, "description": "Numeric eBay category id, such as 9355 for cell phones." }, "marketplace": { "enum": [ "ebay.com" ], "type": "string", "default": "ebay.com", "description": "Public endpoints currently support ebay.com." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "iphone 13" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-ebay-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/ebay-seller/runs": { "post": { "tags": [ "eBay" ], "summary": "eBay Seller API", "description": "Read an ebay.com seller's public feedback score, positive percentage, registration date, rating counts and detailed seller ratings. No website login required; eBay may restrict anonymous access.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "username", "url", "feedback_score", "positive_feedback_percent", "member_since", "country", "top_rated", "feedback_ratings", "detailed_ratings" ], "properties": { "url": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "top_rated": { "type": [ "boolean", "null" ] }, "member_since": { "type": [ "string", "null" ] }, "feedback_score": { "type": [ "number", "null" ] }, "detailed_ratings": { "type": "array", "items": { "type": "object", "required": [ "label", "rating", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "feedback_ratings": { "type": "array", "items": { "type": "object", "required": [ "rating", "one_month", "six_months", "twelve_months" ], "properties": { "rating": { "type": [ "string", "null" ] }, "one_month": { "type": [ "number", "null" ] }, "six_months": { "type": [ "number", "null" ] }, "twelve_months": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-seller" }, "results": { "type": "array", "items": { "type": "object", "required": [ "username", "url", "feedback_score", "positive_feedback_percent", "member_since", "country", "top_rated", "feedback_ratings", "detailed_ratings" ], "properties": { "url": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "top_rated": { "type": [ "boolean", "null" ] }, "member_since": { "type": [ "string", "null" ] }, "feedback_score": { "type": [ "number", "null" ] }, "detailed_ratings": { "type": "array", "items": { "type": "object", "required": [ "label", "rating", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "feedback_ratings": { "type": "array", "items": { "type": "object", "required": [ "rating", "one_month", "six_months", "twelve_months" ], "properties": { "rating": { "type": [ "string", "null" ] }, "one_month": { "type": [ "number", "null" ] }, "six_months": { "type": [ "number", "null" ] }, "twelve_months": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-seller", "task_name": "eBay Seller API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "url": "https://example.com/item-1", "country": "London", "username": "Stylish Shoreditch Loft with Balcony", "top_rated": true, "member_since": "sample", "feedback_score": 1.5, "detailed_ratings": [ { "count": 1, "label": "Stylish Shoreditch Loft with Balcony", "rating": 4.91 } ], "feedback_ratings": [ { "rating": "sample", "one_month": 1.5, "six_months": 1.5, "twelve_months": 1.5 } ], "positive_feedback_percent": 1.5 }, "count": 1, "query": "London", "source": "ebay-seller", "results": [ { "url": "https://example.com/item-1", "country": "London", "username": "Stylish Shoreditch Loft with Balcony", "top_rated": true, "member_since": "sample", "feedback_score": 1.5, "detailed_ratings": [ { "count": 1, "label": "Stylish Shoreditch Loft with Balcony", "rating": 4.91 } ], "feedback_ratings": [ { "rating": "sample", "one_month": 1.5, "six_months": 1.5, "twelve_months": 1.5 } ], "positive_feedback_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "username", "url", "feedback_score", "positive_feedback_percent", "member_since", "country", "top_rated", "feedback_ratings", "detailed_ratings" ], "properties": { "url": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "top_rated": { "type": [ "boolean", "null" ] }, "member_since": { "type": [ "string", "null" ] }, "feedback_score": { "type": [ "number", "null" ] }, "detailed_ratings": { "type": "array", "items": { "type": "object", "required": [ "label", "rating", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "feedback_ratings": { "type": "array", "items": { "type": "object", "required": [ "rating", "one_month", "six_months", "twelve_months" ], "properties": { "rating": { "type": [ "string", "null" ] }, "one_month": { "type": [ "number", "null" ] }, "six_months": { "type": [ "number", "null" ] }, "twelve_months": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-seller" }, "results": { "type": "array", "items": { "type": "object", "required": [ "username", "url", "feedback_score", "positive_feedback_percent", "member_since", "country", "top_rated", "feedback_ratings", "detailed_ratings" ], "properties": { "url": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "top_rated": { "type": [ "boolean", "null" ] }, "member_since": { "type": [ "string", "null" ] }, "feedback_score": { "type": [ "number", "null" ] }, "detailed_ratings": { "type": "array", "items": { "type": "object", "required": [ "label", "rating", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "feedback_ratings": { "type": "array", "items": { "type": "object", "required": [ "rating", "one_month", "six_months", "twelve_months" ], "properties": { "rating": { "type": [ "string", "null" ] }, "one_month": { "type": [ "number", "null" ] }, "six_months": { "type": [ "number", "null" ] }, "twelve_months": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-seller", "task_name": "eBay Seller API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEbaySellerCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "pattern": "^https://(?:www\\.)?ebay\\.com/(?:usr|fdbk/feedback_profile)/[a-zA-Z0-9_.-]{1,64}/?(?:[?#].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public page URL." }, "username": { "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-sample": "sarahcell", "maxLength": 2000, "minLength": 1, "description": "Public username, without a profile URL." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "username" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.ebay.com/usr/example-seller" } } } }, "x-browsable-website-login-required": false } }, "/v1/ebay/seller": { "post": { "tags": [ "eBay" ], "summary": "eBay Seller API", "description": "Read an ebay.com seller's public feedback score, positive percentage, registration date, rating counts and detailed seller ratings. No website login required; eBay may restrict anonymous access.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "username", "url", "feedback_score", "positive_feedback_percent", "member_since", "country", "top_rated", "feedback_ratings", "detailed_ratings" ], "properties": { "url": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "top_rated": { "type": [ "boolean", "null" ] }, "member_since": { "type": [ "string", "null" ] }, "feedback_score": { "type": [ "number", "null" ] }, "detailed_ratings": { "type": "array", "items": { "type": "object", "required": [ "label", "rating", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "feedback_ratings": { "type": "array", "items": { "type": "object", "required": [ "rating", "one_month", "six_months", "twelve_months" ], "properties": { "rating": { "type": [ "string", "null" ] }, "one_month": { "type": [ "number", "null" ] }, "six_months": { "type": [ "number", "null" ] }, "twelve_months": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-seller" }, "results": { "type": "array", "items": { "type": "object", "required": [ "username", "url", "feedback_score", "positive_feedback_percent", "member_since", "country", "top_rated", "feedback_ratings", "detailed_ratings" ], "properties": { "url": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "top_rated": { "type": [ "boolean", "null" ] }, "member_since": { "type": [ "string", "null" ] }, "feedback_score": { "type": [ "number", "null" ] }, "detailed_ratings": { "type": "array", "items": { "type": "object", "required": [ "label", "rating", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "feedback_ratings": { "type": "array", "items": { "type": "object", "required": [ "rating", "one_month", "six_months", "twelve_months" ], "properties": { "rating": { "type": [ "string", "null" ] }, "one_month": { "type": [ "number", "null" ] }, "six_months": { "type": [ "number", "null" ] }, "twelve_months": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-seller", "task_name": "eBay Seller API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "url": "https://example.com/item-1", "country": "London", "username": "Stylish Shoreditch Loft with Balcony", "top_rated": true, "member_since": "sample", "feedback_score": 1.5, "detailed_ratings": [ { "count": 1, "label": "Stylish Shoreditch Loft with Balcony", "rating": 4.91 } ], "feedback_ratings": [ { "rating": "sample", "one_month": 1.5, "six_months": 1.5, "twelve_months": 1.5 } ], "positive_feedback_percent": 1.5 }, "count": 1, "query": "London", "source": "ebay-seller", "results": [ { "url": "https://example.com/item-1", "country": "London", "username": "Stylish Shoreditch Loft with Balcony", "top_rated": true, "member_since": "sample", "feedback_score": 1.5, "detailed_ratings": [ { "count": 1, "label": "Stylish Shoreditch Loft with Balcony", "rating": 4.91 } ], "feedback_ratings": [ { "rating": "sample", "one_month": 1.5, "six_months": 1.5, "twelve_months": 1.5 } ], "positive_feedback_percent": 1.5 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "username", "url", "feedback_score", "positive_feedback_percent", "member_since", "country", "top_rated", "feedback_ratings", "detailed_ratings" ], "properties": { "url": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "top_rated": { "type": [ "boolean", "null" ] }, "member_since": { "type": [ "string", "null" ] }, "feedback_score": { "type": [ "number", "null" ] }, "detailed_ratings": { "type": "array", "items": { "type": "object", "required": [ "label", "rating", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "feedback_ratings": { "type": "array", "items": { "type": "object", "required": [ "rating", "one_month", "six_months", "twelve_months" ], "properties": { "rating": { "type": [ "string", "null" ] }, "one_month": { "type": [ "number", "null" ] }, "six_months": { "type": [ "number", "null" ] }, "twelve_months": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-seller" }, "results": { "type": "array", "items": { "type": "object", "required": [ "username", "url", "feedback_score", "positive_feedback_percent", "member_since", "country", "top_rated", "feedback_ratings", "detailed_ratings" ], "properties": { "url": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "top_rated": { "type": [ "boolean", "null" ] }, "member_since": { "type": [ "string", "null" ] }, "feedback_score": { "type": [ "number", "null" ] }, "detailed_ratings": { "type": "array", "items": { "type": "object", "required": [ "label", "rating", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "feedback_ratings": { "type": "array", "items": { "type": "object", "required": [ "rating", "one_month", "six_months", "twelve_months" ], "properties": { "rating": { "type": [ "string", "null" ] }, "one_month": { "type": [ "number", "null" ] }, "six_months": { "type": [ "number", "null" ] }, "twelve_months": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-seller", "task_name": "eBay Seller API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEbaySellerAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "pattern": "^https://(?:www\\.)?ebay\\.com/(?:usr|fdbk/feedback_profile)/[a-zA-Z0-9_.-]{1,64}/?(?:[?#].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public page URL." }, "username": { "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-sample": "sarahcell", "maxLength": 2000, "minLength": 1, "description": "Public username, without a profile URL." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "username" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.ebay.com/usr/example-seller" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-ebay-seller" }, "x-browsable-website-login-required": false } }, "/v1/tasks/ebay-seller-feedback/runs": { "post": { "tags": [ "eBay" ], "summary": "eBay Seller Feedback API", "description": "Read paginated feedback received as an ebay.com seller, including comments, rating, displayed date, item reference and available seller replies. Supports positive, neutral or negative feedback filters; filtered pages may contain fewer results, so follow next_cursor even when count is zero. Feedback prices are displayed references, not a sold-listings price history.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "seller" ], "properties": { "seller": { "type": "object", "required": [ "username", "url", "feedback_score", "positive_feedback_percent", "member_since", "country", "top_rated", "feedback_ratings", "detailed_ratings" ], "properties": { "url": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "top_rated": { "type": [ "boolean", "null" ] }, "member_since": { "type": [ "string", "null" ] }, "feedback_score": { "type": [ "number", "null" ] }, "detailed_ratings": { "type": "array", "items": { "type": "object", "required": [ "label", "rating", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "feedback_ratings": { "type": "array", "items": { "type": "object", "required": [ "rating", "one_month", "six_months", "twelve_months" ], "properties": { "rating": { "type": [ "string", "null" ] }, "one_month": { "type": [ "number", "null" ] }, "six_months": { "type": [ "number", "null" ] }, "twelve_months": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-seller-feedback" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "rating", "comment", "item_id", "item_title", "item_url", "buyer", "price", "when", "verified_purchase", "automated", "seller_response" ], "properties": { "id": { "type": "string" }, "when": { "type": [ "string", "null" ] }, "buyer": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "rating": { "enum": [ "positive", "neutral", "negative", null ] }, "comment": { "type": [ "string", "null" ] }, "item_id": { "type": [ "string", "null" ] }, "item_url": { "type": [ "string", "null" ] }, "automated": { "type": "boolean" }, "item_title": { "type": [ "string", "null" ] }, "seller_response": { "type": [ "string", "null" ] }, "verified_purchase": { "type": "boolean" } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-seller-feedback", "task_name": "eBay Seller Feedback API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "seller": { "url": "https://example.com/item-1", "country": "London", "username": "Stylish Shoreditch Loft with Balcony", "top_rated": true, "member_since": "sample", "feedback_score": 1.5, "detailed_ratings": [ { "count": 1, "label": "Stylish Shoreditch Loft with Balcony", "rating": 4.91 } ], "feedback_ratings": [ { "rating": "sample", "one_month": 1.5, "six_months": 1.5, "twelve_months": 1.5 } ], "positive_feedback_percent": 1.5 } }, "count": 1, "query": "London", "source": "ebay-seller-feedback", "results": [ { "id": "id-1", "when": "sample", "buyer": "sample", "price": "180", "rating": "positive", "comment": "sample", "item_id": "id-1", "item_url": "https://example.com/item-1", "automated": true, "item_title": "Stylish Shoreditch Loft with Balcony", "seller_response": "sample", "verified_purchase": true } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "seller" ], "properties": { "seller": { "type": "object", "required": [ "username", "url", "feedback_score", "positive_feedback_percent", "member_since", "country", "top_rated", "feedback_ratings", "detailed_ratings" ], "properties": { "url": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "top_rated": { "type": [ "boolean", "null" ] }, "member_since": { "type": [ "string", "null" ] }, "feedback_score": { "type": [ "number", "null" ] }, "detailed_ratings": { "type": "array", "items": { "type": "object", "required": [ "label", "rating", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "feedback_ratings": { "type": "array", "items": { "type": "object", "required": [ "rating", "one_month", "six_months", "twelve_months" ], "properties": { "rating": { "type": [ "string", "null" ] }, "one_month": { "type": [ "number", "null" ] }, "six_months": { "type": [ "number", "null" ] }, "twelve_months": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-seller-feedback" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "rating", "comment", "item_id", "item_title", "item_url", "buyer", "price", "when", "verified_purchase", "automated", "seller_response" ], "properties": { "id": { "type": "string" }, "when": { "type": [ "string", "null" ] }, "buyer": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "rating": { "enum": [ "positive", "neutral", "negative", null ] }, "comment": { "type": [ "string", "null" ] }, "item_id": { "type": [ "string", "null" ] }, "item_url": { "type": [ "string", "null" ] }, "automated": { "type": "boolean" }, "item_title": { "type": [ "string", "null" ] }, "seller_response": { "type": [ "string", "null" ] }, "verified_purchase": { "type": "boolean" } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-seller-feedback", "task_name": "eBay Seller Feedback API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEbaySellerFeedbackCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "pattern": "^https://(?:www\\.)?ebay\\.com/(?:usr|fdbk/feedback_profile)/[a-zA-Z0-9_.-]{1,64}/?(?:[?#].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public page URL." }, "sort": { "enum": [ "recent", "relevant" ], "type": "string", "default": "recent", "description": "Sort order. Choose an allowed value below." }, "limit": { "type": "integer", "default": 25, "maximum": 50, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from the previous response. Keep all other inputs unchanged. Expires after 30 minutes." }, "rating": { "enum": [ "all", "positive", "neutral", "negative" ], "type": "string", "default": "all", "description": "Filter by the allowed feedback rating below." }, "username": { "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-sample": "sarahcell", "maxLength": 2000, "minLength": 1, "description": "Public username, without a profile URL." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "username" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.ebay.com/usr/example-seller" } } } }, "x-browsable-website-login-required": false } }, "/v1/ebay/seller-feedback": { "post": { "tags": [ "eBay" ], "summary": "eBay Seller Feedback API", "description": "Read paginated feedback received as an ebay.com seller, including comments, rating, displayed date, item reference and available seller replies. Supports positive, neutral or negative feedback filters; filtered pages may contain fewer results, so follow next_cursor even when count is zero. Feedback prices are displayed references, not a sold-listings price history.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "seller" ], "properties": { "seller": { "type": "object", "required": [ "username", "url", "feedback_score", "positive_feedback_percent", "member_since", "country", "top_rated", "feedback_ratings", "detailed_ratings" ], "properties": { "url": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "top_rated": { "type": [ "boolean", "null" ] }, "member_since": { "type": [ "string", "null" ] }, "feedback_score": { "type": [ "number", "null" ] }, "detailed_ratings": { "type": "array", "items": { "type": "object", "required": [ "label", "rating", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "feedback_ratings": { "type": "array", "items": { "type": "object", "required": [ "rating", "one_month", "six_months", "twelve_months" ], "properties": { "rating": { "type": [ "string", "null" ] }, "one_month": { "type": [ "number", "null" ] }, "six_months": { "type": [ "number", "null" ] }, "twelve_months": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-seller-feedback" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "rating", "comment", "item_id", "item_title", "item_url", "buyer", "price", "when", "verified_purchase", "automated", "seller_response" ], "properties": { "id": { "type": "string" }, "when": { "type": [ "string", "null" ] }, "buyer": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "rating": { "enum": [ "positive", "neutral", "negative", null ] }, "comment": { "type": [ "string", "null" ] }, "item_id": { "type": [ "string", "null" ] }, "item_url": { "type": [ "string", "null" ] }, "automated": { "type": "boolean" }, "item_title": { "type": [ "string", "null" ] }, "seller_response": { "type": [ "string", "null" ] }, "verified_purchase": { "type": "boolean" } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-seller-feedback", "task_name": "eBay Seller Feedback API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "seller": { "url": "https://example.com/item-1", "country": "London", "username": "Stylish Shoreditch Loft with Balcony", "top_rated": true, "member_since": "sample", "feedback_score": 1.5, "detailed_ratings": [ { "count": 1, "label": "Stylish Shoreditch Loft with Balcony", "rating": 4.91 } ], "feedback_ratings": [ { "rating": "sample", "one_month": 1.5, "six_months": 1.5, "twelve_months": 1.5 } ], "positive_feedback_percent": 1.5 } }, "count": 1, "query": "London", "source": "ebay-seller-feedback", "results": [ { "id": "id-1", "when": "sample", "buyer": "sample", "price": "180", "rating": "positive", "comment": "sample", "item_id": "id-1", "item_url": "https://example.com/item-1", "automated": true, "item_title": "Stylish Shoreditch Loft with Balcony", "seller_response": "sample", "verified_purchase": true } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "seller" ], "properties": { "seller": { "type": "object", "required": [ "username", "url", "feedback_score", "positive_feedback_percent", "member_since", "country", "top_rated", "feedback_ratings", "detailed_ratings" ], "properties": { "url": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "username": { "type": [ "string", "null" ] }, "top_rated": { "type": [ "boolean", "null" ] }, "member_since": { "type": [ "string", "null" ] }, "feedback_score": { "type": [ "number", "null" ] }, "detailed_ratings": { "type": "array", "items": { "type": "object", "required": [ "label", "rating", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] }, "rating": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "feedback_ratings": { "type": "array", "items": { "type": "object", "required": [ "rating", "one_month", "six_months", "twelve_months" ], "properties": { "rating": { "type": [ "string", "null" ] }, "one_month": { "type": [ "number", "null" ] }, "six_months": { "type": [ "number", "null" ] }, "twelve_months": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-seller-feedback" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "rating", "comment", "item_id", "item_title", "item_url", "buyer", "price", "when", "verified_purchase", "automated", "seller_response" ], "properties": { "id": { "type": "string" }, "when": { "type": [ "string", "null" ] }, "buyer": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "rating": { "enum": [ "positive", "neutral", "negative", null ] }, "comment": { "type": [ "string", "null" ] }, "item_id": { "type": [ "string", "null" ] }, "item_url": { "type": [ "string", "null" ] }, "automated": { "type": "boolean" }, "item_title": { "type": [ "string", "null" ] }, "seller_response": { "type": [ "string", "null" ] }, "verified_purchase": { "type": "boolean" } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-seller-feedback", "task_name": "eBay Seller Feedback API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEbaySellerFeedbackAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "pattern": "^https://(?:www\\.)?ebay\\.com/(?:usr|fdbk/feedback_profile)/[a-zA-Z0-9_.-]{1,64}/?(?:[?#].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public page URL." }, "sort": { "enum": [ "recent", "relevant" ], "type": "string", "default": "recent", "description": "Sort order. Choose an allowed value below." }, "limit": { "type": "integer", "default": 25, "maximum": 50, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from the previous response. Keep all other inputs unchanged. Expires after 30 minutes." }, "rating": { "enum": [ "all", "positive", "neutral", "negative" ], "type": "string", "default": "all", "description": "Filter by the allowed feedback rating below." }, "username": { "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-sample": "sarahcell", "maxLength": 2000, "minLength": 1, "description": "Public username, without a profile URL." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "username" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.ebay.com/usr/example-seller" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-ebay-seller-feedback" }, "x-browsable-website-login-required": false } }, "/v1/tasks/ebay-seller-listings/runs": { "post": { "tags": [ "eBay" ], "summary": "eBay Seller Listings API", "description": "Search an ebay.com seller's active listings, optionally filtered by keywords, condition, price and category, with cursor pagination. Does not return sold/completed history.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "username" ], "properties": { "username": { "type": "string" }, "marketplace": { "const": "ebay.com" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-seller-listings" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "url", "rating", "summary", "image_url", "price", "condition", "shipping", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "string", "null" ] }, "seller": { "type": "object", "required": [ "username", "feedback_count", "positive_feedback_percent" ], "properties": { "username": { "type": [ "string", "null" ] }, "feedback_count": { "type": [ "number", "null" ] }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "summary": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-seller-listings", "task_name": "eBay Seller Listings API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "username": "Stylish Shoreditch Loft with Balcony", "marketplace": "ebay.com" }, "count": 1, "query": "London", "source": "ebay-seller-listings", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": "sample", "seller": { "username": "Stylish Shoreditch Loft with Balcony", "feedback_count": 1, "positive_feedback_percent": 1.5 }, "summary": "Sample summary 1", "shipping": "sample", "condition": "sample", "image_url": "https://example.com/item-1" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "username" ], "properties": { "username": { "type": "string" }, "marketplace": { "const": "ebay.com" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-seller-listings" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "url", "rating", "summary", "image_url", "price", "condition", "shipping", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "string", "null" ] }, "seller": { "type": "object", "required": [ "username", "feedback_count", "positive_feedback_percent" ], "properties": { "username": { "type": [ "string", "null" ] }, "feedback_count": { "type": [ "number", "null" ] }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "summary": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-seller-listings", "task_name": "eBay Seller Listings API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEbaySellerListingsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "pattern": "^https://(?:www\\.)?ebay\\.com/(?:usr|fdbk/feedback_profile)/[a-zA-Z0-9_.-]{1,64}/?(?:[?#].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public page URL." }, "sort": { "enum": [ "best_match", "newest", "price_low", "price_high", "ending_soon" ], "type": "string", "description": "Sort order. Choose an allowed value below." }, "limit": { "type": "integer", "default": 25, "maximum": 50, "minimum": 1, "description": "Maximum results in this response." }, "query": { "type": "string", "pattern": "\\S", "maxLength": 500, "minLength": 1, "description": "Search text." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from the previous response. Keep all other inputs unchanged. Expires after 30 minutes." }, "username": { "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-sample": "sarahcell", "maxLength": 2000, "minLength": 1, "description": "Public username, without a profile URL." }, "condition": { "enum": [ "new", "used", "for_parts" ], "type": "string", "description": "Listing condition. for_parts selects For parts or not working." }, "max_price": { "type": "number", "maximum": 1000000000, "minimum": 0, "description": "Maximum displayed listing price in USD." }, "min_price": { "type": "number", "maximum": 1000000000, "minimum": 0, "description": "Minimum displayed listing price in USD." }, "category_id": { "type": "string", "pattern": "^[0-9]{1,12}$", "x-advanced": true, "description": "Numeric eBay category id, such as 9355 for cell phones." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "username" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.ebay.com/usr/example-seller" } } } }, "x-browsable-website-login-required": false } }, "/v1/ebay/seller-listings": { "post": { "tags": [ "eBay" ], "summary": "eBay Seller Listings API", "description": "Search an ebay.com seller's active listings, optionally filtered by keywords, condition, price and category, with cursor pagination. Does not return sold/completed history.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "username" ], "properties": { "username": { "type": "string" }, "marketplace": { "const": "ebay.com" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-seller-listings" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "url", "rating", "summary", "image_url", "price", "condition", "shipping", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "string", "null" ] }, "seller": { "type": "object", "required": [ "username", "feedback_count", "positive_feedback_percent" ], "properties": { "username": { "type": [ "string", "null" ] }, "feedback_count": { "type": [ "number", "null" ] }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "summary": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-seller-listings", "task_name": "eBay Seller Listings API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "username": "Stylish Shoreditch Loft with Balcony", "marketplace": "ebay.com" }, "count": 1, "query": "London", "source": "ebay-seller-listings", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": "sample", "seller": { "username": "Stylish Shoreditch Loft with Balcony", "feedback_count": 1, "positive_feedback_percent": 1.5 }, "summary": "Sample summary 1", "shipping": "sample", "condition": "sample", "image_url": "https://example.com/item-1" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "marketplace", "username" ], "properties": { "username": { "type": "string" }, "marketplace": { "const": "ebay.com" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "ebay-seller-listings" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "url", "rating", "summary", "image_url", "price", "condition", "shipping", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "rating": { "type": [ "string", "null" ] }, "seller": { "type": "object", "required": [ "username", "feedback_count", "positive_feedback_percent" ], "properties": { "username": { "type": [ "string", "null" ] }, "feedback_count": { "type": [ "number", "null" ] }, "positive_feedback_percent": { "type": [ "number", "null" ] } }, "additionalProperties": false }, "summary": { "type": [ "string", "null" ] }, "shipping": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "ebay-seller-listings", "task_name": "eBay Seller Listings API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEbaySellerListingsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "pattern": "^https://(?:www\\.)?ebay\\.com/(?:usr|fdbk/feedback_profile)/[a-zA-Z0-9_.-]{1,64}/?(?:[?#].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public page URL." }, "sort": { "enum": [ "best_match", "newest", "price_low", "price_high", "ending_soon" ], "type": "string", "description": "Sort order. Choose an allowed value below." }, "limit": { "type": "integer", "default": 25, "maximum": 50, "minimum": 1, "description": "Maximum results in this response." }, "query": { "type": "string", "pattern": "\\S", "maxLength": 500, "minLength": 1, "description": "Search text." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from the previous response. Keep all other inputs unchanged. Expires after 30 minutes." }, "username": { "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-sample": "sarahcell", "maxLength": 2000, "minLength": 1, "description": "Public username, without a profile URL." }, "condition": { "enum": [ "new", "used", "for_parts" ], "type": "string", "description": "Listing condition. for_parts selects For parts or not working." }, "max_price": { "type": "number", "maximum": 1000000000, "minimum": 0, "description": "Maximum displayed listing price in USD." }, "min_price": { "type": "number", "maximum": 1000000000, "minimum": 0, "description": "Minimum displayed listing price in USD." }, "category_id": { "type": "string", "pattern": "^[0-9]{1,12}$", "x-advanced": true, "description": "Numeric eBay category id, such as 9355 for cell phones." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "username" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.ebay.com/usr/example-seller" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-ebay-seller-listings" }, "x-browsable-website-login-required": false } }, "/v1/tasks/etsy-listing/runs": { "post": { "tags": [ "Etsy" ], "summary": "Etsy Listing API", "description": "Scrape a public Etsy listing detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "etsy-listing", "task_name": "Etsy Listing API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "etsy-listing", "task_name": "Etsy Listing API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEtsyListingCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Etsy listing URL returned by etsy/search.", "x-placeholder": "e.g. https://www.etsy.com/listing/123456789/handmade-necklace" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.etsy.com/listing/123456789/handmade-necklace" } } } }, "x-browsable-website-login-required": false } }, "/v1/etsy/listing": { "post": { "tags": [ "Etsy" ], "summary": "Etsy Listing API", "description": "Scrape a public Etsy listing detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "etsy-listing", "task_name": "Etsy Listing API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "etsy-listing", "task_name": "Etsy Listing API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEtsyListingAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Etsy listing URL returned by etsy/search.", "x-placeholder": "e.g. https://www.etsy.com/listing/123456789/handmade-necklace" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.etsy.com/listing/123456789/handmade-necklace" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-etsy-listing" }, "x-browsable-website-login-required": false } }, "/v1/tasks/etsy-search/runs": { "post": { "tags": [ "Etsy" ], "summary": "Etsy API", "description": "Scrape public Etsy search result pages by query with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "etsy-search", "task_name": "Etsy API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "etsy-search", "task_name": "Etsy API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEtsySearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "handmade necklace", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. handmade necklace" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "handmade necklace" } } } }, "x-browsable-website-login-required": false } }, "/v1/etsy/search": { "post": { "tags": [ "Etsy" ], "summary": "Etsy API", "description": "Scrape public Etsy search result pages by query with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "etsy-search", "task_name": "Etsy API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "etsy-search", "task_name": "Etsy API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runEtsySearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "handmade necklace", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. handmade necklace" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "handmade necklace" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-etsy-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/facebook-group/runs": { "post": { "tags": [ "Facebook" ], "summary": "Facebook group", "description": "Scrape public metadata and public initial-page posts from a Facebook group URL or group id.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "group", "posts", "count", "max_posts_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "group": { "type": "object", "required": [ "id", "url", "mobile_url", "name", "description", "privacy", "privacy_description", "visibility", "visibility_description", "member_count_text", "member_count", "location", "profile_picture_url", "cover_photo_url", "tabs", "recent_media" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tabs": { "type": "array", "items": { "type": "object", "required": [ "title", "type", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" } }, "additionalProperties": false } }, "privacy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mobile_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "visibility": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "member_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "recent_media": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "url", "image_url", "accessibility_caption" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "cover_photo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "member_count_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "privacy_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "visibility_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "posts": { "type": "array", "items": { "type": "object", "required": [ "id", "post_id", "url", "author_id", "author_name", "author_profile_picture_url", "message", "created_time", "created_at", "reaction_count", "comment_count", "attachments", "comments" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "post_id": { "type": "string" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "legacy_fbid", "url", "message", "author_id", "author_name", "author_profile_picture_url", "created_time", "created_at", "reaction_count", "reply_count" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "legacy_fbid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reply_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "created_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reaction_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "author_profile_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attachments": { "type": "array", "items": { "type": "object", "required": [ "type", "title", "source", "url", "image_url", "description" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reaction_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "author_profile_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "total_available", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "const": "public_page_offset" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_available": { "type": "integer" } }, "additionalProperties": false }, "max_posts_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "facebook-group", "task_name": "Facebook group", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "group": { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "tabs": [ { "url": "https://example.com/item-1", "type": "sample", "title": "Stylish Shoreditch Loft with Balcony" } ], "privacy": "sample", "location": "London", "mobile_url": "https://example.com/item-1", "visibility": "sample", "description": "Sample description 1", "member_count": 1, "recent_media": [ { "id": "id-1", "url": "https://example.com/item-1", "type": "sample", "image_url": "https://example.com/item-1", "accessibility_caption": "sample" } ], "cover_photo_url": "https://images.example.com/cover_photo_url-1.jpg", "member_count_text": "Sample member_count_text 1", "privacy_description": "Sample privacy_description 1", "profile_picture_url": "https://example.com/item-1", "visibility_description": "Sample visibility_description 1" }, "posts": [ { "id": "id-1", "url": "https://example.com/item-1", "message": "sample", "post_id": "id-1", "comments": [ { "id": "id-1", "url": "https://example.com/item-1", "message": "sample", "author_id": "user_1", "created_at": "2026-06-14T15:30:00Z", "author_name": "Stylish Shoreditch Loft with Balcony", "legacy_fbid": "id-1", "reply_count": 1, "created_time": 1.5, "reaction_count": 1, "author_profile_picture_url": "https://example.com/item-1" } ], "author_id": "user_1", "created_at": "2026-06-14T15:30:00Z", "attachments": [ { "url": "https://example.com/item-1", "type": "sample", "title": "Stylish Shoreditch Loft with Balcony", "source": "sample", "image_url": "https://example.com/item-1", "description": "Sample description 1" } ], "author_name": "Stylish Shoreditch Loft with Balcony", "created_time": 1.5, "comment_count": 1, "reaction_count": 1, "author_profile_picture_url": "https://example.com/item-1" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "public_page_offset", "next_cursor": "cursor-page-1", "has_next_page": true, "total_available": 180 }, "max_posts_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "group", "posts", "count", "max_posts_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "group": { "type": "object", "required": [ "id", "url", "mobile_url", "name", "description", "privacy", "privacy_description", "visibility", "visibility_description", "member_count_text", "member_count", "location", "profile_picture_url", "cover_photo_url", "tabs", "recent_media" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tabs": { "type": "array", "items": { "type": "object", "required": [ "title", "type", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" } }, "additionalProperties": false } }, "privacy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mobile_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "visibility": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "member_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "recent_media": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "url", "image_url", "accessibility_caption" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "cover_photo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "member_count_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "privacy_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "visibility_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "posts": { "type": "array", "items": { "type": "object", "required": [ "id", "post_id", "url", "author_id", "author_name", "author_profile_picture_url", "message", "created_time", "created_at", "reaction_count", "comment_count", "attachments", "comments" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "post_id": { "type": "string" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "legacy_fbid", "url", "message", "author_id", "author_name", "author_profile_picture_url", "created_time", "created_at", "reaction_count", "reply_count" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "legacy_fbid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reply_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "created_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reaction_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "author_profile_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attachments": { "type": "array", "items": { "type": "object", "required": [ "type", "title", "source", "url", "image_url", "description" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reaction_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "author_profile_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "total_available", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "const": "public_page_offset" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_available": { "type": "integer" } }, "additionalProperties": false }, "max_posts_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "facebook-group", "task_name": "Facebook group", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runFacebookGroupCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.facebook.com/groups/2379328805667854/", "maxLength": 2000, "minLength": 1, "description": "Facebook group URL.", "x-placeholder": "e.g. https://www.facebook.com/groups/2379328805667854/" }, "cursor": { "type": "string", "x-sample": "20", "description": "Offset cursor returned as next_cursor from the previous response.", "x-placeholder": "e.g. 20" }, "group_id": { "type": "string", "x-sample": "2379328805667854", "description": "Facebook group id or public group slug. Use this instead of url when you only have the identifier.", "x-placeholder": "e.g. 2379328805667854" }, "max_posts": { "type": "integer", "default": 20, "maximum": 100, "minimum": 0, "description": "Maximum number of public posts to return from the initial group page payload." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "group_id" ] } ] }, "example": { "url": "https://www.facebook.com/groups/2379328805667854/" } } } }, "x-browsable-website-login-required": false } }, "/v1/facebook/group": { "post": { "tags": [ "Facebook" ], "summary": "Facebook group", "description": "Scrape public metadata and public initial-page posts from a Facebook group URL or group id.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "group", "posts", "count", "max_posts_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "group": { "type": "object", "required": [ "id", "url", "mobile_url", "name", "description", "privacy", "privacy_description", "visibility", "visibility_description", "member_count_text", "member_count", "location", "profile_picture_url", "cover_photo_url", "tabs", "recent_media" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tabs": { "type": "array", "items": { "type": "object", "required": [ "title", "type", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" } }, "additionalProperties": false } }, "privacy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mobile_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "visibility": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "member_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "recent_media": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "url", "image_url", "accessibility_caption" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "cover_photo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "member_count_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "privacy_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "visibility_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "posts": { "type": "array", "items": { "type": "object", "required": [ "id", "post_id", "url", "author_id", "author_name", "author_profile_picture_url", "message", "created_time", "created_at", "reaction_count", "comment_count", "attachments", "comments" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "post_id": { "type": "string" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "legacy_fbid", "url", "message", "author_id", "author_name", "author_profile_picture_url", "created_time", "created_at", "reaction_count", "reply_count" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "legacy_fbid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reply_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "created_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reaction_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "author_profile_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attachments": { "type": "array", "items": { "type": "object", "required": [ "type", "title", "source", "url", "image_url", "description" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reaction_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "author_profile_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "total_available", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "const": "public_page_offset" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_available": { "type": "integer" } }, "additionalProperties": false }, "max_posts_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "facebook-group", "task_name": "Facebook group", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "group": { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "tabs": [ { "url": "https://example.com/item-1", "type": "sample", "title": "Stylish Shoreditch Loft with Balcony" } ], "privacy": "sample", "location": "London", "mobile_url": "https://example.com/item-1", "visibility": "sample", "description": "Sample description 1", "member_count": 1, "recent_media": [ { "id": "id-1", "url": "https://example.com/item-1", "type": "sample", "image_url": "https://example.com/item-1", "accessibility_caption": "sample" } ], "cover_photo_url": "https://images.example.com/cover_photo_url-1.jpg", "member_count_text": "Sample member_count_text 1", "privacy_description": "Sample privacy_description 1", "profile_picture_url": "https://example.com/item-1", "visibility_description": "Sample visibility_description 1" }, "posts": [ { "id": "id-1", "url": "https://example.com/item-1", "message": "sample", "post_id": "id-1", "comments": [ { "id": "id-1", "url": "https://example.com/item-1", "message": "sample", "author_id": "user_1", "created_at": "2026-06-14T15:30:00Z", "author_name": "Stylish Shoreditch Loft with Balcony", "legacy_fbid": "id-1", "reply_count": 1, "created_time": 1.5, "reaction_count": 1, "author_profile_picture_url": "https://example.com/item-1" } ], "author_id": "user_1", "created_at": "2026-06-14T15:30:00Z", "attachments": [ { "url": "https://example.com/item-1", "type": "sample", "title": "Stylish Shoreditch Loft with Balcony", "source": "sample", "image_url": "https://example.com/item-1", "description": "Sample description 1" } ], "author_name": "Stylish Shoreditch Loft with Balcony", "created_time": 1.5, "comment_count": 1, "reaction_count": 1, "author_profile_picture_url": "https://example.com/item-1" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "public_page_offset", "next_cursor": "cursor-page-1", "has_next_page": true, "total_available": 180 }, "max_posts_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "group", "posts", "count", "max_posts_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "group": { "type": "object", "required": [ "id", "url", "mobile_url", "name", "description", "privacy", "privacy_description", "visibility", "visibility_description", "member_count_text", "member_count", "location", "profile_picture_url", "cover_photo_url", "tabs", "recent_media" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tabs": { "type": "array", "items": { "type": "object", "required": [ "title", "type", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" } }, "additionalProperties": false } }, "privacy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mobile_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "visibility": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "member_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "recent_media": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "url", "image_url", "accessibility_caption" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "cover_photo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "member_count_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "privacy_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "visibility_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "posts": { "type": "array", "items": { "type": "object", "required": [ "id", "post_id", "url", "author_id", "author_name", "author_profile_picture_url", "message", "created_time", "created_at", "reaction_count", "comment_count", "attachments", "comments" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "post_id": { "type": "string" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "legacy_fbid", "url", "message", "author_id", "author_name", "author_profile_picture_url", "created_time", "created_at", "reaction_count", "reply_count" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "legacy_fbid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reply_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "created_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reaction_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "author_profile_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "author_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "attachments": { "type": "array", "items": { "type": "object", "required": [ "type", "title", "source", "url", "image_url", "description" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reaction_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "author_profile_picture_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "total_available", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "const": "public_page_offset" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_available": { "type": "integer" } }, "additionalProperties": false }, "max_posts_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "facebook-group", "task_name": "Facebook group", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runFacebookGroupAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.facebook.com/groups/2379328805667854/", "maxLength": 2000, "minLength": 1, "description": "Facebook group URL.", "x-placeholder": "e.g. https://www.facebook.com/groups/2379328805667854/" }, "cursor": { "type": "string", "x-sample": "20", "description": "Offset cursor returned as next_cursor from the previous response.", "x-placeholder": "e.g. 20" }, "group_id": { "type": "string", "x-sample": "2379328805667854", "description": "Facebook group id or public group slug. Use this instead of url when you only have the identifier.", "x-placeholder": "e.g. 2379328805667854" }, "max_posts": { "type": "integer", "default": 20, "maximum": 100, "minimum": 0, "description": "Maximum number of public posts to return from the initial group page payload." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "group_id" ] } ] }, "example": { "url": "https://www.facebook.com/groups/2379328805667854/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-facebook-group" }, "x-browsable-website-login-required": false } }, "/v1/tasks/fantasy-premier-league-bootstrap/runs": { "post": { "tags": [ "Fantasy Premier League" ], "summary": "Fantasy Premier League Dataset", "description": "Get public FPL players and summaries of teams and gameweek events.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "fantasy-premier-league-bootstrap", "task_name": "Fantasy Premier League Dataset", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "fantasy-premier-league-bootstrap", "task_name": "Fantasy Premier League Dataset", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runFantasyPremierLeagueBootstrapCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum player records in results, and maximum teams/events included in data." }, "query": { "type": "string", "x-sample": "Salah", "maxLength": 2000, "minLength": 1, "description": "Optional text filter for player names or team codes. Does not filter teams or events.", "x-placeholder": "e.g. Salah" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "x-browsable-website-login-required": false } }, "/v1/fantasy-premier-league/bootstrap": { "post": { "tags": [ "Fantasy Premier League" ], "summary": "Fantasy Premier League Dataset", "description": "Get public FPL players and summaries of teams and gameweek events.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "fantasy-premier-league-bootstrap", "task_name": "Fantasy Premier League Dataset", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "fantasy-premier-league-bootstrap", "task_name": "Fantasy Premier League Dataset", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runFantasyPremierLeagueBootstrapAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum player records in results, and maximum teams/events included in data." }, "query": { "type": "string", "x-sample": "Salah", "maxLength": 2000, "minLength": 1, "description": "Optional text filter for player names or team codes. Does not filter teams or events.", "x-placeholder": "e.g. Salah" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-fantasy-premier-league-bootstrap" }, "x-browsable-website-login-required": false } }, "/v1/tasks/g2-product/runs": { "post": { "tags": [ "G2" ], "summary": "G2 Product API", "description": "Scrape a public G2 product page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "g2-product", "task_name": "G2 Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "g2-product", "task_name": "G2 Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runG2ProductCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.g2.com/products/salesforce-sales-cloud/reviews" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.g2.com/products/salesforce-sales-cloud/reviews" } } } }, "x-browsable-website-login-required": false } }, "/v1/g2/product": { "post": { "tags": [ "G2" ], "summary": "G2 Product API", "description": "Scrape a public G2 product page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "g2-product", "task_name": "G2 Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "g2-product", "task_name": "G2 Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runG2ProductAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.g2.com/products/salesforce-sales-cloud/reviews" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.g2.com/products/salesforce-sales-cloud/reviews" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-g2-product" }, "x-browsable-website-login-required": false } }, "/v1/tasks/g2-search/runs": { "post": { "tags": [ "G2" ], "summary": "G2 API", "description": "Scrape public G2 software search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "g2-search", "task_name": "G2 API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "g2-search", "task_name": "G2 API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runG2SearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "CRM software", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. CRM software" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "CRM software" } } } }, "x-browsable-website-login-required": false } }, "/v1/g2/search": { "post": { "tags": [ "G2" ], "summary": "G2 API", "description": "Scrape public G2 software search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "g2-search", "task_name": "G2 API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "g2-search", "task_name": "G2 API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runG2SearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "CRM software", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. CRM software" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "CRM software" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-g2-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/glassdoor-interviews/runs": { "post": { "tags": [ "Glassdoor" ], "summary": "Glassdoor Interviews API", "description": "Scrape public Glassdoor interview question pages.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "glassdoor-interviews", "task_name": "Glassdoor Interviews API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "glassdoor-interviews", "task_name": "Glassdoor Interviews API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGlassdoorInterviewsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "product manager", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. product manager" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "product manager" } } } }, "x-browsable-website-login-required": false } }, "/v1/glassdoor/interviews": { "post": { "tags": [ "Glassdoor" ], "summary": "Glassdoor Interviews API", "description": "Scrape public Glassdoor interview question pages.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "glassdoor-interviews", "task_name": "Glassdoor Interviews API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "glassdoor-interviews", "task_name": "Glassdoor Interviews API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGlassdoorInterviewsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "product manager", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. product manager" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "product manager" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-glassdoor-interviews" }, "x-browsable-website-login-required": false } }, "/v1/tasks/glassdoor-salaries/runs": { "post": { "tags": [ "Glassdoor" ], "summary": "Glassdoor Salaries API", "description": "Scrape public Glassdoor salary search pages.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "glassdoor-salaries", "task_name": "Glassdoor Salaries API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "glassdoor-salaries", "task_name": "Glassdoor Salaries API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGlassdoorSalariesCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "software engineer", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. software engineer" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "software engineer" } } } }, "x-browsable-website-login-required": false } }, "/v1/glassdoor/salaries": { "post": { "tags": [ "Glassdoor" ], "summary": "Glassdoor Salaries API", "description": "Scrape public Glassdoor salary search pages.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "glassdoor-salaries", "task_name": "Glassdoor Salaries API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "glassdoor-salaries", "task_name": "Glassdoor Salaries API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGlassdoorSalariesAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "software engineer", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. software engineer" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "software engineer" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-glassdoor-salaries" }, "x-browsable-website-login-required": false } }, "/v1/tasks/goodreads-book/runs": { "post": { "tags": [ "Goodreads" ], "summary": "Goodreads Book API", "description": "Scrape a public Goodreads book page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "goodreads-book", "task_name": "Goodreads Book API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "goodreads-book", "task_name": "Goodreads Book API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGoodreadsBookCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.goodreads.com/book/show/44767458-dune" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.goodreads.com/book/show/44767458-dune" } } } }, "x-browsable-website-login-required": false } }, "/v1/goodreads/book": { "post": { "tags": [ "Goodreads" ], "summary": "Goodreads Book API", "description": "Scrape a public Goodreads book page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "goodreads-book", "task_name": "Goodreads Book API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "goodreads-book", "task_name": "Goodreads Book API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGoodreadsBookAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.goodreads.com/book/show/44767458-dune" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.goodreads.com/book/show/44767458-dune" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-goodreads-book" }, "x-browsable-website-login-required": false } }, "/v1/tasks/goodreads-search/runs": { "post": { "tags": [ "Goodreads" ], "summary": "Goodreads API", "description": "Scrape public Goodreads book search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "goodreads-search", "task_name": "Goodreads API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "goodreads-search", "task_name": "Goodreads API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGoodreadsSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Dune", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Dune" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Dune" } } } }, "x-browsable-website-login-required": false } }, "/v1/goodreads/search": { "post": { "tags": [ "Goodreads" ], "summary": "Goodreads API", "description": "Scrape public Goodreads book search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "goodreads-search", "task_name": "Goodreads API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "goodreads-search", "task_name": "Goodreads API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGoodreadsSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Dune", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Dune" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Dune" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-goodreads-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/googlemaps-area/runs": { "post": { "tags": [ "Google Maps" ], "summary": "Google Maps area search", "description": "Search Google Maps for businesses near a specific latitude/longitude. Useful for exhaustive geographic coverage where IP-based location guessing would be unreliable.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "name", "rating", "reviewsCount", "category", "address", "description", "status", "hours", "link", "placeId", "latitude", "longitude" ], "properties": { "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hours": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-area", "task_name": "Google Maps area search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "results": [ { "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "hours": "sample", "rating": 4.91, "status": "sample", "address": "sample", "placeId": "id-1", "category": "sample", "latitude": 51.5074, "longitude": -0.1278, "description": "Sample description 1", "reviewsCount": 1 } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "name", "rating", "reviewsCount", "category", "address", "description", "status", "hours", "link", "placeId", "latitude", "longitude" ], "properties": { "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hours": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-area", "task_name": "Google Maps area search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGooglemapsAreaCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "zoom": { "type": "number", "default": 14, "maximum": 21, "minimum": 3, "x-advanced": true, "description": "Map zoom level (3 to 21). Higher values search a tighter area. Defaults to 14 (~city block scale)." }, "limit": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "description": "Maximum results to return. Defaults to 100. Preferred name; maxResults remains supported." }, "query": { "type": "string", "maxLength": 500, "minLength": 1, "description": "Search query (e.g. 'dentists', 'coffee shops'). Combined with latitude/longitude to search a specific area." }, "latitude": { "type": "number", "maximum": 90, "minimum": -90, "x-advanced": true, "description": "Center latitude (-90 to 90)." }, "location": { "type": "string", "x-sample": "Brooklyn, NY", "maxLength": 500, "minLength": 1, "description": "City, neighbourhood or address to search around. Coordinates are optional advanced inputs." }, "longitude": { "type": "number", "maximum": 180, "minimum": -180, "x-advanced": true, "description": "Center longitude (-180 to 180)." }, "maxResults": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "x-advanced": true, "description": "Maximum results to return. Defaults to 100. You can also use limit." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ], "anyOf": [ { "required": [ "location" ] }, { "required": [ "latitude", "longitude" ] } ] }, "example": { "query": "London", "location": "Brooklyn, NY" } } } }, "x-browsable-website-login-required": false } }, "/v1/googlemaps/area": { "post": { "tags": [ "Google Maps" ], "summary": "Google Maps area search", "description": "Search Google Maps for businesses near a specific latitude/longitude. Useful for exhaustive geographic coverage where IP-based location guessing would be unreliable.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "name", "rating", "reviewsCount", "category", "address", "description", "status", "hours", "link", "placeId", "latitude", "longitude" ], "properties": { "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hours": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-area", "task_name": "Google Maps area search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "results": [ { "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "hours": "sample", "rating": 4.91, "status": "sample", "address": "sample", "placeId": "id-1", "category": "sample", "latitude": 51.5074, "longitude": -0.1278, "description": "Sample description 1", "reviewsCount": 1 } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "name", "rating", "reviewsCount", "category", "address", "description", "status", "hours", "link", "placeId", "latitude", "longitude" ], "properties": { "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hours": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-area", "task_name": "Google Maps area search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGooglemapsAreaAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "zoom": { "type": "number", "default": 14, "maximum": 21, "minimum": 3, "x-advanced": true, "description": "Map zoom level (3 to 21). Higher values search a tighter area. Defaults to 14 (~city block scale)." }, "limit": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "description": "Maximum results to return. Defaults to 100. Preferred name; maxResults remains supported." }, "query": { "type": "string", "maxLength": 500, "minLength": 1, "description": "Search query (e.g. 'dentists', 'coffee shops'). Combined with latitude/longitude to search a specific area." }, "latitude": { "type": "number", "maximum": 90, "minimum": -90, "x-advanced": true, "description": "Center latitude (-90 to 90)." }, "location": { "type": "string", "x-sample": "Brooklyn, NY", "maxLength": 500, "minLength": 1, "description": "City, neighbourhood or address to search around. Coordinates are optional advanced inputs." }, "longitude": { "type": "number", "maximum": 180, "minimum": -180, "x-advanced": true, "description": "Center longitude (-180 to 180)." }, "maxResults": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "x-advanced": true, "description": "Maximum results to return. Defaults to 100. You can also use limit." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ], "anyOf": [ { "required": [ "location" ] }, { "required": [ "latitude", "longitude" ] } ] }, "example": { "query": "London", "location": "Brooklyn, NY" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-googlemaps-area" }, "x-browsable-website-login-required": false } }, "/v1/tasks/googlemaps-autocomplete/runs": { "post": { "tags": [ "Google Maps" ], "summary": "Google Maps Autocomplete API", "description": "Fetch public Google Maps autocomplete suggestions.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-autocomplete", "task_name": "Google Maps Autocomplete API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-autocomplete", "task_name": "Google Maps Autocomplete API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGooglemapsAutocompleteCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "pizza near Shoreditch", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. pizza near Shoreditch" }, "location": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Location filter.", "x-placeholder": "e.g. San Francisco, CA" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "pizza near Shoreditch" } } } }, "x-browsable-website-login-required": false } }, "/v1/googlemaps/autocomplete": { "post": { "tags": [ "Google Maps" ], "summary": "Google Maps Autocomplete API", "description": "Fetch public Google Maps autocomplete suggestions.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-autocomplete", "task_name": "Google Maps Autocomplete API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-autocomplete", "task_name": "Google Maps Autocomplete API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGooglemapsAutocompleteAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "pizza near Shoreditch", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. pizza near Shoreditch" }, "location": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Location filter.", "x-placeholder": "e.g. San Francisco, CA" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "pizza near Shoreditch" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-googlemaps-autocomplete" }, "x-browsable-website-login-required": false } }, "/v1/tasks/googlemaps-place/runs": { "post": { "tags": [ "Google Maps" ], "summary": "Google Maps place", "description": "Fetch full details for a single Google Maps place — name, rating, category, description, address, phone, website, plus code, opening hours, and coordinates.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "name", "rating", "reviewsCount", "category", "description", "address", "phone", "website", "plusCode", "hours", "status", "link", "placeId", "latitude", "longitude" ], "properties": { "link": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hours": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "day", "hours" ], "properties": { "day": { "type": "string" }, "hours": { "type": "string" } }, "additionalProperties": false } }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "plusCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-place", "task_name": "Google Maps place", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "hours": [ { "day": "sample", "hours": "sample" } ], "phone": "sample", "rating": 4.91, "status": "sample", "address": "sample", "placeId": "id-1", "website": "sample", "category": "sample", "latitude": 51.5074, "plusCode": "sample", "longitude": -0.1278, "description": "Sample description 1", "reviewsCount": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "name", "rating", "reviewsCount", "category", "description", "address", "phone", "website", "plusCode", "hours", "status", "link", "placeId", "latitude", "longitude" ], "properties": { "link": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hours": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "day", "hours" ], "properties": { "day": { "type": "string" }, "hours": { "type": "string" } }, "additionalProperties": false } }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "plusCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-place", "task_name": "Google Maps place", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGooglemapsPlaceCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Full Google Maps place URL (e.g. https://www.google.com/maps/place/...). Preferred — supply from a prior search result. Preferred name; placeUrl remains supported." }, "query": { "type": "string", "maxLength": 500, "minLength": 1, "description": "Search query if no placeUrl. The first matching result is used." }, "placeUrl": { "type": "string", "x-advanced": true, "description": "Full Google Maps place URL (e.g. https://www.google.com/maps/place/...). Preferred — supply from a prior search result. You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "placeUrl" ] }, { "required": [ "query" ] } ] }, "example": { "placeUrl": "https://example.com/item-1" } } } }, "x-browsable-website-login-required": false } }, "/v1/googlemaps/place": { "post": { "tags": [ "Google Maps" ], "summary": "Google Maps place", "description": "Fetch full details for a single Google Maps place — name, rating, category, description, address, phone, website, plus code, opening hours, and coordinates.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "name", "rating", "reviewsCount", "category", "description", "address", "phone", "website", "plusCode", "hours", "status", "link", "placeId", "latitude", "longitude" ], "properties": { "link": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hours": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "day", "hours" ], "properties": { "day": { "type": "string" }, "hours": { "type": "string" } }, "additionalProperties": false } }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "plusCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-place", "task_name": "Google Maps place", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "hours": [ { "day": "sample", "hours": "sample" } ], "phone": "sample", "rating": 4.91, "status": "sample", "address": "sample", "placeId": "id-1", "website": "sample", "category": "sample", "latitude": 51.5074, "plusCode": "sample", "longitude": -0.1278, "description": "Sample description 1", "reviewsCount": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "name", "rating", "reviewsCount", "category", "description", "address", "phone", "website", "plusCode", "hours", "status", "link", "placeId", "latitude", "longitude" ], "properties": { "link": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hours": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "day", "hours" ], "properties": { "day": { "type": "string" }, "hours": { "type": "string" } }, "additionalProperties": false } }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "plusCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-place", "task_name": "Google Maps place", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGooglemapsPlaceAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Full Google Maps place URL (e.g. https://www.google.com/maps/place/...). Preferred — supply from a prior search result. Preferred name; placeUrl remains supported." }, "query": { "type": "string", "maxLength": 500, "minLength": 1, "description": "Search query if no placeUrl. The first matching result is used." }, "placeUrl": { "type": "string", "x-advanced": true, "description": "Full Google Maps place URL (e.g. https://www.google.com/maps/place/...). Preferred — supply from a prior search result. You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "placeUrl" ] }, { "required": [ "query" ] } ] }, "example": { "placeUrl": "https://example.com/item-1" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-googlemaps-place" }, "x-browsable-website-login-required": false } }, "/v1/tasks/googlemaps-reviews/runs": { "post": { "tags": [ "Google Maps" ], "summary": "Google Maps reviews", "description": "Fetch reviews for a Google Maps place — author, rating, date, text, owner response, plus an overall rating breakdown.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "placeName", "rating", "reviewsCount", "ratingBreakdown", "reviews" ], "properties": { "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "reviewId", "author", "rating", "relativeDate", "text", "ownerResponse", "photoCount" ], "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reviewId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "photoCount": { "type": "number" }, "relativeDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownerResponse": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "placeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ratingBreakdown": { "type": "array", "items": { "type": "object", "required": [ "stars", "count" ], "properties": { "count": { "type": "number" }, "stars": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-reviews", "task_name": "Google Maps reviews", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "rating": 4.91, "reviews": [ { "text": "Sample text 1", "author": "user_1", "rating": 4.91, "reviewId": "id-1", "photoCount": 1, "relativeDate": "sample", "ownerResponse": "sample" } ], "placeName": "Stylish Shoreditch Loft with Balcony", "reviewsCount": 1, "ratingBreakdown": [ { "count": 1, "stars": 1.5 } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "placeName", "rating", "reviewsCount", "ratingBreakdown", "reviews" ], "properties": { "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "reviewId", "author", "rating", "relativeDate", "text", "ownerResponse", "photoCount" ], "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reviewId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "photoCount": { "type": "number" }, "relativeDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownerResponse": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "placeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ratingBreakdown": { "type": "array", "items": { "type": "object", "required": [ "stars", "count" ], "properties": { "count": { "type": "number" }, "stars": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-reviews", "task_name": "Google Maps reviews", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGooglemapsReviewsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Full Google Maps place URL — pass the `link` field from a `googlemaps/search`, `googlemaps/area`, or `googlemaps/place` response. Preferred name; placeUrl remains supported." }, "limit": { "type": "integer", "default": 50, "maximum": 2000, "minimum": 1, "description": "Maximum reviews to extract. Defaults to 50. Preferred name; maxReviews remains supported." }, "placeUrl": { "type": "string", "x-advanced": true, "description": "Full Google Maps place URL — pass the `link` field from a `googlemaps/search`, `googlemaps/area`, or `googlemaps/place` response. You can also use url." }, "maxReviews": { "type": "integer", "default": 50, "maximum": 2000, "minimum": 1, "x-advanced": true, "description": "Maximum reviews to extract. Defaults to 50. You can also use limit." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "url" ] }, { "required": [ "placeUrl" ] } ] } ] }, "example": { "url": "https://example.com/item-1" } } } }, "x-browsable-website-login-required": false } }, "/v1/googlemaps/reviews": { "post": { "tags": [ "Google Maps" ], "summary": "Google Maps reviews", "description": "Fetch reviews for a Google Maps place — author, rating, date, text, owner response, plus an overall rating breakdown.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "placeName", "rating", "reviewsCount", "ratingBreakdown", "reviews" ], "properties": { "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "reviewId", "author", "rating", "relativeDate", "text", "ownerResponse", "photoCount" ], "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reviewId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "photoCount": { "type": "number" }, "relativeDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownerResponse": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "placeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ratingBreakdown": { "type": "array", "items": { "type": "object", "required": [ "stars", "count" ], "properties": { "count": { "type": "number" }, "stars": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-reviews", "task_name": "Google Maps reviews", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "rating": 4.91, "reviews": [ { "text": "Sample text 1", "author": "user_1", "rating": 4.91, "reviewId": "id-1", "photoCount": 1, "relativeDate": "sample", "ownerResponse": "sample" } ], "placeName": "Stylish Shoreditch Loft with Balcony", "reviewsCount": 1, "ratingBreakdown": [ { "count": 1, "stars": 1.5 } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "placeName", "rating", "reviewsCount", "ratingBreakdown", "reviews" ], "properties": { "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reviews": { "type": "array", "items": { "type": "object", "required": [ "reviewId", "author", "rating", "relativeDate", "text", "ownerResponse", "photoCount" ], "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reviewId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "photoCount": { "type": "number" }, "relativeDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownerResponse": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "placeName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ratingBreakdown": { "type": "array", "items": { "type": "object", "required": [ "stars", "count" ], "properties": { "count": { "type": "number" }, "stars": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-reviews", "task_name": "Google Maps reviews", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGooglemapsReviewsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Full Google Maps place URL — pass the `link` field from a `googlemaps/search`, `googlemaps/area`, or `googlemaps/place` response. Preferred name; placeUrl remains supported." }, "limit": { "type": "integer", "default": 50, "maximum": 2000, "minimum": 1, "description": "Maximum reviews to extract. Defaults to 50. Preferred name; maxReviews remains supported." }, "placeUrl": { "type": "string", "x-advanced": true, "description": "Full Google Maps place URL — pass the `link` field from a `googlemaps/search`, `googlemaps/area`, or `googlemaps/place` response. You can also use url." }, "maxReviews": { "type": "integer", "default": 50, "maximum": 2000, "minimum": 1, "x-advanced": true, "description": "Maximum reviews to extract. Defaults to 50. You can also use limit." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "url" ] }, { "required": [ "placeUrl" ] } ] } ] }, "example": { "url": "https://example.com/item-1" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-googlemaps-reviews" }, "x-browsable-website-login-required": false } }, "/v1/tasks/googlemaps-search/runs": { "post": { "tags": [ "Google Maps" ], "summary": "Google Maps search", "description": "Search Google Maps for businesses or places matching a query and return each result's name, rating, category, address, hours, place ID, and coordinates.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "name", "rating", "reviewsCount", "category", "address", "description", "status", "hours", "link", "placeId", "latitude", "longitude" ], "properties": { "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hours": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-search", "task_name": "Google Maps search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "results": [ { "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "hours": "sample", "rating": 4.91, "status": "sample", "address": "sample", "placeId": "id-1", "category": "sample", "latitude": 51.5074, "longitude": -0.1278, "description": "Sample description 1", "reviewsCount": 1 } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "name", "rating", "reviewsCount", "category", "address", "description", "status", "hours", "link", "placeId", "latitude", "longitude" ], "properties": { "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hours": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-search", "task_name": "Google Maps search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGooglemapsSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "description": "Maximum results to return. Google Maps loads ~20 at a time; the scraper scrolls until enough cards appear or the feed stops growing. Preferred name; maxResults remains supported." }, "query": { "type": "string", "maxLength": 500, "minLength": 1, "description": "Search query — typically a business type plus a location (e.g. 'coffee shops in San Francisco', 'dentists Austin TX')." }, "maxResults": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "x-advanced": true, "description": "Maximum results to return. Google Maps loads ~20 at a time; the scraper scrolls until enough cards appear or the feed stops growing. You can also use limit." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "x-browsable-website-login-required": false } }, "/v1/googlemaps/search": { "post": { "tags": [ "Google Maps" ], "summary": "Google Maps search", "description": "Search Google Maps for businesses or places matching a query and return each result's name, rating, category, address, hours, place ID, and coordinates.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "name", "rating", "reviewsCount", "category", "address", "description", "status", "hours", "link", "placeId", "latitude", "longitude" ], "properties": { "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hours": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-search", "task_name": "Google Maps search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "results": [ { "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "hours": "sample", "rating": 4.91, "status": "sample", "address": "sample", "placeId": "id-1", "category": "sample", "latitude": 51.5074, "longitude": -0.1278, "description": "Sample description 1", "reviewsCount": 1 } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "name", "rating", "reviewsCount", "category", "address", "description", "status", "hours", "link", "placeId", "latitude", "longitude" ], "properties": { "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hours": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewsCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "googlemaps-search", "task_name": "Google Maps search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGooglemapsSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "description": "Maximum results to return. Google Maps loads ~20 at a time; the scraper scrolls until enough cards appear or the feed stops growing. Preferred name; maxResults remains supported." }, "query": { "type": "string", "maxLength": 500, "minLength": 1, "description": "Search query — typically a business type plus a location (e.g. 'coffee shops in San Francisco', 'dentists Austin TX')." }, "maxResults": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "x-advanced": true, "description": "Maximum results to return. Google Maps loads ~20 at a time; the scraper scrolls until enough cards appear or the feed stops growing. You can also use limit." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-googlemaps-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/gumtree-listing/runs": { "post": { "tags": [ "Gumtree" ], "summary": "Gumtree Listing API", "description": "Scrape a public Gumtree listing detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "gumtree-listing", "task_name": "Gumtree Listing API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "gumtree-listing", "task_name": "Gumtree Listing API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGumtreeListingCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Gumtree listing URL returned by gumtree/search.", "x-placeholder": "e.g. https://www.gumtree.com/p/bicycles/example-listing/1234567890" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.gumtree.com/p/bicycles/example-listing/1234567890" } } } }, "x-browsable-website-login-required": false } }, "/v1/gumtree/listing": { "post": { "tags": [ "Gumtree" ], "summary": "Gumtree Listing API", "description": "Scrape a public Gumtree listing detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "gumtree-listing", "task_name": "Gumtree Listing API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "gumtree-listing", "task_name": "Gumtree Listing API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGumtreeListingAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Gumtree listing URL returned by gumtree/search.", "x-placeholder": "e.g. https://www.gumtree.com/p/bicycles/example-listing/1234567890" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.gumtree.com/p/bicycles/example-listing/1234567890" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-gumtree-listing" }, "x-browsable-website-login-required": false } }, "/v1/tasks/gumtree-search/runs": { "post": { "tags": [ "Gumtree" ], "summary": "Gumtree API", "description": "Scrape public Gumtree search result pages by query with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "gumtree-search", "task_name": "Gumtree API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "gumtree-search", "task_name": "Gumtree API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGumtreeSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "bicycle", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. bicycle" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "bicycle" } } } }, "x-browsable-website-login-required": false } }, "/v1/gumtree/search": { "post": { "tags": [ "Gumtree" ], "summary": "Gumtree API", "description": "Scrape public Gumtree search result pages by query with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "gumtree-search", "task_name": "Gumtree API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "gumtree-search", "task_name": "Gumtree API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runGumtreeSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "bicycle", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. bicycle" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "bicycle" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-gumtree-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/hacker-news-item/runs": { "post": { "tags": [ "Hacker News" ], "summary": "Hacker News Item API", "description": "Fetch a public Hacker News item by URL or item id.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hacker-news-item", "task_name": "Hacker News Item API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hacker-news-item", "task_name": "Hacker News Item API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runHackerNewsItemCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "x-sample": "8863", "description": "Hacker News item id.", "x-placeholder": "e.g. 8863" }, "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Hacker News item URL.", "x-placeholder": "e.g. https://news.ycombinator.com/item?id=8863" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://news.ycombinator.com/item?id=8863" } } } }, "x-browsable-website-login-required": false } }, "/v1/hacker-news/item": { "post": { "tags": [ "Hacker News" ], "summary": "Hacker News Item API", "description": "Fetch a public Hacker News item by URL or item id.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hacker-news-item", "task_name": "Hacker News Item API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hacker-news-item", "task_name": "Hacker News Item API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runHackerNewsItemAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "x-sample": "8863", "description": "Hacker News item id.", "x-placeholder": "e.g. 8863" }, "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Hacker News item URL.", "x-placeholder": "e.g. https://news.ycombinator.com/item?id=8863" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "id" ] } ] }, "example": { "url": "https://news.ycombinator.com/item?id=8863" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-hacker-news-item" }, "x-browsable-website-login-required": false } }, "/v1/tasks/hacker-news-search/runs": { "post": { "tags": [ "Hacker News" ], "summary": "Hacker News API", "description": "Search Hacker News stories through public Algolia data with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hacker-news-search", "task_name": "Hacker News API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hacker-news-search", "task_name": "Hacker News API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runHackerNewsSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "postgres", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. postgres" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "postgres" } } } }, "x-browsable-website-login-required": false } }, "/v1/hacker-news/search": { "post": { "tags": [ "Hacker News" ], "summary": "Hacker News API", "description": "Search Hacker News stories through public Algolia data with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hacker-news-search", "task_name": "Hacker News API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hacker-news-search", "task_name": "Hacker News API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runHackerNewsSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "postgres", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. postgres" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "postgres" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-hacker-news-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/homedepot-product/runs": { "post": { "tags": [ "Home Depot" ], "summary": "Home Depot Product API", "description": "Scrape a public Home Depot product detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "homedepot-product", "task_name": "Home Depot Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "homedepot-product", "task_name": "Home Depot Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runHomedepotProductCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Home Depot product URL returned by homedepot/search.", "x-placeholder": "e.g. https://www.homedepot.com/p/example-product/123456789" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.homedepot.com/p/example-product/123456789" } } } }, "x-browsable-website-login-required": false } }, "/v1/homedepot/product": { "post": { "tags": [ "Home Depot" ], "summary": "Home Depot Product API", "description": "Scrape a public Home Depot product detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "homedepot-product", "task_name": "Home Depot Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "homedepot-product", "task_name": "Home Depot Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runHomedepotProductAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Home Depot product URL returned by homedepot/search.", "x-placeholder": "e.g. https://www.homedepot.com/p/example-product/123456789" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.homedepot.com/p/example-product/123456789" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-homedepot-product" }, "x-browsable-website-login-required": false } }, "/v1/tasks/homedepot-search/runs": { "post": { "tags": [ "Home Depot" ], "summary": "Home Depot API", "description": "Scrape public Home Depot search result pages by query with offset pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "homedepot-search", "task_name": "Home Depot API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "homedepot-search", "task_name": "Home Depot API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runHomedepotSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "cordless drill", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. cordless drill" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "cordless drill" } } } }, "x-browsable-website-login-required": false } }, "/v1/homedepot/search": { "post": { "tags": [ "Home Depot" ], "summary": "Home Depot API", "description": "Scrape public Home Depot search result pages by query with offset pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "homedepot-search", "task_name": "Home Depot API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "homedepot-search", "task_name": "Home Depot API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runHomedepotSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "cordless drill", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. cordless drill" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "cordless drill" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-homedepot-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/hotels-property/runs": { "post": { "tags": [ "Hotels.com" ], "summary": "Hotels.com Property API", "description": "Get public Hotels.com property details. If stay dates are unavailable, returns an undated property summary without prices or availability. Returns public discovery metadata; undated prices are not stay-specific quotes. This endpoint does not accept stay dates or occupancy; check a dated search on the source website for stay-specific prices.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hotels-property", "task_name": "Hotels.com Property API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hotels-property", "task_name": "Hotels.com Property API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runHotelsPropertyCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.hotels.com/ho123456/example-hotel/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.hotels.com/ho123456/example-hotel/" } } } }, "x-browsable-website-login-required": false } }, "/v1/hotels/property": { "post": { "tags": [ "Hotels.com" ], "summary": "Hotels.com Property API", "description": "Get public Hotels.com property details. If stay dates are unavailable, returns an undated property summary without prices or availability. Returns public discovery metadata; undated prices are not stay-specific quotes. This endpoint does not accept stay dates or occupancy; check a dated search on the source website for stay-specific prices.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hotels-property", "task_name": "Hotels.com Property API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hotels-property", "task_name": "Hotels.com Property API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runHotelsPropertyAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.hotels.com/ho123456/example-hotel/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.hotels.com/ho123456/example-hotel/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-hotels-property" }, "x-browsable-website-login-required": false } }, "/v1/tasks/hotels-search/runs": { "post": { "tags": [ "Hotels.com" ], "summary": "Hotels.com API", "description": "Scrape public Hotels.com accommodation search results by destination. Returns public discovery metadata; undated prices are not stay-specific quotes. This endpoint does not accept stay dates or occupancy; check a dated search on the source website for stay-specific prices.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hotels-search", "task_name": "Hotels.com API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hotels-search", "task_name": "Hotels.com API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runHotelsSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Miami Beach", "maxLength": 2000, "minLength": 1, "description": "City, region, airport or neighborhood.", "x-placeholder": "e.g. Miami Beach" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Miami Beach" } } } }, "x-browsable-website-login-required": false } }, "/v1/hotels/search": { "post": { "tags": [ "Hotels.com" ], "summary": "Hotels.com API", "description": "Scrape public Hotels.com accommodation search results by destination. Returns public discovery metadata; undated prices are not stay-specific quotes. This endpoint does not accept stay dates or occupancy; check a dated search on the source website for stay-specific prices.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hotels-search", "task_name": "Hotels.com API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "hotels-search", "task_name": "Hotels.com API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runHotelsSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Miami Beach", "maxLength": 2000, "minLength": 1, "description": "City, region, airport or neighborhood.", "x-placeholder": "e.g. Miami Beach" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Miami Beach" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-hotels-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/imdb-detail/runs": { "post": { "tags": [ "IMDb" ], "summary": "IMDb Detail API", "description": "Scrape a public IMDb title, name, or series detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "imdb-detail", "task_name": "IMDb Detail API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "imdb-detail", "task_name": "IMDb Detail API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runImdbDetailCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.imdb.com/title/tt0133093/", "maxLength": 2000, "minLength": 1, "description": "IMDb URL returned by imdb/search.", "x-placeholder": "e.g. https://www.imdb.com/title/tt0133093/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.imdb.com/title/tt0133093/" } } } }, "x-browsable-website-login-required": false } }, "/v1/imdb/detail": { "post": { "tags": [ "IMDb" ], "summary": "IMDb Detail API", "description": "Scrape a public IMDb title, name, or series detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "imdb-detail", "task_name": "IMDb Detail API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "imdb-detail", "task_name": "IMDb Detail API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runImdbDetailAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.imdb.com/title/tt0133093/", "maxLength": 2000, "minLength": 1, "description": "IMDb URL returned by imdb/search.", "x-placeholder": "e.g. https://www.imdb.com/title/tt0133093/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.imdb.com/title/tt0133093/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-imdb-detail" }, "x-browsable-website-login-required": false } }, "/v1/tasks/imdb-search/runs": { "post": { "tags": [ "IMDb" ], "summary": "IMDb API", "description": "Search IMDb public suggestion data by query.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "imdb-search", "task_name": "IMDb API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "imdb-search", "task_name": "IMDb API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runImdbSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "The Matrix", "maxLength": 2000, "minLength": 1, "description": "Movie, TV show, or person to search for.", "x-placeholder": "e.g. The Matrix" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "The Matrix" } } } }, "x-browsable-website-login-required": false } }, "/v1/imdb/search": { "post": { "tags": [ "IMDb" ], "summary": "IMDb API", "description": "Search IMDb public suggestion data by query.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "imdb-search", "task_name": "IMDb API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "imdb-search", "task_name": "IMDb API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runImdbSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "The Matrix", "maxLength": 2000, "minLength": 1, "description": "Movie, TV show, or person to search for.", "x-placeholder": "e.g. The Matrix" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "The Matrix" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-imdb-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/indeed-company-reviews/runs": { "post": { "tags": [ "Indeed" ], "summary": "Indeed Company Reviews API", "description": "Scrape public Indeed company review pages.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-company-reviews", "task_name": "Indeed Company Reviews API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-company-reviews", "task_name": "Indeed Company Reviews API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runIndeedCompanyReviewsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Starbucks", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Starbucks" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Starbucks" } } } }, "x-browsable-website-login-required": false } }, "/v1/indeed/company-reviews": { "post": { "tags": [ "Indeed" ], "summary": "Indeed Company Reviews API", "description": "Scrape public Indeed company review pages.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-company-reviews", "task_name": "Indeed Company Reviews API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-company-reviews", "task_name": "Indeed Company Reviews API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runIndeedCompanyReviewsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Starbucks", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Starbucks" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Starbucks" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-indeed-company-reviews" }, "x-browsable-website-login-required": false } }, "/v1/tasks/indeed-job/runs": { "post": { "tags": [ "Indeed" ], "summary": "Indeed job details", "description": "Fetch full details for a single Indeed job posting — title, company, location, salary, employment type, full description, benefits, posted date, and apply URL. Pass either a job URL or a job key.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "jobKey", "title", "url", "company", "location", "salary", "employmentType", "description", "descriptionText", "benefits", "datePosted", "validThrough", "directApply", "applyUrl" ], "properties": { "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "salary": { "type": "object", "required": [ "min", "max", "currency", "type", "text", "source" ], "properties": { "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "company": { "type": "object", "required": [ "name", "url", "logo" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "applyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "benefits": { "type": "array", "items": { "type": "string" } }, "location": { "type": "object", "required": [ "formatted", "city", "region", "postalCode", "country", "remote", "jobLocationType" ], "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "remote": { "type": "boolean" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "formatted": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobLocationType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "datePosted": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "directApply": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "validThrough": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employmentType": { "type": "array", "items": { "type": "string" } }, "descriptionText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-job", "task_name": "Indeed job details", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "jobKey": "sample", "salary": { "max": 1.5, "min": 1.5, "text": "Sample text 1", "type": "sample", "source": "sample", "currency": "USD" }, "company": { "url": "https://example.com/item-1", "logo": "https://images.example.com/logo-1.jpg", "name": "Stylish Shoreditch Loft with Balcony" }, "applyUrl": "https://example.com/item-1", "benefits": [ "sample" ], "location": { "city": "London", "region": "London", "remote": true, "country": "London", "formatted": "sample", "postalCode": "sample", "jobLocationType": "London" }, "datePosted": "sample", "description": "Sample description 1", "directApply": true, "validThrough": "id-1", "employmentType": [ "sample" ], "descriptionText": "Sample descriptiontext 1" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "jobKey", "title", "url", "company", "location", "salary", "employmentType", "description", "descriptionText", "benefits", "datePosted", "validThrough", "directApply", "applyUrl" ], "properties": { "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "salary": { "type": "object", "required": [ "min", "max", "currency", "type", "text", "source" ], "properties": { "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "company": { "type": "object", "required": [ "name", "url", "logo" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "applyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "benefits": { "type": "array", "items": { "type": "string" } }, "location": { "type": "object", "required": [ "formatted", "city", "region", "postalCode", "country", "remote", "jobLocationType" ], "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "remote": { "type": "boolean" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "formatted": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobLocationType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "datePosted": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "directApply": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "validThrough": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employmentType": { "type": "array", "items": { "type": "string" } }, "descriptionText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-job", "task_name": "Indeed job details", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runIndeedJobCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Full Indeed job URL — typically the `link` from a prior `indeed/search` response." }, "domain": { "type": "string", "pattern": "^[a-z0-9.-]+\\.indeed\\.com$", "description": "Indeed regional domain (default www.indeed.com). Only used when jobKey is provided." }, "jobKey": { "type": "string", "description": "Indeed job key (e.g. `a61c6e343c845e92`) — the `jobKey` field from `indeed/search`. Use instead of url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "jobKey" ] } ] }, "example": { "url": "https://example.com/item-1" } } } }, "x-browsable-website-login-required": false } }, "/v1/indeed/job": { "post": { "tags": [ "Indeed" ], "summary": "Indeed job details", "description": "Fetch full details for a single Indeed job posting — title, company, location, salary, employment type, full description, benefits, posted date, and apply URL. Pass either a job URL or a job key.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "jobKey", "title", "url", "company", "location", "salary", "employmentType", "description", "descriptionText", "benefits", "datePosted", "validThrough", "directApply", "applyUrl" ], "properties": { "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "salary": { "type": "object", "required": [ "min", "max", "currency", "type", "text", "source" ], "properties": { "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "company": { "type": "object", "required": [ "name", "url", "logo" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "applyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "benefits": { "type": "array", "items": { "type": "string" } }, "location": { "type": "object", "required": [ "formatted", "city", "region", "postalCode", "country", "remote", "jobLocationType" ], "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "remote": { "type": "boolean" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "formatted": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobLocationType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "datePosted": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "directApply": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "validThrough": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employmentType": { "type": "array", "items": { "type": "string" } }, "descriptionText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-job", "task_name": "Indeed job details", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "jobKey": "sample", "salary": { "max": 1.5, "min": 1.5, "text": "Sample text 1", "type": "sample", "source": "sample", "currency": "USD" }, "company": { "url": "https://example.com/item-1", "logo": "https://images.example.com/logo-1.jpg", "name": "Stylish Shoreditch Loft with Balcony" }, "applyUrl": "https://example.com/item-1", "benefits": [ "sample" ], "location": { "city": "London", "region": "London", "remote": true, "country": "London", "formatted": "sample", "postalCode": "sample", "jobLocationType": "London" }, "datePosted": "sample", "description": "Sample description 1", "directApply": true, "validThrough": "id-1", "employmentType": [ "sample" ], "descriptionText": "Sample descriptiontext 1" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "jobKey", "title", "url", "company", "location", "salary", "employmentType", "description", "descriptionText", "benefits", "datePosted", "validThrough", "directApply", "applyUrl" ], "properties": { "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "salary": { "type": "object", "required": [ "min", "max", "currency", "type", "text", "source" ], "properties": { "max": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "min": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "company": { "type": "object", "required": [ "name", "url", "logo" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logo": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "applyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "benefits": { "type": "array", "items": { "type": "string" } }, "location": { "type": "object", "required": [ "formatted", "city", "region", "postalCode", "country", "remote", "jobLocationType" ], "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "remote": { "type": "boolean" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "formatted": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobLocationType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "datePosted": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "directApply": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "validThrough": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employmentType": { "type": "array", "items": { "type": "string" } }, "descriptionText": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-job", "task_name": "Indeed job details", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runIndeedJobAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Full Indeed job URL — typically the `link` from a prior `indeed/search` response." }, "domain": { "type": "string", "pattern": "^[a-z0-9.-]+\\.indeed\\.com$", "description": "Indeed regional domain (default www.indeed.com). Only used when jobKey is provided." }, "jobKey": { "type": "string", "description": "Indeed job key (e.g. `a61c6e343c845e92`) — the `jobKey` field from `indeed/search`. Use instead of url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "jobKey" ] } ] }, "example": { "url": "https://example.com/item-1" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-indeed-job" }, "x-browsable-website-login-required": false } }, "/v1/tasks/indeed-salaries/runs": { "post": { "tags": [ "Indeed" ], "summary": "Indeed Salaries API", "description": "Scrape public Indeed company salary pages.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-salaries", "task_name": "Indeed Salaries API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-salaries", "task_name": "Indeed Salaries API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runIndeedSalariesCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Google", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Google" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Google" } } } }, "x-browsable-website-login-required": false } }, "/v1/indeed/salaries": { "post": { "tags": [ "Indeed" ], "summary": "Indeed Salaries API", "description": "Scrape public Indeed company salary pages.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-salaries", "task_name": "Indeed Salaries API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-salaries", "task_name": "Indeed Salaries API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runIndeedSalariesAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Google", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Google" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Google" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-indeed-salaries" }, "x-browsable-website-login-required": false } }, "/v1/tasks/indeed-search/runs": { "post": { "tags": [ "Indeed" ], "summary": "Indeed job search", "description": "Search Indeed for job postings matching a query (and optional location), returning normalized listings with title, company, location, salary, snippet, posted-date, and the canonical Indeed job URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "jobKey", "title", "company", "companyRating", "companyReviewCount", "location", "city", "region", "postalCode", "remote", "salary", "salaryMin", "salaryMax", "salaryType", "jobTypes", "snippet", "postedRelative", "postedAt", "link", "sponsored", "urgentlyHiring", "indeedApplyable", "thirdPartyApplyUrl" ], "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "remote": { "type": "boolean" }, "salary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobTypes": { "type": "array", "items": { "type": "string" } }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "salaryMax": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "salaryMin": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sponsored": { "type": "boolean" }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "salaryType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyRating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "postedRelative": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgentlyHiring": { "type": "boolean" }, "indeedApplyable": { "type": "boolean" }, "companyReviewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thirdPartyApplyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-search", "task_name": "Indeed job search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "results": [ { "city": "London", "link": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "jobKey": "sample", "region": "London", "remote": true, "salary": "180", "company": "sample", "snippet": "sample", "jobTypes": [ "sample" ], "location": "London", "postedAt": "sample", "salaryMax": 180, "salaryMin": 180, "sponsored": true, "postalCode": "sample", "salaryType": "180", "companyRating": 4.91, "postedRelative": "sample", "urgentlyHiring": true, "indeedApplyable": true, "companyReviewCount": 1, "thirdPartyApplyUrl": "https://example.com/item-1" } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "jobKey", "title", "company", "companyRating", "companyReviewCount", "location", "city", "region", "postalCode", "remote", "salary", "salaryMin", "salaryMax", "salaryType", "jobTypes", "snippet", "postedRelative", "postedAt", "link", "sponsored", "urgentlyHiring", "indeedApplyable", "thirdPartyApplyUrl" ], "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "remote": { "type": "boolean" }, "salary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobTypes": { "type": "array", "items": { "type": "string" } }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "salaryMax": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "salaryMin": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sponsored": { "type": "boolean" }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "salaryType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyRating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "postedRelative": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgentlyHiring": { "type": "boolean" }, "indeedApplyable": { "type": "boolean" }, "companyReviewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thirdPartyApplyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-search", "task_name": "Indeed job search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runIndeedSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "How many result pages to fetch (each ~15 jobs). Defaults to 1." }, "query": { "type": "string", "maxLength": 200, "minLength": 1, "description": "Job search query — title, skill, or keywords (e.g. 'software engineer', 'nurse')." }, "domain": { "type": "string", "pattern": "^[a-z0-9.-]+\\.indeed\\.com$", "description": "Indeed regional domain (default www.indeed.com). Examples: 'uk.indeed.com', 'ca.indeed.com', 'de.indeed.com'." }, "location": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Location filter — city, state, postcode, or 'Remote'. Leave empty to search everywhere on the chosen domain." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "x-browsable-website-login-required": false } }, "/v1/indeed/search": { "post": { "tags": [ "Indeed" ], "summary": "Indeed job search", "description": "Search Indeed for job postings matching a query (and optional location), returning normalized listings with title, company, location, salary, snippet, posted-date, and the canonical Indeed job URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "jobKey", "title", "company", "companyRating", "companyReviewCount", "location", "city", "region", "postalCode", "remote", "salary", "salaryMin", "salaryMax", "salaryType", "jobTypes", "snippet", "postedRelative", "postedAt", "link", "sponsored", "urgentlyHiring", "indeedApplyable", "thirdPartyApplyUrl" ], "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "remote": { "type": "boolean" }, "salary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobTypes": { "type": "array", "items": { "type": "string" } }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "salaryMax": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "salaryMin": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sponsored": { "type": "boolean" }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "salaryType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyRating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "postedRelative": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgentlyHiring": { "type": "boolean" }, "indeedApplyable": { "type": "boolean" }, "companyReviewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thirdPartyApplyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-search", "task_name": "Indeed job search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "results": [ { "city": "London", "link": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "jobKey": "sample", "region": "London", "remote": true, "salary": "180", "company": "sample", "snippet": "sample", "jobTypes": [ "sample" ], "location": "London", "postedAt": "sample", "salaryMax": 180, "salaryMin": 180, "sponsored": true, "postalCode": "sample", "salaryType": "180", "companyRating": 4.91, "postedRelative": "sample", "urgentlyHiring": true, "indeedApplyable": true, "companyReviewCount": 1, "thirdPartyApplyUrl": "https://example.com/item-1" } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "jobKey", "title", "company", "companyRating", "companyReviewCount", "location", "city", "region", "postalCode", "remote", "salary", "salaryMin", "salaryMax", "salaryType", "jobTypes", "snippet", "postedRelative", "postedAt", "link", "sponsored", "urgentlyHiring", "indeedApplyable", "thirdPartyApplyUrl" ], "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "remote": { "type": "boolean" }, "salary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobTypes": { "type": "array", "items": { "type": "string" } }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "salaryMax": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "salaryMin": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sponsored": { "type": "boolean" }, "postalCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "salaryType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyRating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "postedRelative": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "urgentlyHiring": { "type": "boolean" }, "indeedApplyable": { "type": "boolean" }, "companyReviewCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thirdPartyApplyUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "indeed-search", "task_name": "Indeed job search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runIndeedSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "How many result pages to fetch (each ~15 jobs). Defaults to 1." }, "query": { "type": "string", "maxLength": 200, "minLength": 1, "description": "Job search query — title, skill, or keywords (e.g. 'software engineer', 'nurse')." }, "domain": { "type": "string", "pattern": "^[a-z0-9.-]+\\.indeed\\.com$", "description": "Indeed regional domain (default www.indeed.com). Examples: 'uk.indeed.com', 'ca.indeed.com', 'de.indeed.com'." }, "location": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Location filter — city, state, postcode, or 'Remote'. Leave empty to search everywhere on the chosen domain." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-indeed-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/instagram-feed/runs": { "post": { "tags": [ "Instagram" ], "summary": "Instagram Authenticated Feed", "description": "Fetch your Instagram home feed using a managed website login for instagram.com.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ {}, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-feed", "task_name": "Instagram Authenticated Feed", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": "sample", "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ {}, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-feed", "task_name": "Instagram Authenticated Feed", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runInstagramFeedCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "after": { "type": "string", "x-sample": "", "description": "Pagination cursor from a previous feed response.", "x-placeholder": "e.g. cursor_string" }, "count": { "type": "integer", "x-sample": "12", "x-advanced": true, "description": "Number of feed posts to fetch. You can also use limit.", "x-placeholder": "e.g. 12" }, "limit": { "type": "integer", "x-sample": "12", "description": "Number of feed posts to fetch. Preferred name; count remains supported.", "x-placeholder": "e.g. 12" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "x-browsable-website-login-required": true } }, "/v1/instagram/feed": { "post": { "tags": [ "Instagram" ], "summary": "Instagram Authenticated Feed", "description": "Fetch your Instagram home feed using a managed website login for instagram.com.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ {}, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-feed", "task_name": "Instagram Authenticated Feed", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": "sample", "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ {}, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-feed", "task_name": "Instagram Authenticated Feed", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runInstagramFeedAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "after": { "type": "string", "x-sample": "", "description": "Pagination cursor from a previous feed response.", "x-placeholder": "e.g. cursor_string" }, "count": { "type": "integer", "x-sample": "12", "x-advanced": true, "description": "Number of feed posts to fetch. You can also use limit.", "x-placeholder": "e.g. 12" }, "limit": { "type": "integer", "x-sample": "12", "description": "Number of feed posts to fetch. Preferred name; count remains supported.", "x-placeholder": "e.g. 12" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-instagram-feed" }, "x-browsable-website-login-required": true } }, "/v1/tasks/instagram-hashtag-posts/runs": { "post": { "tags": [ "Instagram" ], "summary": "Instagram Hashtag Posts", "description": "Retrieve public Instagram posts for a hashtag. This endpoint does not retrieve posts tagging a user.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-hashtag-posts", "task_name": "Instagram Hashtag Posts", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-hashtag-posts", "task_name": "Instagram Hashtag Posts", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runInstagramHashtagPostsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "streetphotography", "maxLength": 2000, "minLength": 1, "deprecated": true, "description": "Compatibility input for hashtag. Prefer hashtag.", "x-placeholder": "e.g. streetphotography" }, "hashtag": { "type": "string", "x-sample": "streetphotography", "maxLength": 500, "minLength": 1, "description": "Hashtag, with or without the leading #." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "hashtag" ] }, { "required": [ "query" ] } ] }, "example": { "hashtag": "streetphotography" } } } }, "x-browsable-website-login-required": false } }, "/v1/instagram/hashtag-posts": { "post": { "tags": [ "Instagram" ], "summary": "Instagram Hashtag Posts", "description": "Retrieve public Instagram posts for a hashtag. This endpoint does not retrieve posts tagging a user.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-hashtag-posts", "task_name": "Instagram Hashtag Posts", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-hashtag-posts", "task_name": "Instagram Hashtag Posts", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runInstagramHashtagPostsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "streetphotography", "maxLength": 2000, "minLength": 1, "deprecated": true, "description": "Compatibility input for hashtag. Prefer hashtag.", "x-placeholder": "e.g. streetphotography" }, "hashtag": { "type": "string", "x-sample": "streetphotography", "maxLength": 500, "minLength": 1, "description": "Hashtag, with or without the leading #." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "hashtag" ] }, { "required": [ "query" ] } ] }, "example": { "hashtag": "streetphotography" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-instagram-hashtag-posts" }, "x-browsable-website-login-required": false } }, "/v1/tasks/instagram-profile/runs": { "post": { "tags": [ "Instagram" ], "summary": "Instagram Public Profile", "description": "Fetch a public Instagram profile anonymously, including profile metadata and paginated posts.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "posts", "pagination" ], "properties": { "posts": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "media_type", "is_video" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_video": { "type": "boolean" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dimensions": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "additionalProperties": false }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "media_type": { "type": "number" }, "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "media_items": { "type": "array", "items": { "type": "object" } }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true } }, "profile": { "type": "object", "required": [ "id", "username", "followers", "following", "total_posts", "is_private", "is_verified" ], "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "biography": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "type": "number" }, "following": { "type": "number" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_private": { "type": "boolean" }, "is_verified": { "type": "boolean" }, "total_posts": { "type": "number" }, "external_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "end_cursor", "count" ], "properties": { "count": { "type": "number" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-profile", "task_name": "Instagram Public Profile", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "posts": [ { "id": "id-1", "code": "sample", "owner": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony" }, "caption": "sample", "is_video": true, "media_url": "https://example.com/item-1", "timestamp": "sample", "dimensions": { "width": 1.5, "height": 1.5 }, "like_count": 1, "media_type": 1.5, "display_url": "https://example.com/item-1", "media_items": [ {} ], "comment_count": 1, "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "accessibility_caption": "sample" } ], "profile": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "biography": "sample", "followers": 1.5, "following": 1.5, "full_name": "Stylish Shoreditch Loft with Balcony", "is_private": true, "is_verified": true, "total_posts": 180, "external_url": "https://example.com/item-1", "profile_pic_url": "https://example.com/item-1", "profile_pic_url_hd": "https://example.com/item-1" }, "success": true, "pagination": { "count": 1, "end_cursor": "cursor-page-1", "has_next_page": true } }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "posts", "pagination" ], "properties": { "posts": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "media_type", "is_video" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_video": { "type": "boolean" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dimensions": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "additionalProperties": false }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "media_type": { "type": "number" }, "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "media_items": { "type": "array", "items": { "type": "object" } }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true } }, "profile": { "type": "object", "required": [ "id", "username", "followers", "following", "total_posts", "is_private", "is_verified" ], "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "biography": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "type": "number" }, "following": { "type": "number" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_private": { "type": "boolean" }, "is_verified": { "type": "boolean" }, "total_posts": { "type": "number" }, "external_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "end_cursor", "count" ], "properties": { "count": { "type": "number" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-profile", "task_name": "Instagram Public Profile", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runInstagramProfileCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "after": { "type": "string", "x-sample": "", "description": "Pagination cursor from a previous response.", "x-placeholder": "e.g. QVFDdU5pVV9f..." }, "count": { "type": "integer", "default": 12, "maximum": 50, "minimum": 1, "x-sample": "12", "x-advanced": true, "description": "Number of posts to fetch (1-50). You can also use limit.", "x-placeholder": "e.g. 12" }, "limit": { "type": "integer", "default": 12, "maximum": 50, "minimum": 1, "x-sample": "12", "description": "Number of posts to fetch (1-50). Preferred name; count remains supported.", "x-placeholder": "e.g. 12" }, "username": { "type": "string", "x-sample": "natgeo", "maxLength": 2000, "minLength": 1, "description": "Instagram username to scrape anonymously.", "x-placeholder": "e.g. natgeo" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "natgeo" } } } }, "x-browsable-website-login-required": false } }, "/v1/instagram/profile": { "post": { "tags": [ "Instagram" ], "summary": "Instagram Public Profile", "description": "Fetch a public Instagram profile anonymously, including profile metadata and paginated posts.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "posts", "pagination" ], "properties": { "posts": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "media_type", "is_video" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_video": { "type": "boolean" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dimensions": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "additionalProperties": false }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "media_type": { "type": "number" }, "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "media_items": { "type": "array", "items": { "type": "object" } }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true } }, "profile": { "type": "object", "required": [ "id", "username", "followers", "following", "total_posts", "is_private", "is_verified" ], "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "biography": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "type": "number" }, "following": { "type": "number" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_private": { "type": "boolean" }, "is_verified": { "type": "boolean" }, "total_posts": { "type": "number" }, "external_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "end_cursor", "count" ], "properties": { "count": { "type": "number" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-profile", "task_name": "Instagram Public Profile", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "posts": [ { "id": "id-1", "code": "sample", "owner": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony" }, "caption": "sample", "is_video": true, "media_url": "https://example.com/item-1", "timestamp": "sample", "dimensions": { "width": 1.5, "height": 1.5 }, "like_count": 1, "media_type": 1.5, "display_url": "https://example.com/item-1", "media_items": [ {} ], "comment_count": 1, "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "accessibility_caption": "sample" } ], "profile": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "biography": "sample", "followers": 1.5, "following": 1.5, "full_name": "Stylish Shoreditch Loft with Balcony", "is_private": true, "is_verified": true, "total_posts": 180, "external_url": "https://example.com/item-1", "profile_pic_url": "https://example.com/item-1", "profile_pic_url_hd": "https://example.com/item-1" }, "success": true, "pagination": { "count": 1, "end_cursor": "cursor-page-1", "has_next_page": true } }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "posts", "pagination" ], "properties": { "posts": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "media_type", "is_video" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_video": { "type": "boolean" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dimensions": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "additionalProperties": false }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "media_type": { "type": "number" }, "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "media_items": { "type": "array", "items": { "type": "object" } }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true } }, "profile": { "type": "object", "required": [ "id", "username", "followers", "following", "total_posts", "is_private", "is_verified" ], "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "biography": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "type": "number" }, "following": { "type": "number" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_private": { "type": "boolean" }, "is_verified": { "type": "boolean" }, "total_posts": { "type": "number" }, "external_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "end_cursor", "count" ], "properties": { "count": { "type": "number" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-profile", "task_name": "Instagram Public Profile", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runInstagramProfileAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "after": { "type": "string", "x-sample": "", "description": "Pagination cursor from a previous response.", "x-placeholder": "e.g. QVFDdU5pVV9f..." }, "count": { "type": "integer", "default": 12, "maximum": 50, "minimum": 1, "x-sample": "12", "x-advanced": true, "description": "Number of posts to fetch (1-50). You can also use limit.", "x-placeholder": "e.g. 12" }, "limit": { "type": "integer", "default": 12, "maximum": 50, "minimum": 1, "x-sample": "12", "description": "Number of posts to fetch (1-50). Preferred name; count remains supported.", "x-placeholder": "e.g. 12" }, "username": { "type": "string", "x-sample": "natgeo", "maxLength": 2000, "minLength": 1, "description": "Instagram username to scrape anonymously.", "x-placeholder": "e.g. natgeo" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "natgeo" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-instagram-profile" }, "x-browsable-website-login-required": false } }, "/v1/tasks/instagram-profile-download/runs": { "post": { "tags": [ "Instagram" ], "summary": "Instagram Profile Download", "description": "Export a full public Instagram profile as a ZIP file with media, captions, post metadata, manifest.json, and posts.csv. Authenticated runs are recommended in async mode. Pricing depends on account eligibility and profile size. See the Instagram profile downloader in your dashboard for your starting price.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "The result begins with an export ID. A completed run returns artifact details, download expiry and collection statistics. partial_success means some media could not be downloaded; inspect failed_media.", "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "export_id": { "type": "string", "description": "Export identifier. Poll the run until it succeeds before downloading." }, "status": { "type": "string", "enum": [ "completed", "partial_success", "pending" ] }, "file_name": { "type": "string" }, "download_url": { "type": "string", "description": "Short-lived signed download URL. It can be a pending:// placeholder before the artifact is ready." }, "download_url_expires_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "max_posts": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" }, "profile": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "full_name": { "type": [ "string", "null" ] }, "is_private": { "type": "boolean" }, "total_posts": { "type": "number" }, "profile_pic_url": { "type": [ "string", "null" ] }, "authenticated": { "type": "boolean" } }, "required": [ "id", "username", "full_name", "is_private", "total_posts", "profile_pic_url", "authenticated" ], "additionalProperties": false }, "result_summary": { "type": "object", "properties": { "postsDiscovered": { "type": "number" }, "mediaDiscovered": { "type": "number" }, "estimatedBytes": { "type": "number" }, "downloadedFiles": { "type": "number" }, "failedFiles": { "type": "number" }, "skippedFiles": { "type": "number" }, "truncated": { "type": "boolean" }, "postsDownloaded": { "type": "number" } }, "required": [ "postsDiscovered", "mediaDiscovered", "estimatedBytes", "downloadedFiles", "failedFiles", "skippedFiles", "truncated", "postsDownloaded" ], "additionalProperties": false }, "failed_media": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": [ "string", "null" ] }, "post_code": { "type": [ "string", "null" ] }, "post_url": { "type": [ "string", "null" ] }, "post_index": { "type": [ "number", "null" ] }, "media_index": { "type": [ "number", "null" ] }, "media_id": { "type": [ "string", "null" ] }, "file_name": { "type": [ "string", "null" ] }, "failure_reason": { "type": "string" } }, "required": [ "post_id", "post_code", "post_url", "post_index", "media_index", "media_id", "file_name", "failure_reason" ], "additionalProperties": false } } }, "required": [ "success", "export_id", "status", "file_name", "download_url", "download_url_expires_at", "expires_at", "error_code", "error_message", "max_posts", "truncated", "profile", "result_summary", "failed_media" ], "additionalProperties": false }, { "type": "object", "properties": { "export_id": { "type": "string" } }, "required": [ "export_id" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-profile-download", "task_name": "Instagram Profile Download", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "success": true, "export_id": "id-1", "status": "completed", "file_name": "Stylish Shoreditch Loft with Balcony", "download_url": "https://example.com/item-1", "download_url_expires_at": "https://example.com/item-1", "expires_at": "sample", "error_code": "sample", "error_message": "sample", "max_posts": 1.5, "truncated": true, "profile": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "full_name": "Stylish Shoreditch Loft with Balcony", "is_private": true, "total_posts": 180, "profile_pic_url": "https://example.com/item-1", "authenticated": true }, "result_summary": { "postsDiscovered": 1.5, "mediaDiscovered": 1.5, "estimatedBytes": 1.5, "downloadedFiles": 1.5, "failedFiles": 1.5, "skippedFiles": 1.5, "truncated": true, "postsDownloaded": 1.5 }, "failed_media": [ { "post_id": "id-1", "post_code": "sample", "post_url": "https://example.com/item-1", "post_index": 1.5, "media_index": 1.5, "media_id": "id-1", "file_name": "Stylish Shoreditch Loft with Balcony", "failure_reason": "sample" } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "The result begins with an export ID. A completed run returns artifact details, download expiry and collection statistics. partial_success means some media could not be downloaded; inspect failed_media.", "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "export_id": { "type": "string", "description": "Export identifier. Poll the run until it succeeds before downloading." }, "status": { "type": "string", "enum": [ "completed", "partial_success", "pending" ] }, "file_name": { "type": "string" }, "download_url": { "type": "string", "description": "Short-lived signed download URL. It can be a pending:// placeholder before the artifact is ready." }, "download_url_expires_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "max_posts": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" }, "profile": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "full_name": { "type": [ "string", "null" ] }, "is_private": { "type": "boolean" }, "total_posts": { "type": "number" }, "profile_pic_url": { "type": [ "string", "null" ] }, "authenticated": { "type": "boolean" } }, "required": [ "id", "username", "full_name", "is_private", "total_posts", "profile_pic_url", "authenticated" ], "additionalProperties": false }, "result_summary": { "type": "object", "properties": { "postsDiscovered": { "type": "number" }, "mediaDiscovered": { "type": "number" }, "estimatedBytes": { "type": "number" }, "downloadedFiles": { "type": "number" }, "failedFiles": { "type": "number" }, "skippedFiles": { "type": "number" }, "truncated": { "type": "boolean" }, "postsDownloaded": { "type": "number" } }, "required": [ "postsDiscovered", "mediaDiscovered", "estimatedBytes", "downloadedFiles", "failedFiles", "skippedFiles", "truncated", "postsDownloaded" ], "additionalProperties": false }, "failed_media": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": [ "string", "null" ] }, "post_code": { "type": [ "string", "null" ] }, "post_url": { "type": [ "string", "null" ] }, "post_index": { "type": [ "number", "null" ] }, "media_index": { "type": [ "number", "null" ] }, "media_id": { "type": [ "string", "null" ] }, "file_name": { "type": [ "string", "null" ] }, "failure_reason": { "type": "string" } }, "required": [ "post_id", "post_code", "post_url", "post_index", "media_index", "media_id", "file_name", "failure_reason" ], "additionalProperties": false } } }, "required": [ "success", "export_id", "status", "file_name", "download_url", "download_url_expires_at", "expires_at", "error_code", "error_message", "max_posts", "truncated", "profile", "result_summary", "failed_media" ], "additionalProperties": false }, { "type": "object", "properties": { "export_id": { "type": "string" } }, "required": [ "export_id" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-profile-download", "task_name": "Instagram Profile Download", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runInstagramProfileDownloadCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "maximum": 100000, "minimum": 1, "x-sample": "1000", "description": "Optional maximum number of posts to include. Omit this field to export the full public profile. Preferred name; maxPosts remains supported.", "x-placeholder": "e.g. 1000" }, "profile": { "type": "string", "x-sample": "natgeo", "maxLength": 2000, "minLength": 1, "description": "Instagram username, @handle, or profile URL to export as a ZIP file.", "x-placeholder": "e.g. https://www.instagram.com/natgeo/" }, "maxPosts": { "type": "integer", "maximum": 100000, "minimum": 1, "x-sample": "1000", "x-advanced": true, "description": "Optional maximum number of posts to include. Omit this field to export the full public profile. You can also use limit.", "x-placeholder": "e.g. 1000" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "profile" ] }, "example": { "profile": "natgeo" } } } }, "x-browsable-website-login-required": false } }, "/v1/instagram/profile-download": { "post": { "tags": [ "Instagram" ], "summary": "Instagram Profile Download", "description": "Export a full public Instagram profile as a ZIP file with media, captions, post metadata, manifest.json, and posts.csv. Authenticated runs are recommended in async mode. Pricing depends on account eligibility and profile size. See the Instagram profile downloader in your dashboard for your starting price.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "The result begins with an export ID. A completed run returns artifact details, download expiry and collection statistics. partial_success means some media could not be downloaded; inspect failed_media.", "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "export_id": { "type": "string", "description": "Export identifier. Poll the run until it succeeds before downloading." }, "status": { "type": "string", "enum": [ "completed", "partial_success", "pending" ] }, "file_name": { "type": "string" }, "download_url": { "type": "string", "description": "Short-lived signed download URL. It can be a pending:// placeholder before the artifact is ready." }, "download_url_expires_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "max_posts": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" }, "profile": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "full_name": { "type": [ "string", "null" ] }, "is_private": { "type": "boolean" }, "total_posts": { "type": "number" }, "profile_pic_url": { "type": [ "string", "null" ] }, "authenticated": { "type": "boolean" } }, "required": [ "id", "username", "full_name", "is_private", "total_posts", "profile_pic_url", "authenticated" ], "additionalProperties": false }, "result_summary": { "type": "object", "properties": { "postsDiscovered": { "type": "number" }, "mediaDiscovered": { "type": "number" }, "estimatedBytes": { "type": "number" }, "downloadedFiles": { "type": "number" }, "failedFiles": { "type": "number" }, "skippedFiles": { "type": "number" }, "truncated": { "type": "boolean" }, "postsDownloaded": { "type": "number" } }, "required": [ "postsDiscovered", "mediaDiscovered", "estimatedBytes", "downloadedFiles", "failedFiles", "skippedFiles", "truncated", "postsDownloaded" ], "additionalProperties": false }, "failed_media": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": [ "string", "null" ] }, "post_code": { "type": [ "string", "null" ] }, "post_url": { "type": [ "string", "null" ] }, "post_index": { "type": [ "number", "null" ] }, "media_index": { "type": [ "number", "null" ] }, "media_id": { "type": [ "string", "null" ] }, "file_name": { "type": [ "string", "null" ] }, "failure_reason": { "type": "string" } }, "required": [ "post_id", "post_code", "post_url", "post_index", "media_index", "media_id", "file_name", "failure_reason" ], "additionalProperties": false } } }, "required": [ "success", "export_id", "status", "file_name", "download_url", "download_url_expires_at", "expires_at", "error_code", "error_message", "max_posts", "truncated", "profile", "result_summary", "failed_media" ], "additionalProperties": false }, { "type": "object", "properties": { "export_id": { "type": "string" } }, "required": [ "export_id" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-profile-download", "task_name": "Instagram Profile Download", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "success": true, "export_id": "id-1", "status": "completed", "file_name": "Stylish Shoreditch Loft with Balcony", "download_url": "https://example.com/item-1", "download_url_expires_at": "https://example.com/item-1", "expires_at": "sample", "error_code": "sample", "error_message": "sample", "max_posts": 1.5, "truncated": true, "profile": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "full_name": "Stylish Shoreditch Loft with Balcony", "is_private": true, "total_posts": 180, "profile_pic_url": "https://example.com/item-1", "authenticated": true }, "result_summary": { "postsDiscovered": 1.5, "mediaDiscovered": 1.5, "estimatedBytes": 1.5, "downloadedFiles": 1.5, "failedFiles": 1.5, "skippedFiles": 1.5, "truncated": true, "postsDownloaded": 1.5 }, "failed_media": [ { "post_id": "id-1", "post_code": "sample", "post_url": "https://example.com/item-1", "post_index": 1.5, "media_index": 1.5, "media_id": "id-1", "file_name": "Stylish Shoreditch Loft with Balcony", "failure_reason": "sample" } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "The result begins with an export ID. A completed run returns artifact details, download expiry and collection statistics. partial_success means some media could not be downloaded; inspect failed_media.", "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "export_id": { "type": "string", "description": "Export identifier. Poll the run until it succeeds before downloading." }, "status": { "type": "string", "enum": [ "completed", "partial_success", "pending" ] }, "file_name": { "type": "string" }, "download_url": { "type": "string", "description": "Short-lived signed download URL. It can be a pending:// placeholder before the artifact is ready." }, "download_url_expires_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "max_posts": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" }, "profile": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "full_name": { "type": [ "string", "null" ] }, "is_private": { "type": "boolean" }, "total_posts": { "type": "number" }, "profile_pic_url": { "type": [ "string", "null" ] }, "authenticated": { "type": "boolean" } }, "required": [ "id", "username", "full_name", "is_private", "total_posts", "profile_pic_url", "authenticated" ], "additionalProperties": false }, "result_summary": { "type": "object", "properties": { "postsDiscovered": { "type": "number" }, "mediaDiscovered": { "type": "number" }, "estimatedBytes": { "type": "number" }, "downloadedFiles": { "type": "number" }, "failedFiles": { "type": "number" }, "skippedFiles": { "type": "number" }, "truncated": { "type": "boolean" }, "postsDownloaded": { "type": "number" } }, "required": [ "postsDiscovered", "mediaDiscovered", "estimatedBytes", "downloadedFiles", "failedFiles", "skippedFiles", "truncated", "postsDownloaded" ], "additionalProperties": false }, "failed_media": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": [ "string", "null" ] }, "post_code": { "type": [ "string", "null" ] }, "post_url": { "type": [ "string", "null" ] }, "post_index": { "type": [ "number", "null" ] }, "media_index": { "type": [ "number", "null" ] }, "media_id": { "type": [ "string", "null" ] }, "file_name": { "type": [ "string", "null" ] }, "failure_reason": { "type": "string" } }, "required": [ "post_id", "post_code", "post_url", "post_index", "media_index", "media_id", "file_name", "failure_reason" ], "additionalProperties": false } } }, "required": [ "success", "export_id", "status", "file_name", "download_url", "download_url_expires_at", "expires_at", "error_code", "error_message", "max_posts", "truncated", "profile", "result_summary", "failed_media" ], "additionalProperties": false }, { "type": "object", "properties": { "export_id": { "type": "string" } }, "required": [ "export_id" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-profile-download", "task_name": "Instagram Profile Download", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runInstagramProfileDownloadAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "maximum": 100000, "minimum": 1, "x-sample": "1000", "description": "Optional maximum number of posts to include. Omit this field to export the full public profile. Preferred name; maxPosts remains supported.", "x-placeholder": "e.g. 1000" }, "profile": { "type": "string", "x-sample": "natgeo", "maxLength": 2000, "minLength": 1, "description": "Instagram username, @handle, or profile URL to export as a ZIP file.", "x-placeholder": "e.g. https://www.instagram.com/natgeo/" }, "maxPosts": { "type": "integer", "maximum": 100000, "minimum": 1, "x-sample": "1000", "x-advanced": true, "description": "Optional maximum number of posts to include. Omit this field to export the full public profile. You can also use limit.", "x-placeholder": "e.g. 1000" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "profile" ] }, "example": { "profile": "natgeo" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-instagram-profile-download" }, "x-browsable-website-login-required": false } }, "/v1/tasks/instagram-public-profile/runs": { "post": { "tags": [ "Instagram" ], "summary": "Instagram Public Profile (No Auth)", "description": "Fetch a public Instagram profile anonymously, including profile metadata and paginated posts.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "posts", "pagination" ], "properties": { "posts": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "media_type", "is_video" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_video": { "type": "boolean" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dimensions": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "additionalProperties": false }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "media_type": { "type": "number" }, "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "media_items": { "type": "array", "items": { "type": "object" } }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true } }, "profile": { "type": "object", "required": [ "id", "username", "followers", "following", "total_posts", "is_private", "is_verified" ], "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "biography": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "type": "number" }, "following": { "type": "number" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_private": { "type": "boolean" }, "is_verified": { "type": "boolean" }, "total_posts": { "type": "number" }, "external_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "end_cursor", "count" ], "properties": { "count": { "type": "number" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-public-profile", "task_name": "Instagram Public Profile (No Auth)", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "posts": [ { "id": "id-1", "code": "sample", "owner": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony" }, "caption": "sample", "is_video": true, "media_url": "https://example.com/item-1", "timestamp": "sample", "dimensions": { "width": 1.5, "height": 1.5 }, "like_count": 1, "media_type": 1.5, "display_url": "https://example.com/item-1", "media_items": [ {} ], "comment_count": 1, "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "accessibility_caption": "sample" } ], "profile": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "biography": "sample", "followers": 1.5, "following": 1.5, "full_name": "Stylish Shoreditch Loft with Balcony", "is_private": true, "is_verified": true, "total_posts": 180, "external_url": "https://example.com/item-1", "profile_pic_url": "https://example.com/item-1", "profile_pic_url_hd": "https://example.com/item-1" }, "success": true, "pagination": { "count": 1, "end_cursor": "cursor-page-1", "has_next_page": true } }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "posts", "pagination" ], "properties": { "posts": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "media_type", "is_video" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_video": { "type": "boolean" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dimensions": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "additionalProperties": false }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "media_type": { "type": "number" }, "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "media_items": { "type": "array", "items": { "type": "object" } }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true } }, "profile": { "type": "object", "required": [ "id", "username", "followers", "following", "total_posts", "is_private", "is_verified" ], "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "biography": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "type": "number" }, "following": { "type": "number" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_private": { "type": "boolean" }, "is_verified": { "type": "boolean" }, "total_posts": { "type": "number" }, "external_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "end_cursor", "count" ], "properties": { "count": { "type": "number" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-public-profile", "task_name": "Instagram Public Profile (No Auth)", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runInstagramPublicProfileCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "after": { "type": "string", "x-sample": "", "description": "Pagination cursor from a previous response.", "x-placeholder": "e.g. QVFDdU5pVV9f..." }, "count": { "type": "integer", "default": 12, "maximum": 50, "minimum": 1, "x-sample": "12", "x-advanced": true, "description": "Number of posts to fetch (1-50). You can also use limit.", "x-placeholder": "e.g. 12" }, "limit": { "type": "integer", "default": 12, "maximum": 50, "minimum": 1, "x-sample": "12", "description": "Number of posts to fetch (1-50). Preferred name; count remains supported.", "x-placeholder": "e.g. 12" }, "username": { "type": "string", "x-sample": "natgeo", "maxLength": 2000, "minLength": 1, "description": "Instagram username to scrape anonymously.", "x-placeholder": "e.g. natgeo" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "natgeo" } } } }, "x-browsable-website-login-required": false } }, "/v1/instagram/public-profile": { "post": { "tags": [ "Instagram" ], "summary": "Instagram Public Profile (No Auth)", "description": "Fetch a public Instagram profile anonymously, including profile metadata and paginated posts.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "posts", "pagination" ], "properties": { "posts": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "media_type", "is_video" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_video": { "type": "boolean" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dimensions": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "additionalProperties": false }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "media_type": { "type": "number" }, "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "media_items": { "type": "array", "items": { "type": "object" } }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true } }, "profile": { "type": "object", "required": [ "id", "username", "followers", "following", "total_posts", "is_private", "is_verified" ], "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "biography": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "type": "number" }, "following": { "type": "number" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_private": { "type": "boolean" }, "is_verified": { "type": "boolean" }, "total_posts": { "type": "number" }, "external_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "end_cursor", "count" ], "properties": { "count": { "type": "number" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-public-profile", "task_name": "Instagram Public Profile (No Auth)", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "posts": [ { "id": "id-1", "code": "sample", "owner": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony" }, "caption": "sample", "is_video": true, "media_url": "https://example.com/item-1", "timestamp": "sample", "dimensions": { "width": 1.5, "height": 1.5 }, "like_count": 1, "media_type": 1.5, "display_url": "https://example.com/item-1", "media_items": [ {} ], "comment_count": 1, "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "accessibility_caption": "sample" } ], "profile": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "biography": "sample", "followers": 1.5, "following": 1.5, "full_name": "Stylish Shoreditch Loft with Balcony", "is_private": true, "is_verified": true, "total_posts": 180, "external_url": "https://example.com/item-1", "profile_pic_url": "https://example.com/item-1", "profile_pic_url_hd": "https://example.com/item-1" }, "success": true, "pagination": { "count": 1, "end_cursor": "cursor-page-1", "has_next_page": true } }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "posts", "pagination" ], "properties": { "posts": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "media_type", "is_video" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_video": { "type": "boolean" }, "media_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dimensions": { "type": "object", "properties": { "width": { "type": "number" }, "height": { "type": "number" } }, "additionalProperties": false }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "media_type": { "type": "number" }, "display_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "media_items": { "type": "array", "items": { "type": "object" } }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accessibility_caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true } }, "profile": { "type": "object", "required": [ "id", "username", "followers", "following", "total_posts", "is_private", "is_verified" ], "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "biography": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "type": "number" }, "following": { "type": "number" }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_private": { "type": "boolean" }, "is_verified": { "type": "boolean" }, "total_posts": { "type": "number" }, "external_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_pic_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "end_cursor", "count" ], "properties": { "count": { "type": "number" }, "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-public-profile", "task_name": "Instagram Public Profile (No Auth)", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runInstagramPublicProfileAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "after": { "type": "string", "x-sample": "", "description": "Pagination cursor from a previous response.", "x-placeholder": "e.g. QVFDdU5pVV9f..." }, "count": { "type": "integer", "default": 12, "maximum": 50, "minimum": 1, "x-sample": "12", "x-advanced": true, "description": "Number of posts to fetch (1-50). You can also use limit.", "x-placeholder": "e.g. 12" }, "limit": { "type": "integer", "default": 12, "maximum": 50, "minimum": 1, "x-sample": "12", "description": "Number of posts to fetch (1-50). Preferred name; count remains supported.", "x-placeholder": "e.g. 12" }, "username": { "type": "string", "x-sample": "natgeo", "maxLength": 2000, "minLength": 1, "description": "Instagram username to scrape anonymously.", "x-placeholder": "e.g. natgeo" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "natgeo" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-instagram-public-profile" }, "x-browsable-website-login-required": false } }, "/v1/tasks/instagram-reels/runs": { "post": { "tags": [ "Instagram" ], "summary": "Instagram Reels API", "description": "Scrape public Instagram reels from a profile.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-reels", "task_name": "Instagram Reels API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-reels", "task_name": "Instagram Reels API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runInstagramReelsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "username": { "type": "string", "x-sample": "nasa", "maxLength": 2000, "minLength": 1, "description": "Instagram username.", "x-placeholder": "e.g. nasa" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "nasa" } } } }, "x-browsable-website-login-required": false } }, "/v1/instagram/reels": { "post": { "tags": [ "Instagram" ], "summary": "Instagram Reels API", "description": "Scrape public Instagram reels from a profile.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-reels", "task_name": "Instagram Reels API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "instagram-reels", "task_name": "Instagram Reels API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runInstagramReelsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "username": { "type": "string", "x-sample": "nasa", "maxLength": 2000, "minLength": 1, "description": "Instagram username.", "x-placeholder": "e.g. nasa" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "nasa" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-instagram-reels" }, "x-browsable-website-login-required": false } }, "/v1/tasks/kayak-search/runs": { "post": { "tags": [ "Kayak" ], "summary": "Kayak API", "description": "Scrape rendered public Kayak flight result pages from a flight query. Partner APIs require credentials.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "kayak-search", "task_name": "Kayak API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "kayak-search", "task_name": "Kayak API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runKayakSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "adults": { "type": "integer", "default": 1, "maximum": 9, "minimum": 1, "description": "Number of adult guests or travellers." }, "origin": { "type": "string", "x-sample": "NYC", "description": "Departure city or airport code, such as London or LHR. Use an airport code for a specific airport.", "x-placeholder": "e.g. NYC" }, "depart_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "x-sample": "2027-06-14", "description": "Departure date in YYYY-MM-DD format. Must not be in the past.", "x-placeholder": "e.g. 2026-07-01" }, "destination": { "type": "string", "x-sample": "LON", "description": "Arrival city or airport code, such as New York or JFK. Use an airport code for a specific airport.", "x-placeholder": "e.g. LON" }, "return_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "x-sample": "2027-06-21", "description": "Optional return date in YYYY-MM-DD format, on or after departure.", "x-placeholder": "e.g. 2026-07-08" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "origin", "depart_date", "destination" ] }, "example": { "origin": "NYC", "depart_date": "2027-06-14", "destination": "LON" } } } }, "x-browsable-website-login-required": false } }, "/v1/kayak/search": { "post": { "tags": [ "Kayak" ], "summary": "Kayak API", "description": "Scrape rendered public Kayak flight result pages from a flight query. Partner APIs require credentials.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "kayak-search", "task_name": "Kayak API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "kayak-search", "task_name": "Kayak API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runKayakSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "adults": { "type": "integer", "default": 1, "maximum": 9, "minimum": 1, "description": "Number of adult guests or travellers." }, "origin": { "type": "string", "x-sample": "NYC", "description": "Departure city or airport code, such as London or LHR. Use an airport code for a specific airport.", "x-placeholder": "e.g. NYC" }, "depart_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "x-sample": "2027-06-14", "description": "Departure date in YYYY-MM-DD format. Must not be in the past.", "x-placeholder": "e.g. 2026-07-01" }, "destination": { "type": "string", "x-sample": "LON", "description": "Arrival city or airport code, such as New York or JFK. Use an airport code for a specific airport.", "x-placeholder": "e.g. LON" }, "return_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "x-sample": "2027-06-21", "description": "Optional return date in YYYY-MM-DD format, on or after departure.", "x-placeholder": "e.g. 2026-07-08" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "origin", "depart_date", "destination" ] }, "example": { "origin": "NYC", "depart_date": "2027-06-14", "destination": "LON" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-kayak-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/kiwi-search/runs": { "post": { "tags": [ "Kiwi" ], "summary": "Kiwi API", "description": "Scrape rendered public Kiwi flight result pages from a flight query. Tequila API access requires credentials.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "kiwi-search", "task_name": "Kiwi API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "kiwi-search", "task_name": "Kiwi API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runKiwiSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "adults": { "type": "integer", "default": 1, "maximum": 9, "minimum": 1, "description": "Number of adult guests or travellers." }, "origin": { "type": "string", "x-sample": "new-york-city-ny-united-states", "description": "Departure city or airport code, such as London or LHR. Use an airport code for a specific airport.", "x-placeholder": "e.g. new-york-city-ny-united-states" }, "depart_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "x-sample": "2027-06-14", "description": "Departure date in YYYY-MM-DD format. Must not be in the past.", "x-placeholder": "e.g. 2026-07-01" }, "destination": { "type": "string", "x-sample": "lisbon-portugal", "description": "Arrival city or airport code, such as New York or JFK. Use an airport code for a specific airport.", "x-placeholder": "e.g. lisbon-portugal" }, "return_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "x-sample": "2027-06-21", "description": "Optional return date in YYYY-MM-DD format, on or after departure.", "x-placeholder": "e.g. 2026-07-08" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "origin", "depart_date", "destination" ] }, "example": { "origin": "new-york-city-ny-united-states", "depart_date": "2027-06-14", "destination": "lisbon-portugal" } } } }, "x-browsable-website-login-required": false } }, "/v1/kiwi/search": { "post": { "tags": [ "Kiwi" ], "summary": "Kiwi API", "description": "Scrape rendered public Kiwi flight result pages from a flight query. Tequila API access requires credentials.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "kiwi-search", "task_name": "Kiwi API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "kiwi-search", "task_name": "Kiwi API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runKiwiSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "adults": { "type": "integer", "default": 1, "maximum": 9, "minimum": 1, "description": "Number of adult guests or travellers." }, "origin": { "type": "string", "x-sample": "new-york-city-ny-united-states", "description": "Departure city or airport code, such as London or LHR. Use an airport code for a specific airport.", "x-placeholder": "e.g. new-york-city-ny-united-states" }, "depart_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "x-sample": "2027-06-14", "description": "Departure date in YYYY-MM-DD format. Must not be in the past.", "x-placeholder": "e.g. 2026-07-01" }, "destination": { "type": "string", "x-sample": "lisbon-portugal", "description": "Arrival city or airport code, such as New York or JFK. Use an airport code for a specific airport.", "x-placeholder": "e.g. lisbon-portugal" }, "return_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "x-sample": "2027-06-21", "description": "Optional return date in YYYY-MM-DD format, on or after departure.", "x-placeholder": "e.g. 2026-07-08" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "origin", "depart_date", "destination" ] }, "example": { "origin": "new-york-city-ny-united-states", "depart_date": "2027-06-14", "destination": "lisbon-portugal" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-kiwi-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/letterboxd-film/runs": { "post": { "tags": [ "Letterboxd" ], "summary": "Letterboxd Film API", "description": "Scrape a public Letterboxd film page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "required": [ "id", "type", "slug", "title", "full_title", "original_title", "year", "release_date", "url", "film_id", "uid", "letterboxd_id", "tmdb_id", "tmdb_type", "imdb_id", "external_urls", "description", "tagline", "runtime_minutes", "duration", "genres", "countries", "languages", "language_codes", "directors", "director_names", "cast", "cast_names", "crew", "image_url", "image_urls", "poster_images", "stats", "ratings", "popular_reviews" ], "properties": { "id": { "type": "string" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "cast": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "crew": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } } }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "const": "film" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "stats": { "type": "object", "properties": { "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "list_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "watched_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "additionalProperties": false }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "genres": { "type": "array", "items": { "type": "string" } }, "film_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "imdb_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ratings": { "type": "object", "required": [ "count", "calculated_average", "distribution" ], "properties": { "count": { "type": "integer" }, "distribution": { "type": "array", "items": { "type": "object", "required": [ "rating", "label", "count", "percentage" ], "properties": { "count": { "type": "integer" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "calculated_average": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "tagline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tmdb_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "countries": { "type": "array", "items": { "type": "string" } }, "directors": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "languages": { "type": "array", "items": { "type": "string" } }, "tmdb_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cast_names": { "type": "array", "items": { "type": "string" } }, "full_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "release_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "external_urls": { "type": "object", "required": [ "imdb", "tmdb" ], "properties": { "imdb": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tmdb": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "letterboxd_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "poster_images": { "type": "object", "required": [ "small", "medium", "large" ], "properties": { "large": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "small": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "director_names": { "type": "array", "items": { "type": "string" } }, "language_codes": { "type": "array", "items": { "type": "string" } }, "original_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "popular_reviews": { "type": "array", "items": { "type": "object", "required": [ "id", "reviewer_name", "reviewer_username", "url", "rating", "rating_label", "text", "like_count" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rating_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewer_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "runtime_minutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "const": "letterboxd-film" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "slug", "title", "full_title", "year", "url", "film_id", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "slug": { "type": "string" }, "type": { "const": "film" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "film_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "full_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "letterboxd-film", "task_name": "Letterboxd Film API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "uid": "id-1", "url": "https://example.com/item-1", "cast": [ { "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony" } ], "crew": {}, "slug": "sample", "type": "film", "year": 1, "stats": { "like_count": 1, "list_count": 1, "watched_count": 1 }, "title": "Stylish Shoreditch Loft with Balcony", "genres": [ "sample" ], "film_id": 1, "imdb_id": "id-1", "ratings": { "count": 1, "distribution": [ { "count": 1, "label": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "percentage": 1.5 } ], "calculated_average": 51.5074 }, "tagline": "Featured", "tmdb_id": 1, "duration": "sample", "countries": [ "sample" ], "directors": [ { "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony" } ], "image_url": "https://example.com/item-1", "languages": [ "sample" ], "tmdb_type": "sample", "cast_names": [ "Stylish Shoreditch Loft with Balcony" ], "full_title": "Stylish Shoreditch Loft with Balcony", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "release_date": "sample", "external_urls": { "imdb": "sample", "tmdb": "sample" }, "letterboxd_id": "id-1", "poster_images": { "large": "sample", "small": "sample", "medium": "sample" }, "director_names": [ "Stylish Shoreditch Loft with Balcony" ], "language_codes": [ "sample" ], "original_title": "Stylish Shoreditch Loft with Balcony", "popular_reviews": [ { "id": "id-1", "url": "https://example.com/item-1", "text": "Sample text 1", "rating": 4.91, "like_count": 1, "rating_label": "Stylish Shoreditch Loft with Balcony", "reviewer_name": "Stylish Shoreditch Loft with Balcony", "reviewer_username": "Stylish Shoreditch Loft with Balcony" } ], "runtime_minutes": 1.5 }, "count": 1, "query": "London", "source": "letterboxd-film", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "slug": "sample", "type": "film", "year": 1, "title": "Stylish Shoreditch Loft with Balcony", "film_id": 1, "image_url": "https://example.com/item-1", "full_title": "Stylish Shoreditch Loft with Balcony" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "required": [ "id", "type", "slug", "title", "full_title", "original_title", "year", "release_date", "url", "film_id", "uid", "letterboxd_id", "tmdb_id", "tmdb_type", "imdb_id", "external_urls", "description", "tagline", "runtime_minutes", "duration", "genres", "countries", "languages", "language_codes", "directors", "director_names", "cast", "cast_names", "crew", "image_url", "image_urls", "poster_images", "stats", "ratings", "popular_reviews" ], "properties": { "id": { "type": "string" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "cast": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "crew": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } } }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "const": "film" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "stats": { "type": "object", "properties": { "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "list_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "watched_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "additionalProperties": false }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "genres": { "type": "array", "items": { "type": "string" } }, "film_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "imdb_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ratings": { "type": "object", "required": [ "count", "calculated_average", "distribution" ], "properties": { "count": { "type": "integer" }, "distribution": { "type": "array", "items": { "type": "object", "required": [ "rating", "label", "count", "percentage" ], "properties": { "count": { "type": "integer" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "calculated_average": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "tagline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tmdb_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "countries": { "type": "array", "items": { "type": "string" } }, "directors": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "languages": { "type": "array", "items": { "type": "string" } }, "tmdb_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cast_names": { "type": "array", "items": { "type": "string" } }, "full_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "release_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "external_urls": { "type": "object", "required": [ "imdb", "tmdb" ], "properties": { "imdb": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tmdb": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "letterboxd_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "poster_images": { "type": "object", "required": [ "small", "medium", "large" ], "properties": { "large": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "small": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "director_names": { "type": "array", "items": { "type": "string" } }, "language_codes": { "type": "array", "items": { "type": "string" } }, "original_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "popular_reviews": { "type": "array", "items": { "type": "object", "required": [ "id", "reviewer_name", "reviewer_username", "url", "rating", "rating_label", "text", "like_count" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rating_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewer_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "runtime_minutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "const": "letterboxd-film" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "slug", "title", "full_title", "year", "url", "film_id", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "slug": { "type": "string" }, "type": { "const": "film" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "film_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "full_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "letterboxd-film", "task_name": "Letterboxd Film API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runLetterboxdFilmCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://letterboxd.com/film/parasite-2019/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://letterboxd.com/film/parasite-2019/" } } } }, "x-browsable-website-login-required": false } }, "/v1/letterboxd/film": { "post": { "tags": [ "Letterboxd" ], "summary": "Letterboxd Film API", "description": "Scrape a public Letterboxd film page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "required": [ "id", "type", "slug", "title", "full_title", "original_title", "year", "release_date", "url", "film_id", "uid", "letterboxd_id", "tmdb_id", "tmdb_type", "imdb_id", "external_urls", "description", "tagline", "runtime_minutes", "duration", "genres", "countries", "languages", "language_codes", "directors", "director_names", "cast", "cast_names", "crew", "image_url", "image_urls", "poster_images", "stats", "ratings", "popular_reviews" ], "properties": { "id": { "type": "string" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "cast": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "crew": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } } }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "const": "film" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "stats": { "type": "object", "properties": { "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "list_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "watched_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "additionalProperties": false }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "genres": { "type": "array", "items": { "type": "string" } }, "film_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "imdb_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ratings": { "type": "object", "required": [ "count", "calculated_average", "distribution" ], "properties": { "count": { "type": "integer" }, "distribution": { "type": "array", "items": { "type": "object", "required": [ "rating", "label", "count", "percentage" ], "properties": { "count": { "type": "integer" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "calculated_average": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "tagline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tmdb_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "countries": { "type": "array", "items": { "type": "string" } }, "directors": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "languages": { "type": "array", "items": { "type": "string" } }, "tmdb_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cast_names": { "type": "array", "items": { "type": "string" } }, "full_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "release_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "external_urls": { "type": "object", "required": [ "imdb", "tmdb" ], "properties": { "imdb": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tmdb": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "letterboxd_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "poster_images": { "type": "object", "required": [ "small", "medium", "large" ], "properties": { "large": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "small": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "director_names": { "type": "array", "items": { "type": "string" } }, "language_codes": { "type": "array", "items": { "type": "string" } }, "original_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "popular_reviews": { "type": "array", "items": { "type": "object", "required": [ "id", "reviewer_name", "reviewer_username", "url", "rating", "rating_label", "text", "like_count" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rating_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewer_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "runtime_minutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "const": "letterboxd-film" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "slug", "title", "full_title", "year", "url", "film_id", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "slug": { "type": "string" }, "type": { "const": "film" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "film_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "full_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "letterboxd-film", "task_name": "Letterboxd Film API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "uid": "id-1", "url": "https://example.com/item-1", "cast": [ { "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony" } ], "crew": {}, "slug": "sample", "type": "film", "year": 1, "stats": { "like_count": 1, "list_count": 1, "watched_count": 1 }, "title": "Stylish Shoreditch Loft with Balcony", "genres": [ "sample" ], "film_id": 1, "imdb_id": "id-1", "ratings": { "count": 1, "distribution": [ { "count": 1, "label": "Stylish Shoreditch Loft with Balcony", "rating": 4.91, "percentage": 1.5 } ], "calculated_average": 51.5074 }, "tagline": "Featured", "tmdb_id": 1, "duration": "sample", "countries": [ "sample" ], "directors": [ { "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony" } ], "image_url": "https://example.com/item-1", "languages": [ "sample" ], "tmdb_type": "sample", "cast_names": [ "Stylish Shoreditch Loft with Balcony" ], "full_title": "Stylish Shoreditch Loft with Balcony", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "release_date": "sample", "external_urls": { "imdb": "sample", "tmdb": "sample" }, "letterboxd_id": "id-1", "poster_images": { "large": "sample", "small": "sample", "medium": "sample" }, "director_names": [ "Stylish Shoreditch Loft with Balcony" ], "language_codes": [ "sample" ], "original_title": "Stylish Shoreditch Loft with Balcony", "popular_reviews": [ { "id": "id-1", "url": "https://example.com/item-1", "text": "Sample text 1", "rating": 4.91, "like_count": 1, "rating_label": "Stylish Shoreditch Loft with Balcony", "reviewer_name": "Stylish Shoreditch Loft with Balcony", "reviewer_username": "Stylish Shoreditch Loft with Balcony" } ], "runtime_minutes": 1.5 }, "count": 1, "query": "London", "source": "letterboxd-film", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "slug": "sample", "type": "film", "year": 1, "title": "Stylish Shoreditch Loft with Balcony", "film_id": 1, "image_url": "https://example.com/item-1", "full_title": "Stylish Shoreditch Loft with Balcony" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "required": [ "id", "type", "slug", "title", "full_title", "original_title", "year", "release_date", "url", "film_id", "uid", "letterboxd_id", "tmdb_id", "tmdb_type", "imdb_id", "external_urls", "description", "tagline", "runtime_minutes", "duration", "genres", "countries", "languages", "language_codes", "directors", "director_names", "cast", "cast_names", "crew", "image_url", "image_urls", "poster_images", "stats", "ratings", "popular_reviews" ], "properties": { "id": { "type": "string" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "cast": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "crew": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } } }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "const": "film" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "stats": { "type": "object", "properties": { "like_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "list_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "watched_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "additionalProperties": false }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "genres": { "type": "array", "items": { "type": "string" } }, "film_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "imdb_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ratings": { "type": "object", "required": [ "count", "calculated_average", "distribution" ], "properties": { "count": { "type": "integer" }, "distribution": { "type": "array", "items": { "type": "object", "required": [ "rating", "label", "count", "percentage" ], "properties": { "count": { "type": "integer" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "percentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "calculated_average": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "tagline": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tmdb_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "countries": { "type": "array", "items": { "type": "string" } }, "directors": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "languages": { "type": "array", "items": { "type": "string" } }, "tmdb_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cast_names": { "type": "array", "items": { "type": "string" } }, "full_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "release_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "external_urls": { "type": "object", "required": [ "imdb", "tmdb" ], "properties": { "imdb": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tmdb": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "letterboxd_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "poster_images": { "type": "object", "required": [ "small", "medium", "large" ], "properties": { "large": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "small": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "medium": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "director_names": { "type": "array", "items": { "type": "string" } }, "language_codes": { "type": "array", "items": { "type": "string" } }, "original_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "popular_reviews": { "type": "array", "items": { "type": "object", "required": [ "id", "reviewer_name", "reviewer_username", "url", "rating", "rating_label", "text", "like_count" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rating_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reviewer_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "runtime_minutes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "const": "letterboxd-film" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "slug", "title", "full_title", "year", "url", "film_id", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "slug": { "type": "string" }, "type": { "const": "film" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "film_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "full_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "letterboxd-film", "task_name": "Letterboxd Film API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runLetterboxdFilmAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://letterboxd.com/film/parasite-2019/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://letterboxd.com/film/parasite-2019/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-letterboxd-film" }, "x-browsable-website-login-required": false } }, "/v1/tasks/letterboxd-search/runs": { "post": { "tags": [ "Letterboxd" ], "summary": "Letterboxd Search API", "description": "Scrape public Letterboxd film search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "required": [ "result_type", "source_endpoint" ], "properties": { "result_type": { "const": "film" }, "source_endpoint": { "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "const": "letterboxd-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "slug", "title", "url", "film_id", "uid", "letterboxd_id", "image_url", "image_urls", "details_endpoint", "directors", "director_names", "alternative_titles", "original_title", "summary", "position" ], "properties": { "id": { "type": "string" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "slug": { "type": "string" }, "type": { "const": "film" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "title": { "type": "string" }, "film_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "summary": { "type": "string" }, "position": { "type": "integer" }, "directors": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "full_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "letterboxd_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "director_names": { "type": "array", "items": { "type": "string" } }, "original_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details_endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alternative_titles": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "letterboxd-search", "task_name": "Letterboxd Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "result_type": "film", "source_endpoint": "sample" }, "count": 1, "query": "London", "source": "letterboxd-search", "results": [ { "id": "id-1", "uid": "id-1", "url": "https://example.com/item-1", "slug": "sample", "type": "film", "year": 1, "title": "Stylish Shoreditch Loft with Balcony", "film_id": 1, "summary": "Sample summary 1", "position": 1, "directors": [ { "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony" } ], "image_url": "https://example.com/item-1", "full_title": "Stylish Shoreditch Loft with Balcony", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "letterboxd_id": "id-1", "director_names": [ "Stylish Shoreditch Loft with Balcony" ], "original_title": "Stylish Shoreditch Loft with Balcony", "details_endpoint": "2 guests", "alternative_titles": [ "Stylish Shoreditch Loft with Balcony" ] } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "required": [ "result_type", "source_endpoint" ], "properties": { "result_type": { "const": "film" }, "source_endpoint": { "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "const": "letterboxd-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "slug", "title", "url", "film_id", "uid", "letterboxd_id", "image_url", "image_urls", "details_endpoint", "directors", "director_names", "alternative_titles", "original_title", "summary", "position" ], "properties": { "id": { "type": "string" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "slug": { "type": "string" }, "type": { "const": "film" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "title": { "type": "string" }, "film_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "summary": { "type": "string" }, "position": { "type": "integer" }, "directors": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "full_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "letterboxd_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "director_names": { "type": "array", "items": { "type": "string" } }, "original_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details_endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alternative_titles": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "letterboxd-search", "task_name": "Letterboxd Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runLetterboxdSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Parasite", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Parasite" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Parasite" } } } }, "x-browsable-website-login-required": false } }, "/v1/letterboxd/search": { "post": { "tags": [ "Letterboxd" ], "summary": "Letterboxd Search API", "description": "Scrape public Letterboxd film search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "required": [ "result_type", "source_endpoint" ], "properties": { "result_type": { "const": "film" }, "source_endpoint": { "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "const": "letterboxd-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "slug", "title", "url", "film_id", "uid", "letterboxd_id", "image_url", "image_urls", "details_endpoint", "directors", "director_names", "alternative_titles", "original_title", "summary", "position" ], "properties": { "id": { "type": "string" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "slug": { "type": "string" }, "type": { "const": "film" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "title": { "type": "string" }, "film_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "summary": { "type": "string" }, "position": { "type": "integer" }, "directors": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "full_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "letterboxd_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "director_names": { "type": "array", "items": { "type": "string" } }, "original_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details_endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alternative_titles": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "letterboxd-search", "task_name": "Letterboxd Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "result_type": "film", "source_endpoint": "sample" }, "count": 1, "query": "London", "source": "letterboxd-search", "results": [ { "id": "id-1", "uid": "id-1", "url": "https://example.com/item-1", "slug": "sample", "type": "film", "year": 1, "title": "Stylish Shoreditch Loft with Balcony", "film_id": 1, "summary": "Sample summary 1", "position": 1, "directors": [ { "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony" } ], "image_url": "https://example.com/item-1", "full_title": "Stylish Shoreditch Loft with Balcony", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "letterboxd_id": "id-1", "director_names": [ "Stylish Shoreditch Loft with Balcony" ], "original_title": "Stylish Shoreditch Loft with Balcony", "details_endpoint": "2 guests", "alternative_titles": [ "Stylish Shoreditch Loft with Balcony" ] } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "required": [ "result_type", "source_endpoint" ], "properties": { "result_type": { "const": "film" }, "source_endpoint": { "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "const": "letterboxd-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "slug", "title", "url", "film_id", "uid", "letterboxd_id", "image_url", "image_urls", "details_endpoint", "directors", "director_names", "alternative_titles", "original_title", "summary", "position" ], "properties": { "id": { "type": "string" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "slug": { "type": "string" }, "type": { "const": "film" }, "year": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "title": { "type": "string" }, "film_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "summary": { "type": "string" }, "position": { "type": "integer" }, "directors": { "type": "array", "items": { "type": "object", "required": [ "name", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" } }, "additionalProperties": false } }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "full_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "letterboxd_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "director_names": { "type": "array", "items": { "type": "string" } }, "original_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "details_endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alternative_titles": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "letterboxd-search", "task_name": "Letterboxd Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runLetterboxdSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Parasite", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Parasite" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Parasite" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-letterboxd-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/linkedin-company-employees/runs": { "post": { "tags": [ "LinkedIn" ], "summary": "LinkedIn Company Employees API", "description": "Scrape a LinkedIn company people page using a managed signed-in session.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "linkedin-company-employees", "task_name": "LinkedIn Company Employees API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "linkedin-company-employees", "task_name": "LinkedIn Company Employees API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runLinkedinCompanyEmployeesCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "company": { "type": "string", "x-sample": "stripe", "description": "LinkedIn company slug.", "x-placeholder": "e.g. stripe" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "company" ] }, "example": { "company": "stripe" } } } }, "x-browsable-website-login-required": true } }, "/v1/linkedin/company-employees": { "post": { "tags": [ "LinkedIn" ], "summary": "LinkedIn Company Employees API", "description": "Scrape a LinkedIn company people page using a managed signed-in session.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "linkedin-company-employees", "task_name": "LinkedIn Company Employees API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "linkedin-company-employees", "task_name": "LinkedIn Company Employees API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runLinkedinCompanyEmployeesAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "company": { "type": "string", "x-sample": "stripe", "description": "LinkedIn company slug.", "x-placeholder": "e.g. stripe" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "company" ] }, "example": { "company": "stripe" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-linkedin-company-employees" }, "x-browsable-website-login-required": true } }, "/v1/tasks/linkedin-post-comments/runs": { "post": { "tags": [ "LinkedIn" ], "summary": "LinkedIn Post Comments API", "description": "Scrape public comments visible on a LinkedIn post page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "linkedin-post-comments", "task_name": "LinkedIn Post Comments API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "linkedin-post-comments", "task_name": "LinkedIn Post Comments API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runLinkedinPostCommentsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.linkedin.com/posts/example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.linkedin.com/posts/example" } } } }, "x-browsable-website-login-required": false } }, "/v1/linkedin/post-comments": { "post": { "tags": [ "LinkedIn" ], "summary": "LinkedIn Post Comments API", "description": "Scrape public comments visible on a LinkedIn post page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "linkedin-post-comments", "task_name": "LinkedIn Post Comments API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "linkedin-post-comments", "task_name": "LinkedIn Post Comments API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runLinkedinPostCommentsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.linkedin.com/posts/example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.linkedin.com/posts/example" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-linkedin-post-comments" }, "x-browsable-website-login-required": false } }, "/v1/tasks/mastodon-search/runs": { "post": { "tags": [ "Mastodon" ], "summary": "Mastodon API", "description": "Search public Mastodon accounts on a chosen instance.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mastodon-search", "task_name": "Mastodon API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mastodon-search", "task_name": "Mastodon API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMastodonSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "climate", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. climate" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "instance": { "type": "string", "default": "mastodon.social", "description": "Mastodon instance hostname.", "x-placeholder": "e.g. mastodon.social" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "climate" } } } }, "x-browsable-website-login-required": false } }, "/v1/mastodon/search": { "post": { "tags": [ "Mastodon" ], "summary": "Mastodon API", "description": "Search public Mastodon accounts on a chosen instance.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mastodon-search", "task_name": "Mastodon API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mastodon-search", "task_name": "Mastodon API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMastodonSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "climate", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. climate" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "instance": { "type": "string", "default": "mastodon.social", "description": "Mastodon instance hostname.", "x-placeholder": "e.g. mastodon.social" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "climate" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-mastodon-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/mastodon-status/runs": { "post": { "tags": [ "Mastodon" ], "summary": "Mastodon Status API", "description": "Scrape a public Mastodon status page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mastodon-status", "task_name": "Mastodon Status API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mastodon-status", "task_name": "Mastodon Status API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMastodonStatusCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://mastodon.social/@user/1234567890" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://mastodon.social/@user/1234567890" } } } }, "x-browsable-website-login-required": false } }, "/v1/mastodon/status": { "post": { "tags": [ "Mastodon" ], "summary": "Mastodon Status API", "description": "Scrape a public Mastodon status page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mastodon-status", "task_name": "Mastodon Status API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mastodon-status", "task_name": "Mastodon Status API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMastodonStatusAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://mastodon.social/@user/1234567890" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://mastodon.social/@user/1234567890" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-mastodon-status" }, "x-browsable-website-login-required": false } }, "/v1/tasks/medium-post/runs": { "post": { "tags": [ "Medium" ], "summary": "Medium Post API", "description": "Scrape a public Medium post page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "medium-post", "task_name": "Medium Post API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "medium-post", "task_name": "Medium Post API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMediumPostCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://medium.com/@author/example-post" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://medium.com/@author/example-post" } } } }, "x-browsable-website-login-required": false } }, "/v1/medium/post": { "post": { "tags": [ "Medium" ], "summary": "Medium Post API", "description": "Scrape a public Medium post page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "medium-post", "task_name": "Medium Post API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "medium-post", "task_name": "Medium Post API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMediumPostAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://medium.com/@author/example-post" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://medium.com/@author/example-post" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-medium-post" }, "x-browsable-website-login-required": false } }, "/v1/tasks/medium-search/runs": { "post": { "tags": [ "Medium" ], "summary": "Medium API", "description": "Scrape public Medium story search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "medium-search", "task_name": "Medium API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "medium-search", "task_name": "Medium API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMediumSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "distributed systems", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. distributed systems" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "distributed systems" } } } }, "x-browsable-website-login-required": false } }, "/v1/medium/search": { "post": { "tags": [ "Medium" ], "summary": "Medium API", "description": "Scrape public Medium story search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "medium-search", "task_name": "Medium API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "medium-search", "task_name": "Medium API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMediumSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "distributed systems", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. distributed systems" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "distributed systems" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-medium-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/mercari-listing/runs": { "post": { "tags": [ "Mercari" ], "summary": "Mercari Listing API", "description": "Get a Mercari US listing’s title, price, photos, condition and seller name.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "id", "url", "title", "description", "image_url", "image_urls", "price", "currency", "availability", "condition", "brand", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "seller": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-listing" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "description", "image_url", "image_urls", "price", "currency", "availability", "condition", "brand", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "seller": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-listing", "task_name": "Mercari Listing API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "brand": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "seller": "sample", "currency": "USD", "condition": "sample", "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "availability": "sample" }, "count": 1, "query": "London", "source": "mercari-listing", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "brand": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "seller": "sample", "currency": "USD", "condition": "sample", "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "availability": "sample" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "id", "url", "title", "description", "image_url", "image_urls", "price", "currency", "availability", "condition", "brand", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "seller": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-listing" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "description", "image_url", "image_urls", "price", "currency", "availability", "condition", "brand", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "seller": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-listing", "task_name": "Mercari Listing API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMercariListingCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2000, "minLength": 1, "description": "Mercari US item URL.", "x-placeholder": "e.g. https://www.mercari.com/us/item/m15770090881/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.mercari.com/us/item/m15770090881/" } } } }, "x-browsable-website-login-required": false } }, "/v1/mercari/listing": { "post": { "tags": [ "Mercari" ], "summary": "Mercari Listing API", "description": "Get a Mercari US listing’s title, price, photos, condition and seller name.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "id", "url", "title", "description", "image_url", "image_urls", "price", "currency", "availability", "condition", "brand", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "seller": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-listing" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "description", "image_url", "image_urls", "price", "currency", "availability", "condition", "brand", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "seller": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-listing", "task_name": "Mercari Listing API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "brand": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "seller": "sample", "currency": "USD", "condition": "sample", "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "availability": "sample" }, "count": 1, "query": "London", "source": "mercari-listing", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "brand": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "seller": "sample", "currency": "USD", "condition": "sample", "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "availability": "sample" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "id", "url", "title", "description", "image_url", "image_urls", "price", "currency", "availability", "condition", "brand", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "seller": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-listing" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "description", "image_url", "image_urls", "price", "currency", "availability", "condition", "brand", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "brand": { "type": [ "string", "null" ] }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "seller": { "type": [ "string", "null" ] }, "currency": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "availability": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-listing", "task_name": "Mercari Listing API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMercariListingAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2000, "minLength": 1, "description": "Mercari US item URL.", "x-placeholder": "e.g. https://www.mercari.com/us/item/m15770090881/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.mercari.com/us/item/m15770090881/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-mercari-listing" }, "x-browsable-website-login-required": false } }, "/v1/tasks/mercari-search/runs": { "post": { "tags": [ "Mercari" ], "summary": "Mercari Search API", "description": "Search Mercari US listings with price, brand, category, condition and status filters. Follow next_cursor to get more results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "total_count" ], "properties": { "total_count": { "type": "integer", "minimum": 0 } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "seller_id", "brand_id", "category_id", "title", "url", "price", "currency", "original_price", "image_url", "summary", "rating", "status", "brand", "condition", "size" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "size": { "type": [ "string", "null" ] }, "brand": { "type": [ "string", "null" ] }, "price": { "type": "string" }, "title": { "type": "string" }, "rating": { "type": "null" }, "status": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "brand_id": { "type": [ "number", "null" ] }, "currency": { "const": "USD" }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "seller_id": { "type": [ "string", "null" ] }, "category_id": { "type": [ "number", "null" ] }, "original_price": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-search", "task_name": "Mercari Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "total_count": 1 }, "count": 1, "query": "London", "source": "mercari-search", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "size": "sample", "brand": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": null, "status": "sample", "summary": "Sample summary 1", "brand_id": 1.5, "currency": "USD", "condition": "sample", "image_url": "https://example.com/item-1", "seller_id": "id-1", "category_id": 1.5, "original_price": "180" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "total_count" ], "properties": { "total_count": { "type": "integer", "minimum": 0 } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "seller_id", "brand_id", "category_id", "title", "url", "price", "currency", "original_price", "image_url", "summary", "rating", "status", "brand", "condition", "size" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "size": { "type": [ "string", "null" ] }, "brand": { "type": [ "string", "null" ] }, "price": { "type": "string" }, "title": { "type": "string" }, "rating": { "type": "null" }, "status": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "brand_id": { "type": [ "number", "null" ] }, "currency": { "const": "USD" }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "seller_id": { "type": [ "string", "null" ] }, "category_id": { "type": [ "number", "null" ] }, "original_price": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-search", "task_name": "Mercari Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMercariSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "x-sample": "https://www.mercari.com/search/?keyword=jacket&brandIds=4591", "maxLength": 500, "minLength": 1, "description": "Copy a filtered Mercari search URL to reuse brand, category, condition and price filters without looking up IDs." }, "sort": { "enum": [ "best_match", "newest", "price_low_to_high", "price_high_to_low", "recently_sold" ], "type": "string", "default": "best_match", "description": "Order results by relevance, listing date, price, or sale recency." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results to return. Review pages may return fewer than this limit." }, "query": { "type": "string", "x-sample": "vintage jacket", "maxLength": 2000, "minLength": 1, "description": "Search keywords." }, "cursor": { "type": "string", "description": "Opaque next_cursor from the previous response. Keep the same seller, query, filters, and limit." }, "status": { "enum": [ "all", "available", "sold" ], "type": "string", "description": "Listing status. Sold includes completed and in-progress sales; displayed prices are not guaranteed final transaction prices." }, "brand_ids": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "maxItems": 50, "x-advanced": true, "description": "Mercari brand IDs. Results include brand_id for subsequent filtering.", "uniqueItems": true }, "max_price": { "type": "number", "maximum": 1000000, "minimum": 0, "description": "Maximum item price in US dollars, excluding shipping and fees." }, "min_price": { "type": "number", "maximum": 1000000, "minimum": 0, "description": "Minimum item price in US dollars, excluding shipping and fees." }, "conditions": { "type": "array", "items": { "enum": [ "new", "like_new", "good", "fair", "poor" ], "type": "string" }, "description": "Include listings in these conditions.", "uniqueItems": true }, "category_ids": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "maxItems": 50, "x-advanced": true, "description": "Mercari category IDs. Results include category_id for subsequent filtering.", "uniqueItems": true }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "query" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.mercari.com/search/?keyword=jacket&brandIds=4591" } } } }, "x-browsable-website-login-required": false } }, "/v1/mercari/search": { "post": { "tags": [ "Mercari" ], "summary": "Mercari Search API", "description": "Search Mercari US listings with price, brand, category, condition and status filters. Follow next_cursor to get more results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "total_count" ], "properties": { "total_count": { "type": "integer", "minimum": 0 } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "seller_id", "brand_id", "category_id", "title", "url", "price", "currency", "original_price", "image_url", "summary", "rating", "status", "brand", "condition", "size" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "size": { "type": [ "string", "null" ] }, "brand": { "type": [ "string", "null" ] }, "price": { "type": "string" }, "title": { "type": "string" }, "rating": { "type": "null" }, "status": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "brand_id": { "type": [ "number", "null" ] }, "currency": { "const": "USD" }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "seller_id": { "type": [ "string", "null" ] }, "category_id": { "type": [ "number", "null" ] }, "original_price": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-search", "task_name": "Mercari Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "total_count": 1 }, "count": 1, "query": "London", "source": "mercari-search", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "size": "sample", "brand": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": null, "status": "sample", "summary": "Sample summary 1", "brand_id": 1.5, "currency": "USD", "condition": "sample", "image_url": "https://example.com/item-1", "seller_id": "id-1", "category_id": 1.5, "original_price": "180" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "total_count" ], "properties": { "total_count": { "type": "integer", "minimum": 0 } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "seller_id", "brand_id", "category_id", "title", "url", "price", "currency", "original_price", "image_url", "summary", "rating", "status", "brand", "condition", "size" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "size": { "type": [ "string", "null" ] }, "brand": { "type": [ "string", "null" ] }, "price": { "type": "string" }, "title": { "type": "string" }, "rating": { "type": "null" }, "status": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "brand_id": { "type": [ "number", "null" ] }, "currency": { "const": "USD" }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "seller_id": { "type": [ "string", "null" ] }, "category_id": { "type": [ "number", "null" ] }, "original_price": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-search", "task_name": "Mercari Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMercariSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "x-sample": "https://www.mercari.com/search/?keyword=jacket&brandIds=4591", "maxLength": 500, "minLength": 1, "description": "Copy a filtered Mercari search URL to reuse brand, category, condition and price filters without looking up IDs." }, "sort": { "enum": [ "best_match", "newest", "price_low_to_high", "price_high_to_low", "recently_sold" ], "type": "string", "default": "best_match", "description": "Order results by relevance, listing date, price, or sale recency." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results to return. Review pages may return fewer than this limit." }, "query": { "type": "string", "x-sample": "vintage jacket", "maxLength": 2000, "minLength": 1, "description": "Search keywords." }, "cursor": { "type": "string", "description": "Opaque next_cursor from the previous response. Keep the same seller, query, filters, and limit." }, "status": { "enum": [ "all", "available", "sold" ], "type": "string", "description": "Listing status. Sold includes completed and in-progress sales; displayed prices are not guaranteed final transaction prices." }, "brand_ids": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "maxItems": 50, "x-advanced": true, "description": "Mercari brand IDs. Results include brand_id for subsequent filtering.", "uniqueItems": true }, "max_price": { "type": "number", "maximum": 1000000, "minimum": 0, "description": "Maximum item price in US dollars, excluding shipping and fees." }, "min_price": { "type": "number", "maximum": 1000000, "minimum": 0, "description": "Minimum item price in US dollars, excluding shipping and fees." }, "conditions": { "type": "array", "items": { "enum": [ "new", "like_new", "good", "fair", "poor" ], "type": "string" }, "description": "Include listings in these conditions.", "uniqueItems": true }, "category_ids": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "maxItems": 50, "x-advanced": true, "description": "Mercari category IDs. Results include category_id for subsequent filtering.", "uniqueItems": true }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "query" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.mercari.com/search/?keyword=jacket&brandIds=4591" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-mercari-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/mercari-seller/runs": { "post": { "tags": [ "Mercari" ], "summary": "Mercari Seller API", "description": "Get a public Mercari US seller profile, ratings, follower counts and selling statistics.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "id", "username", "name", "url", "image_url", "description", "created_at", "listing_count", "sold_count", "follower_count", "following_count", "rating_count", "rating_average", "is_pro_seller", "is_fast_shipper", "is_fast_responder", "cancellation_rate" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "description": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "is_pro_seller": { "type": [ "boolean", "null" ] }, "listing_count": { "type": [ "number", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "rating_average": { "type": [ "number", "null" ] }, "following_count": { "type": [ "number", "null" ] }, "is_fast_shipper": { "type": [ "boolean", "null" ] }, "cancellation_rate": { "type": [ "number", "null" ] }, "is_fast_responder": { "type": [ "boolean", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-seller" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "username", "name", "url", "image_url", "description", "created_at", "listing_count", "sold_count", "follower_count", "following_count", "rating_count", "rating_average", "is_pro_seller", "is_fast_shipper", "is_fast_responder", "cancellation_rate" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "description": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "is_pro_seller": { "type": [ "boolean", "null" ] }, "listing_count": { "type": [ "number", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "rating_average": { "type": [ "number", "null" ] }, "following_count": { "type": [ "number", "null" ] }, "is_fast_shipper": { "type": [ "boolean", "null" ] }, "cancellation_rate": { "type": [ "number", "null" ] }, "is_fast_responder": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-seller", "task_name": "Mercari Seller API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "username": "Stylish Shoreditch Loft with Balcony", "image_url": "https://example.com/item-1", "created_at": "2026-06-14T15:30:00Z", "sold_count": 1, "description": "Sample description 1", "rating_count": 4.91, "is_pro_seller": true, "listing_count": 1, "follower_count": 1, "rating_average": 4.91, "following_count": 1, "is_fast_shipper": true, "cancellation_rate": 51.5074, "is_fast_responder": true }, "count": 1, "query": "London", "source": "mercari-seller", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "username": "Stylish Shoreditch Loft with Balcony", "image_url": "https://example.com/item-1", "created_at": "2026-06-14T15:30:00Z", "sold_count": 1, "description": "Sample description 1", "rating_count": 4.91, "is_pro_seller": true, "listing_count": 1, "follower_count": 1, "rating_average": 4.91, "following_count": 1, "is_fast_shipper": true, "cancellation_rate": 51.5074, "is_fast_responder": true } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "id", "username", "name", "url", "image_url", "description", "created_at", "listing_count", "sold_count", "follower_count", "following_count", "rating_count", "rating_average", "is_pro_seller", "is_fast_shipper", "is_fast_responder", "cancellation_rate" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "description": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "is_pro_seller": { "type": [ "boolean", "null" ] }, "listing_count": { "type": [ "number", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "rating_average": { "type": [ "number", "null" ] }, "following_count": { "type": [ "number", "null" ] }, "is_fast_shipper": { "type": [ "boolean", "null" ] }, "cancellation_rate": { "type": [ "number", "null" ] }, "is_fast_responder": { "type": [ "boolean", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-seller" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "username", "name", "url", "image_url", "description", "created_at", "listing_count", "sold_count", "follower_count", "following_count", "rating_count", "rating_average", "is_pro_seller", "is_fast_shipper", "is_fast_responder", "cancellation_rate" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "description": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "is_pro_seller": { "type": [ "boolean", "null" ] }, "listing_count": { "type": [ "number", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "rating_average": { "type": [ "number", "null" ] }, "following_count": { "type": [ "number", "null" ] }, "is_fast_shipper": { "type": [ "boolean", "null" ] }, "cancellation_rate": { "type": [ "number", "null" ] }, "is_fast_responder": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-seller", "task_name": "Mercari Seller API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMercariSellerCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2000, "minLength": 1, "description": "Public Mercari US seller profile URL.", "x-placeholder": "e.g. https://www.mercari.com/u/jaijuu/" }, "username": { "type": "string", "pattern": "^[A-Za-z0-9_.-]+$", "maxLength": 2000, "minLength": 1, "description": "Public Mercari username.", "x-placeholder": "e.g. jaijuu" }, "seller_id": { "type": "string", "pattern": "^[0-9]+$", "x-sample": "717873356", "x-advanced": true, "description": "Mercari seller ID, returned by search or seller listings." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "seller_id" ] }, { "required": [ "username" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.mercari.com/u/jaijuu/" } } } }, "x-browsable-website-login-required": false } }, "/v1/mercari/seller": { "post": { "tags": [ "Mercari" ], "summary": "Mercari Seller API", "description": "Get a public Mercari US seller profile, ratings, follower counts and selling statistics.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "id", "username", "name", "url", "image_url", "description", "created_at", "listing_count", "sold_count", "follower_count", "following_count", "rating_count", "rating_average", "is_pro_seller", "is_fast_shipper", "is_fast_responder", "cancellation_rate" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "description": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "is_pro_seller": { "type": [ "boolean", "null" ] }, "listing_count": { "type": [ "number", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "rating_average": { "type": [ "number", "null" ] }, "following_count": { "type": [ "number", "null" ] }, "is_fast_shipper": { "type": [ "boolean", "null" ] }, "cancellation_rate": { "type": [ "number", "null" ] }, "is_fast_responder": { "type": [ "boolean", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-seller" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "username", "name", "url", "image_url", "description", "created_at", "listing_count", "sold_count", "follower_count", "following_count", "rating_count", "rating_average", "is_pro_seller", "is_fast_shipper", "is_fast_responder", "cancellation_rate" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "description": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "is_pro_seller": { "type": [ "boolean", "null" ] }, "listing_count": { "type": [ "number", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "rating_average": { "type": [ "number", "null" ] }, "following_count": { "type": [ "number", "null" ] }, "is_fast_shipper": { "type": [ "boolean", "null" ] }, "cancellation_rate": { "type": [ "number", "null" ] }, "is_fast_responder": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-seller", "task_name": "Mercari Seller API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "username": "Stylish Shoreditch Loft with Balcony", "image_url": "https://example.com/item-1", "created_at": "2026-06-14T15:30:00Z", "sold_count": 1, "description": "Sample description 1", "rating_count": 4.91, "is_pro_seller": true, "listing_count": 1, "follower_count": 1, "rating_average": 4.91, "following_count": 1, "is_fast_shipper": true, "cancellation_rate": 51.5074, "is_fast_responder": true }, "count": 1, "query": "London", "source": "mercari-seller", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "username": "Stylish Shoreditch Loft with Balcony", "image_url": "https://example.com/item-1", "created_at": "2026-06-14T15:30:00Z", "sold_count": 1, "description": "Sample description 1", "rating_count": 4.91, "is_pro_seller": true, "listing_count": 1, "follower_count": 1, "rating_average": 4.91, "following_count": 1, "is_fast_shipper": true, "cancellation_rate": 51.5074, "is_fast_responder": true } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "id", "username", "name", "url", "image_url", "description", "created_at", "listing_count", "sold_count", "follower_count", "following_count", "rating_count", "rating_average", "is_pro_seller", "is_fast_shipper", "is_fast_responder", "cancellation_rate" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "description": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "is_pro_seller": { "type": [ "boolean", "null" ] }, "listing_count": { "type": [ "number", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "rating_average": { "type": [ "number", "null" ] }, "following_count": { "type": [ "number", "null" ] }, "is_fast_shipper": { "type": [ "boolean", "null" ] }, "cancellation_rate": { "type": [ "number", "null" ] }, "is_fast_responder": { "type": [ "boolean", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-seller" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "username", "name", "url", "image_url", "description", "created_at", "listing_count", "sold_count", "follower_count", "following_count", "rating_count", "rating_average", "is_pro_seller", "is_fast_shipper", "is_fast_responder", "cancellation_rate" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "sold_count": { "type": [ "number", "null" ] }, "description": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "is_pro_seller": { "type": [ "boolean", "null" ] }, "listing_count": { "type": [ "number", "null" ] }, "follower_count": { "type": [ "number", "null" ] }, "rating_average": { "type": [ "number", "null" ] }, "following_count": { "type": [ "number", "null" ] }, "is_fast_shipper": { "type": [ "boolean", "null" ] }, "cancellation_rate": { "type": [ "number", "null" ] }, "is_fast_responder": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-seller", "task_name": "Mercari Seller API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMercariSellerAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2000, "minLength": 1, "description": "Public Mercari US seller profile URL.", "x-placeholder": "e.g. https://www.mercari.com/u/jaijuu/" }, "username": { "type": "string", "pattern": "^[A-Za-z0-9_.-]+$", "maxLength": 2000, "minLength": 1, "description": "Public Mercari username.", "x-placeholder": "e.g. jaijuu" }, "seller_id": { "type": "string", "pattern": "^[0-9]+$", "x-sample": "717873356", "x-advanced": true, "description": "Mercari seller ID, returned by search or seller listings." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "seller_id" ] }, { "required": [ "username" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.mercari.com/u/jaijuu/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-mercari-seller" }, "x-browsable-website-login-required": false } }, "/v1/tasks/mercari-seller-listings/runs": { "post": { "tags": [ "Mercari" ], "summary": "Mercari Seller Listings API", "description": "Get a Mercari US seller’s listings with keyword, price, brand, category, condition and status filters. Follow next_cursor to get more results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "total_count", "seller_id" ], "properties": { "seller_id": { "type": "string" }, "total_count": { "type": "integer", "minimum": 0 } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-seller-listings" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "seller_id", "brand_id", "category_id", "title", "url", "price", "currency", "original_price", "image_url", "summary", "rating", "status", "brand", "condition", "size" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "size": { "type": [ "string", "null" ] }, "brand": { "type": [ "string", "null" ] }, "price": { "type": "string" }, "title": { "type": "string" }, "rating": { "type": "null" }, "status": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "brand_id": { "type": [ "number", "null" ] }, "currency": { "const": "USD" }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "seller_id": { "type": [ "string", "null" ] }, "category_id": { "type": [ "number", "null" ] }, "original_price": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-seller-listings", "task_name": "Mercari Seller Listings API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "seller_id": "id-1", "total_count": 1 }, "count": 1, "query": "London", "source": "mercari-seller-listings", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "size": "sample", "brand": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": null, "status": "sample", "summary": "Sample summary 1", "brand_id": 1.5, "currency": "USD", "condition": "sample", "image_url": "https://example.com/item-1", "seller_id": "id-1", "category_id": 1.5, "original_price": "180" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "total_count", "seller_id" ], "properties": { "seller_id": { "type": "string" }, "total_count": { "type": "integer", "minimum": 0 } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-seller-listings" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "seller_id", "brand_id", "category_id", "title", "url", "price", "currency", "original_price", "image_url", "summary", "rating", "status", "brand", "condition", "size" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "size": { "type": [ "string", "null" ] }, "brand": { "type": [ "string", "null" ] }, "price": { "type": "string" }, "title": { "type": "string" }, "rating": { "type": "null" }, "status": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "brand_id": { "type": [ "number", "null" ] }, "currency": { "const": "USD" }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "seller_id": { "type": [ "string", "null" ] }, "category_id": { "type": [ "number", "null" ] }, "original_price": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-seller-listings", "task_name": "Mercari Seller Listings API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMercariSellerListingsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2000, "minLength": 1, "description": "Public Mercari US seller profile URL.", "x-placeholder": "e.g. https://www.mercari.com/u/jaijuu/" }, "sort": { "enum": [ "best_match", "newest", "price_low_to_high", "price_high_to_low", "recently_sold" ], "type": "string", "default": "newest", "description": "Order results by relevance, listing date, price, or sale recency." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results to return. Review pages may return fewer than this limit." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Optional keywords within this seller’s listings." }, "cursor": { "type": "string", "description": "Opaque next_cursor from the previous response. Keep the same seller, query, filters, and limit." }, "status": { "enum": [ "all", "available", "sold" ], "type": "string", "default": "available", "description": "Listing status. Sold includes completed and in-progress sales; displayed prices are not guaranteed final transaction prices." }, "username": { "type": "string", "pattern": "^[A-Za-z0-9_.-]+$", "maxLength": 2000, "minLength": 1, "description": "Public Mercari username.", "x-placeholder": "e.g. jaijuu" }, "brand_ids": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "maxItems": 50, "x-advanced": true, "description": "Mercari brand IDs. Results include brand_id for subsequent filtering.", "uniqueItems": true }, "max_price": { "type": "number", "maximum": 1000000, "minimum": 0, "description": "Maximum item price in US dollars, excluding shipping and fees." }, "min_price": { "type": "number", "maximum": 1000000, "minimum": 0, "description": "Minimum item price in US dollars, excluding shipping and fees." }, "seller_id": { "type": "string", "pattern": "^[0-9]+$", "x-sample": "717873356", "x-advanced": true, "description": "Mercari seller ID, returned by search or seller listings." }, "conditions": { "type": "array", "items": { "enum": [ "new", "like_new", "good", "fair", "poor" ], "type": "string" }, "description": "Include listings in these conditions.", "uniqueItems": true }, "filters_url": { "type": "string", "format": "uri", "x-sample": "https://www.mercari.com/search/?keyword=jacket&brandIds=4591", "maxLength": 500, "minLength": 1, "description": "Copy a filtered Mercari search URL to reuse brand, category, condition and price filters without looking up IDs." }, "category_ids": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "maxItems": 50, "x-advanced": true, "description": "Mercari category IDs. Results include category_id for subsequent filtering.", "uniqueItems": true }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "seller_id" ] }, { "required": [ "username" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.mercari.com/u/jaijuu/" } } } }, "x-browsable-website-login-required": false } }, "/v1/mercari/seller/listings": { "post": { "tags": [ "Mercari" ], "summary": "Mercari Seller Listings API", "description": "Get a Mercari US seller’s listings with keyword, price, brand, category, condition and status filters. Follow next_cursor to get more results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "total_count", "seller_id" ], "properties": { "seller_id": { "type": "string" }, "total_count": { "type": "integer", "minimum": 0 } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-seller-listings" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "seller_id", "brand_id", "category_id", "title", "url", "price", "currency", "original_price", "image_url", "summary", "rating", "status", "brand", "condition", "size" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "size": { "type": [ "string", "null" ] }, "brand": { "type": [ "string", "null" ] }, "price": { "type": "string" }, "title": { "type": "string" }, "rating": { "type": "null" }, "status": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "brand_id": { "type": [ "number", "null" ] }, "currency": { "const": "USD" }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "seller_id": { "type": [ "string", "null" ] }, "category_id": { "type": [ "number", "null" ] }, "original_price": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-seller-listings", "task_name": "Mercari Seller Listings API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "seller_id": "id-1", "total_count": 1 }, "count": 1, "query": "London", "source": "mercari-seller-listings", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "size": "sample", "brand": "sample", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "rating": null, "status": "sample", "summary": "Sample summary 1", "brand_id": 1.5, "currency": "USD", "condition": "sample", "image_url": "https://example.com/item-1", "seller_id": "id-1", "category_id": 1.5, "original_price": "180" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "total_count", "seller_id" ], "properties": { "seller_id": { "type": "string" }, "total_count": { "type": "integer", "minimum": 0 } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-seller-listings" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "seller_id", "brand_id", "category_id", "title", "url", "price", "currency", "original_price", "image_url", "summary", "rating", "status", "brand", "condition", "size" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "size": { "type": [ "string", "null" ] }, "brand": { "type": [ "string", "null" ] }, "price": { "type": "string" }, "title": { "type": "string" }, "rating": { "type": "null" }, "status": { "type": [ "string", "null" ] }, "summary": { "type": [ "string", "null" ] }, "brand_id": { "type": [ "number", "null" ] }, "currency": { "const": "USD" }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "seller_id": { "type": [ "string", "null" ] }, "category_id": { "type": [ "number", "null" ] }, "original_price": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-seller-listings", "task_name": "Mercari Seller Listings API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMercariSellerListingsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2000, "minLength": 1, "description": "Public Mercari US seller profile URL.", "x-placeholder": "e.g. https://www.mercari.com/u/jaijuu/" }, "sort": { "enum": [ "best_match", "newest", "price_low_to_high", "price_high_to_low", "recently_sold" ], "type": "string", "default": "newest", "description": "Order results by relevance, listing date, price, or sale recency." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results to return. Review pages may return fewer than this limit." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Optional keywords within this seller’s listings." }, "cursor": { "type": "string", "description": "Opaque next_cursor from the previous response. Keep the same seller, query, filters, and limit." }, "status": { "enum": [ "all", "available", "sold" ], "type": "string", "default": "available", "description": "Listing status. Sold includes completed and in-progress sales; displayed prices are not guaranteed final transaction prices." }, "username": { "type": "string", "pattern": "^[A-Za-z0-9_.-]+$", "maxLength": 2000, "minLength": 1, "description": "Public Mercari username.", "x-placeholder": "e.g. jaijuu" }, "brand_ids": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "maxItems": 50, "x-advanced": true, "description": "Mercari brand IDs. Results include brand_id for subsequent filtering.", "uniqueItems": true }, "max_price": { "type": "number", "maximum": 1000000, "minimum": 0, "description": "Maximum item price in US dollars, excluding shipping and fees." }, "min_price": { "type": "number", "maximum": 1000000, "minimum": 0, "description": "Minimum item price in US dollars, excluding shipping and fees." }, "seller_id": { "type": "string", "pattern": "^[0-9]+$", "x-sample": "717873356", "x-advanced": true, "description": "Mercari seller ID, returned by search or seller listings." }, "conditions": { "type": "array", "items": { "enum": [ "new", "like_new", "good", "fair", "poor" ], "type": "string" }, "description": "Include listings in these conditions.", "uniqueItems": true }, "filters_url": { "type": "string", "format": "uri", "x-sample": "https://www.mercari.com/search/?keyword=jacket&brandIds=4591", "maxLength": 500, "minLength": 1, "description": "Copy a filtered Mercari search URL to reuse brand, category, condition and price filters without looking up IDs." }, "category_ids": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "maxItems": 50, "x-advanced": true, "description": "Mercari category IDs. Results include category_id for subsequent filtering.", "uniqueItems": true }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "seller_id" ] }, { "required": [ "username" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.mercari.com/u/jaijuu/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-mercari-seller-listings" }, "x-browsable-website-login-required": false } }, "/v1/tasks/mercari-seller-reviews/runs": { "post": { "tags": [ "Mercari" ], "summary": "Mercari Seller Reviews API", "description": "Get public Mercari US account feedback, newest first. Choose reviews from buyers or sellers. Automated Mercari messages are labelled.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "seller_id", "review_type" ], "properties": { "seller_id": { "type": "string" }, "review_type": { "enum": [ "buyers", "sellers" ], "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-seller-reviews" }, "results": { "type": "array", "items": { "type": "object", "required": [ "text", "rating_label", "created_at", "reviewer_id", "reviewer_name", "reviewer_image_url", "is_automated", "reviewer_role", "feedback" ], "properties": { "text": { "type": "string" }, "feedback": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string" }, "reviewer_id": { "type": [ "string", "null" ] }, "is_automated": { "type": "boolean" }, "rating_label": { "type": [ "string", "null" ] }, "reviewer_name": { "type": [ "string", "null" ] }, "reviewer_role": { "type": [ "string", "null" ] }, "reviewer_image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-seller-reviews", "task_name": "Mercari Seller Reviews API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "seller_id": "id-1", "review_type": "buyers" }, "count": 1, "query": "London", "source": "mercari-seller-reviews", "results": [ { "text": "Sample text 1", "feedback": [ "sample" ], "created_at": "2026-06-14T15:30:00Z", "reviewer_id": "id-1", "is_automated": true, "rating_label": "Stylish Shoreditch Loft with Balcony", "reviewer_name": "Stylish Shoreditch Loft with Balcony", "reviewer_role": "sample", "reviewer_image_url": "https://example.com/item-1" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "seller_id", "review_type" ], "properties": { "seller_id": { "type": "string" }, "review_type": { "enum": [ "buyers", "sellers" ], "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-seller-reviews" }, "results": { "type": "array", "items": { "type": "object", "required": [ "text", "rating_label", "created_at", "reviewer_id", "reviewer_name", "reviewer_image_url", "is_automated", "reviewer_role", "feedback" ], "properties": { "text": { "type": "string" }, "feedback": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string" }, "reviewer_id": { "type": [ "string", "null" ] }, "is_automated": { "type": "boolean" }, "rating_label": { "type": [ "string", "null" ] }, "reviewer_name": { "type": [ "string", "null" ] }, "reviewer_role": { "type": [ "string", "null" ] }, "reviewer_image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-seller-reviews", "task_name": "Mercari Seller Reviews API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMercariSellerReviewsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2000, "minLength": 1, "description": "Public Mercari US seller profile URL.", "x-placeholder": "e.g. https://www.mercari.com/u/jaijuu/" }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results to return. Review pages may return fewer than this limit." }, "cursor": { "type": "string", "description": "Opaque next_cursor from the previous response. Keep the same seller, query, filters, and limit." }, "username": { "type": "string", "pattern": "^[A-Za-z0-9_.-]+$", "maxLength": 2000, "minLength": 1, "description": "Public Mercari username.", "x-placeholder": "e.g. jaijuu" }, "seller_id": { "type": "string", "pattern": "^[0-9]+$", "x-sample": "717873356", "x-advanced": true, "description": "Mercari seller ID, returned by search or seller listings." }, "review_type": { "enum": [ "buyers", "sellers" ], "type": "string", "default": "buyers", "description": "Buyers reviews assess this account as a seller; sellers reviews assess it as a buyer." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "seller_id" ] }, { "required": [ "username" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.mercari.com/u/jaijuu/" } } } }, "x-browsable-website-login-required": false } }, "/v1/mercari/seller/reviews": { "post": { "tags": [ "Mercari" ], "summary": "Mercari Seller Reviews API", "description": "Get public Mercari US account feedback, newest first. Choose reviews from buyers or sellers. Automated Mercari messages are labelled.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "seller_id", "review_type" ], "properties": { "seller_id": { "type": "string" }, "review_type": { "enum": [ "buyers", "sellers" ], "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-seller-reviews" }, "results": { "type": "array", "items": { "type": "object", "required": [ "text", "rating_label", "created_at", "reviewer_id", "reviewer_name", "reviewer_image_url", "is_automated", "reviewer_role", "feedback" ], "properties": { "text": { "type": "string" }, "feedback": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string" }, "reviewer_id": { "type": [ "string", "null" ] }, "is_automated": { "type": "boolean" }, "rating_label": { "type": [ "string", "null" ] }, "reviewer_name": { "type": [ "string", "null" ] }, "reviewer_role": { "type": [ "string", "null" ] }, "reviewer_image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-seller-reviews", "task_name": "Mercari Seller Reviews API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "seller_id": "id-1", "review_type": "buyers" }, "count": 1, "query": "London", "source": "mercari-seller-reviews", "results": [ { "text": "Sample text 1", "feedback": [ "sample" ], "created_at": "2026-06-14T15:30:00Z", "reviewer_id": "id-1", "is_automated": true, "rating_label": "Stylish Shoreditch Loft with Balcony", "reviewer_name": "Stylish Shoreditch Loft with Balcony", "reviewer_role": "sample", "reviewer_image_url": "https://example.com/item-1" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": "string" }, "data": { "type": "object", "required": [ "seller_id", "review_type" ], "properties": { "seller_id": { "type": "string" }, "review_type": { "enum": [ "buyers", "sellers" ], "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "mercari-seller-reviews" }, "results": { "type": "array", "items": { "type": "object", "required": [ "text", "rating_label", "created_at", "reviewer_id", "reviewer_name", "reviewer_image_url", "is_automated", "reviewer_role", "feedback" ], "properties": { "text": { "type": "string" }, "feedback": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string" }, "reviewer_id": { "type": [ "string", "null" ] }, "is_automated": { "type": "boolean" }, "rating_label": { "type": [ "string", "null" ] }, "reviewer_name": { "type": [ "string", "null" ] }, "reviewer_role": { "type": [ "string", "null" ] }, "reviewer_image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "maximum": 100, "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "mercari-seller-reviews", "task_name": "Mercari Seller Reviews API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runMercariSellerReviewsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2000, "minLength": 1, "description": "Public Mercari US seller profile URL.", "x-placeholder": "e.g. https://www.mercari.com/u/jaijuu/" }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum results to return. Review pages may return fewer than this limit." }, "cursor": { "type": "string", "description": "Opaque next_cursor from the previous response. Keep the same seller, query, filters, and limit." }, "username": { "type": "string", "pattern": "^[A-Za-z0-9_.-]+$", "maxLength": 2000, "minLength": 1, "description": "Public Mercari username.", "x-placeholder": "e.g. jaijuu" }, "seller_id": { "type": "string", "pattern": "^[0-9]+$", "x-sample": "717873356", "x-advanced": true, "description": "Mercari seller ID, returned by search or seller listings." }, "review_type": { "enum": [ "buyers", "sellers" ], "type": "string", "default": "buyers", "description": "Buyers reviews assess this account as a seller; sellers reviews assess it as a buyer." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "seller_id" ] }, { "required": [ "username" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.mercari.com/u/jaijuu/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-mercari-seller-reviews" }, "x-browsable-website-login-required": false } }, "/v1/tasks/offerup-item/runs": { "post": { "tags": [ "OfferUp" ], "summary": "OfferUp Item API", "description": "Read an OfferUp listing's full description, photos, condition code, price and available seller trust summary. No website login required. Removed listings may be unavailable.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "url", "title", "description", "price", "currency", "status", "condition_code", "posted_at", "firm_price", "location", "image_urls", "local_pickup", "shipping_enabled", "shipping_price", "category", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seller": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } ] }, "status": { "type": [ "string", "null" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "posted_at": { "type": [ "string", "null" ] }, "firm_price": { "type": [ "boolean", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "local_pickup": { "type": [ "boolean", "null" ] }, "condition_code": { "type": [ "number", "null" ] }, "shipping_price": { "type": [ "string", "null" ] }, "shipping_enabled": { "type": [ "boolean", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-item" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "description", "price", "currency", "status", "condition_code", "posted_at", "firm_price", "location", "image_urls", "local_pickup", "shipping_enabled", "shipping_price", "category", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seller": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } ] }, "status": { "type": [ "string", "null" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "posted_at": { "type": [ "string", "null" ] }, "firm_price": { "type": [ "boolean", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "local_pickup": { "type": [ "boolean", "null" ] }, "condition_code": { "type": [ "number", "null" ] }, "shipping_price": { "type": [ "string", "null" ] }, "shipping_enabled": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-item", "task_name": "OfferUp Item API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "seller": null, "status": "sample", "category": { "id": "id-1", "name": "Stylish Shoreditch Loft with Balcony" }, "currency": "USD", "location": "London", "posted_at": "sample", "firm_price": true, "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "local_pickup": true, "condition_code": 1.5, "shipping_price": "180", "shipping_enabled": true }, "count": 1, "query": "London", "source": "offerup-item", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "seller": null, "status": "sample", "category": { "id": "id-1", "name": "Stylish Shoreditch Loft with Balcony" }, "currency": "USD", "location": "London", "posted_at": "sample", "firm_price": true, "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "local_pickup": true, "condition_code": 1.5, "shipping_price": "180", "shipping_enabled": true } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "url", "title", "description", "price", "currency", "status", "condition_code", "posted_at", "firm_price", "location", "image_urls", "local_pickup", "shipping_enabled", "shipping_price", "category", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seller": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } ] }, "status": { "type": [ "string", "null" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "posted_at": { "type": [ "string", "null" ] }, "firm_price": { "type": [ "boolean", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "local_pickup": { "type": [ "boolean", "null" ] }, "condition_code": { "type": [ "number", "null" ] }, "shipping_price": { "type": [ "string", "null" ] }, "shipping_enabled": { "type": [ "boolean", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-item" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "description", "price", "currency", "status", "condition_code", "posted_at", "firm_price", "location", "image_urls", "local_pickup", "shipping_enabled", "shipping_price", "category", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seller": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } ] }, "status": { "type": [ "string", "null" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "posted_at": { "type": [ "string", "null" ] }, "firm_price": { "type": [ "boolean", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "local_pickup": { "type": [ "boolean", "null" ] }, "condition_code": { "type": [ "number", "null" ] }, "shipping_price": { "type": [ "string", "null" ] }, "shipping_enabled": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-item", "task_name": "OfferUp Item API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOfferupItemCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$", "description": "Item ID from an OfferUp listing URL or search result. You can provide the listing URL instead." }, "url": { "type": "string", "pattern": "^https://(?:www\\.)?offerup\\.com/item/detail/[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}/?(?:[?#].*)?$", "x-sample": "https://offerup.com/item/detail/98e4c905-31bf-39df-a6dc-751c1fa6553d", "maxLength": 2000, "minLength": 1, "description": "Public page URL." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "id" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://offerup.com/item/detail/98e4c905-31bf-39df-a6dc-751c1fa6553d" } } } }, "x-browsable-website-login-required": false } }, "/v1/offerup/item": { "post": { "tags": [ "OfferUp" ], "summary": "OfferUp Item API", "description": "Read an OfferUp listing's full description, photos, condition code, price and available seller trust summary. No website login required. Removed listings may be unavailable.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "url", "title", "description", "price", "currency", "status", "condition_code", "posted_at", "firm_price", "location", "image_urls", "local_pickup", "shipping_enabled", "shipping_price", "category", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seller": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } ] }, "status": { "type": [ "string", "null" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "posted_at": { "type": [ "string", "null" ] }, "firm_price": { "type": [ "boolean", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "local_pickup": { "type": [ "boolean", "null" ] }, "condition_code": { "type": [ "number", "null" ] }, "shipping_price": { "type": [ "string", "null" ] }, "shipping_enabled": { "type": [ "boolean", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-item" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "description", "price", "currency", "status", "condition_code", "posted_at", "firm_price", "location", "image_urls", "local_pickup", "shipping_enabled", "shipping_price", "category", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seller": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } ] }, "status": { "type": [ "string", "null" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "posted_at": { "type": [ "string", "null" ] }, "firm_price": { "type": [ "boolean", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "local_pickup": { "type": [ "boolean", "null" ] }, "condition_code": { "type": [ "number", "null" ] }, "shipping_price": { "type": [ "string", "null" ] }, "shipping_enabled": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-item", "task_name": "OfferUp Item API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "seller": null, "status": "sample", "category": { "id": "id-1", "name": "Stylish Shoreditch Loft with Balcony" }, "currency": "USD", "location": "London", "posted_at": "sample", "firm_price": true, "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "local_pickup": true, "condition_code": 1.5, "shipping_price": "180", "shipping_enabled": true }, "count": 1, "query": "London", "source": "offerup-item", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "seller": null, "status": "sample", "category": { "id": "id-1", "name": "Stylish Shoreditch Loft with Balcony" }, "currency": "USD", "location": "London", "posted_at": "sample", "firm_price": true, "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "local_pickup": true, "condition_code": 1.5, "shipping_price": "180", "shipping_enabled": true } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "url", "title", "description", "price", "currency", "status", "condition_code", "posted_at", "firm_price", "location", "image_urls", "local_pickup", "shipping_enabled", "shipping_price", "category", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seller": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } ] }, "status": { "type": [ "string", "null" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "posted_at": { "type": [ "string", "null" ] }, "firm_price": { "type": [ "boolean", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "local_pickup": { "type": [ "boolean", "null" ] }, "condition_code": { "type": [ "number", "null" ] }, "shipping_price": { "type": [ "string", "null" ] }, "shipping_enabled": { "type": [ "boolean", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-item" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "description", "price", "currency", "status", "condition_code", "posted_at", "firm_price", "location", "image_urls", "local_pickup", "shipping_enabled", "shipping_price", "category", "seller" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "seller": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } ] }, "status": { "type": [ "string", "null" ] }, "category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "posted_at": { "type": [ "string", "null" ] }, "firm_price": { "type": [ "boolean", "null" ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "string", "null" ] }, "local_pickup": { "type": [ "boolean", "null" ] }, "condition_code": { "type": [ "number", "null" ] }, "shipping_price": { "type": [ "string", "null" ] }, "shipping_enabled": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-item", "task_name": "OfferUp Item API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOfferupItemAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$", "description": "Item ID from an OfferUp listing URL or search result. You can provide the listing URL instead." }, "url": { "type": "string", "pattern": "^https://(?:www\\.)?offerup\\.com/item/detail/[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}/?(?:[?#].*)?$", "x-sample": "https://offerup.com/item/detail/98e4c905-31bf-39df-a6dc-751c1fa6553d", "maxLength": 2000, "minLength": 1, "description": "Public page URL." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "id" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://offerup.com/item/detail/98e4c905-31bf-39df-a6dc-751c1fa6553d" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-offerup-item" }, "x-browsable-website-login-required": false } }, "/v1/tasks/offerup-search/runs": { "post": { "tags": [ "OfferUp" ], "summary": "OfferUp Search API", "description": "Search OfferUp listings near a US city and state or ZIP code. Location is resolved automatically. Returns prices, locations, images and pickup information with cursor pagination. Seller ratings and cancellations are not included in OfferUp's search feed.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "location", "latitude", "longitude", "radius_miles", "applied_query", "seller_trust_available" ], "properties": { "latitude": { "type": "number" }, "location": { "type": "string" }, "longitude": { "type": "number" }, "radius_miles": { "type": "integer" }, "applied_query": { "type": [ "string", "null" ] }, "seller_trust_available": { "const": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "url", "price", "currency", "location", "condition", "image_url", "firm_price", "local_pickup" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "firm_price": { "type": [ "boolean", "null" ] }, "local_pickup": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "const": "cursor" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-search", "task_name": "OfferUp Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "latitude": 51.5074, "location": "London", "longitude": -0.1278, "radius_miles": 1, "applied_query": "London", "seller_trust_available": false }, "count": 1, "query": "London", "source": "offerup-search", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "currency": "USD", "location": "London", "condition": "sample", "image_url": "https://example.com/item-1", "firm_price": true, "local_pickup": true } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "cursor", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "location", "latitude", "longitude", "radius_miles", "applied_query", "seller_trust_available" ], "properties": { "latitude": { "type": "number" }, "location": { "type": "string" }, "longitude": { "type": "number" }, "radius_miles": { "type": "integer" }, "applied_query": { "type": [ "string", "null" ] }, "seller_trust_available": { "const": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "url", "price", "currency", "location", "condition", "image_url", "firm_price", "local_pickup" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "firm_price": { "type": [ "boolean", "null" ] }, "local_pickup": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "const": "cursor" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-search", "task_name": "OfferUp Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOfferupSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sort": { "enum": [ "best_match", "newest", "closest", "price_low", "price_high" ], "type": "string", "description": "Sort order. Choose an allowed value below." }, "limit": { "type": "integer", "default": 25, "maximum": 50, "minimum": 1, "description": "Maximum results in this response." }, "query": { "type": "string", "maxLength": 200, "minLength": 1, "description": "Search words, such as iPhone 13 or Nintendo Switch.", "x-sample-value": "iphone 13" }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from the previous response. Keep the other search inputs unchanged." }, "location": { "type": "string", "maxLength": 200, "minLength": 2, "description": "US city and state, such as Los Angeles, CA, or a 5-digit ZIP code. Coordinates are resolved automatically.", "x-sample-value": "Los Angeles, CA" }, "condition": { "enum": [ "new", "open_box", "refurbished", "used", "for_parts", "other" ], "type": "string", "description": "Filter by an allowed product condition." }, "max_price": { "type": "number", "maximum": 1000000, "minimum": 0, "description": "Maximum price in the marketplace currency." }, "min_price": { "type": "number", "maximum": 1000000, "minimum": 0, "description": "Minimum price in the marketplace currency." }, "category_id": { "type": "string", "pattern": "^[0-9]{1,4}(?:\\.[0-9]{1,4}){0,2}$", "x-advanced": true, "description": "OfferUp category id, such as 1.2 for cell phones and accessories." }, "radius_miles": { "enum": [ 5, 10, 20, 30, 50, 80 ], "type": "integer", "default": 30, "description": "Search radius in miles around the resolved location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query", "location" ] }, "example": { "query": "London", "location": "London" } } } }, "x-browsable-website-login-required": false } }, "/v1/offerup/search": { "post": { "tags": [ "OfferUp" ], "summary": "OfferUp Search API", "description": "Search OfferUp listings near a US city and state or ZIP code. Location is resolved automatically. Returns prices, locations, images and pickup information with cursor pagination. Seller ratings and cancellations are not included in OfferUp's search feed.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "location", "latitude", "longitude", "radius_miles", "applied_query", "seller_trust_available" ], "properties": { "latitude": { "type": "number" }, "location": { "type": "string" }, "longitude": { "type": "number" }, "radius_miles": { "type": "integer" }, "applied_query": { "type": [ "string", "null" ] }, "seller_trust_available": { "const": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "url", "price", "currency", "location", "condition", "image_url", "firm_price", "local_pickup" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "firm_price": { "type": [ "boolean", "null" ] }, "local_pickup": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "const": "cursor" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-search", "task_name": "OfferUp Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "latitude": 51.5074, "location": "London", "longitude": -0.1278, "radius_miles": 1, "applied_query": "London", "seller_trust_available": false }, "count": 1, "query": "London", "source": "offerup-search", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "currency": "USD", "location": "London", "condition": "sample", "image_url": "https://example.com/item-1", "firm_price": true, "local_pickup": true } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "cursor", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "location", "latitude", "longitude", "radius_miles", "applied_query", "seller_trust_available" ], "properties": { "latitude": { "type": "number" }, "location": { "type": "string" }, "longitude": { "type": "number" }, "radius_miles": { "type": "integer" }, "applied_query": { "type": [ "string", "null" ] }, "seller_trust_available": { "const": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "url", "price", "currency", "location", "condition", "image_url", "firm_price", "local_pickup" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "condition": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "firm_price": { "type": [ "boolean", "null" ] }, "local_pickup": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "const": "cursor" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-search", "task_name": "OfferUp Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOfferupSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sort": { "enum": [ "best_match", "newest", "closest", "price_low", "price_high" ], "type": "string", "description": "Sort order. Choose an allowed value below." }, "limit": { "type": "integer", "default": 25, "maximum": 50, "minimum": 1, "description": "Maximum results in this response." }, "query": { "type": "string", "maxLength": 200, "minLength": 1, "description": "Search words, such as iPhone 13 or Nintendo Switch.", "x-sample-value": "iphone 13" }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from the previous response. Keep the other search inputs unchanged." }, "location": { "type": "string", "maxLength": 200, "minLength": 2, "description": "US city and state, such as Los Angeles, CA, or a 5-digit ZIP code. Coordinates are resolved automatically.", "x-sample-value": "Los Angeles, CA" }, "condition": { "enum": [ "new", "open_box", "refurbished", "used", "for_parts", "other" ], "type": "string", "description": "Filter by an allowed product condition." }, "max_price": { "type": "number", "maximum": 1000000, "minimum": 0, "description": "Maximum price in the marketplace currency." }, "min_price": { "type": "number", "maximum": 1000000, "minimum": 0, "description": "Minimum price in the marketplace currency." }, "category_id": { "type": "string", "pattern": "^[0-9]{1,4}(?:\\.[0-9]{1,4}){0,2}$", "x-advanced": true, "description": "OfferUp category id, such as 1.2 for cell phones and accessories." }, "radius_miles": { "enum": [ 5, 10, 20, 30, 50, 80 ], "type": "integer", "default": 30, "description": "Search radius in miles around the resolved location." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query", "location" ] }, "example": { "query": "London", "location": "London" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-offerup-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/offerup-seller/runs": { "post": { "tags": [ "OfferUp" ], "summary": "OfferUp Seller API", "description": "Read a public OfferUp seller profile, including available ratings, account age, activity, response time, badges and compliments. Missing metrics are null; cancellation rates are not available.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-seller" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-seller", "task_name": "OfferUp Seller API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "badges": [ "Guest favorite" ], "rating": 4.91, "location": "London", "followers": 1.5, "image_url": "https://example.com/item-1", "joined_at": "sample", "items_sold": 1.5, "compliments": [ { "count": 1, "label": "Stylish Shoreditch Loft with Balcony" } ], "is_business": true, "last_active": "sample", "rating_count": 4.91, "response_time": "sample", "items_purchased": 1.5, "truyou_verified": true }, "count": 1, "query": "London", "source": "offerup-seller", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "badges": [ "Guest favorite" ], "rating": 4.91, "location": "London", "followers": 1.5, "image_url": "https://example.com/item-1", "joined_at": "sample", "items_sold": 1.5, "compliments": [ { "count": 1, "label": "Stylish Shoreditch Loft with Balcony" } ], "is_business": true, "last_active": "sample", "rating_count": 4.91, "response_time": "sample", "items_purchased": 1.5, "truyou_verified": true } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-seller" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-seller", "task_name": "OfferUp Seller API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOfferupSellerCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "pattern": "^https://(?:www\\.)?offerup\\.com/p/[0-9]{1,15}/?(?:[?#].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public page URL." }, "seller_id": { "type": "string", "pattern": "^[0-9]{1,15}$", "x-sample": "125746222", "x-advanced": true, "description": "Upstream seller ID returned by search or a seller profile. Prefer a seller URL when supported." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "seller_id" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://offerup.com/p/123456" } } } }, "x-browsable-website-login-required": false } }, "/v1/offerup/seller": { "post": { "tags": [ "OfferUp" ], "summary": "OfferUp Seller API", "description": "Read a public OfferUp seller profile, including available ratings, account age, activity, response time, badges and compliments. Missing metrics are null; cancellation rates are not available.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-seller" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-seller", "task_name": "OfferUp Seller API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "badges": [ "Guest favorite" ], "rating": 4.91, "location": "London", "followers": 1.5, "image_url": "https://example.com/item-1", "joined_at": "sample", "items_sold": 1.5, "compliments": [ { "count": 1, "label": "Stylish Shoreditch Loft with Balcony" } ], "is_business": true, "last_active": "sample", "rating_count": 4.91, "response_time": "sample", "items_purchased": 1.5, "truyou_verified": true }, "count": 1, "query": "London", "source": "offerup-seller", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "badges": [ "Guest favorite" ], "rating": 4.91, "location": "London", "followers": 1.5, "image_url": "https://example.com/item-1", "joined_at": "sample", "items_sold": 1.5, "compliments": [ { "count": 1, "label": "Stylish Shoreditch Loft with Balcony" } ], "is_business": true, "last_active": "sample", "rating_count": 4.91, "response_time": "sample", "items_purchased": 1.5, "truyou_verified": true } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-seller" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "name", "location", "joined_at", "rating", "rating_count", "items_sold", "items_purchased", "followers", "response_time", "last_active", "badges", "compliments", "truyou_verified", "is_business", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "badges": { "type": "array", "items": { "type": "string" } }, "rating": { "type": [ "number", "null" ] }, "location": { "type": [ "string", "null" ] }, "followers": { "type": [ "number", "null" ] }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "items_sold": { "type": [ "number", "null" ] }, "compliments": { "type": "array", "items": { "type": "object", "required": [ "label", "count" ], "properties": { "count": { "type": [ "number", "null" ] }, "label": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "is_business": { "type": [ "boolean", "null" ] }, "last_active": { "type": [ "string", "null" ] }, "rating_count": { "type": [ "number", "null" ] }, "response_time": { "type": [ "string", "null" ] }, "items_purchased": { "type": [ "number", "null" ] }, "truyou_verified": { "type": [ "boolean", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-seller", "task_name": "OfferUp Seller API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOfferupSellerAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "pattern": "^https://(?:www\\.)?offerup\\.com/p/[0-9]{1,15}/?(?:[?#].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public page URL." }, "seller_id": { "type": "string", "pattern": "^[0-9]{1,15}$", "x-sample": "125746222", "x-advanced": true, "description": "Upstream seller ID returned by search or a seller profile. Prefer a seller URL when supported." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "seller_id" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://offerup.com/p/123456" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-offerup-seller" }, "x-browsable-website-login-required": false } }, "/v1/tasks/offerup-seller-listings/runs": { "post": { "tags": [ "OfferUp" ], "summary": "OfferUp Seller Listings API", "description": "Browse a public OfferUp seller's active listings with cursor pagination. Keep seller_id and limit unchanged when continuing.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "seller_id" ], "properties": { "seller_id": { "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-seller-listings" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "price", "currency", "status", "location", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-seller-listings", "task_name": "OfferUp Seller Listings API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "seller_id": "id-1" }, "count": 1, "query": "London", "source": "offerup-seller-listings", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "status": "sample", "currency": "USD", "location": "London", "image_url": "https://example.com/item-1" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "seller_id" ], "properties": { "seller_id": { "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-seller-listings" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "price", "currency", "status", "location", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-seller-listings", "task_name": "OfferUp Seller Listings API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOfferupSellerListingsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "pattern": "^https://(?:www\\.)?offerup\\.com/p/[0-9]{1,15}/?(?:[?#].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public page URL." }, "limit": { "type": "integer", "default": 25, "maximum": 50, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from the previous response. Keep all other inputs unchanged. Expires after 30 minutes." }, "seller_id": { "type": "string", "pattern": "^[0-9]{1,15}$", "x-sample": "125746222", "x-advanced": true, "description": "Upstream seller ID returned by search or a seller profile. Prefer a seller URL when supported." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "seller_id" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://offerup.com/p/123456" } } } }, "x-browsable-website-login-required": false } }, "/v1/offerup/seller-listings": { "post": { "tags": [ "OfferUp" ], "summary": "OfferUp Seller Listings API", "description": "Browse a public OfferUp seller's active listings with cursor pagination. Keep seller_id and limit unchanged when continuing.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "seller_id" ], "properties": { "seller_id": { "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-seller-listings" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "price", "currency", "status", "location", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-seller-listings", "task_name": "OfferUp Seller Listings API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "seller_id": "id-1" }, "count": 1, "query": "London", "source": "offerup-seller-listings", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "price": "180", "title": "Stylish Shoreditch Loft with Balcony", "status": "sample", "currency": "USD", "location": "London", "image_url": "https://example.com/item-1" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "seller_id" ], "properties": { "seller_id": { "type": "string" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "offerup-seller-listings" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "price", "currency", "status", "location", "image_url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "price": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "currency": { "const": "USD" }, "location": { "type": [ "string", "null" ] }, "image_url": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "offerup-seller-listings", "task_name": "OfferUp Seller Listings API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOfferupSellerListingsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "pattern": "^https://(?:www\\.)?offerup\\.com/p/[0-9]{1,15}/?(?:[?#].*)?$", "maxLength": 2000, "minLength": 1, "description": "Public page URL." }, "limit": { "type": "integer", "default": 25, "maximum": 50, "minimum": 1, "description": "Maximum results in this response." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from the previous response. Keep all other inputs unchanged. Expires after 30 minutes." }, "seller_id": { "type": "string", "pattern": "^[0-9]{1,15}$", "x-sample": "125746222", "x-advanced": true, "description": "Upstream seller ID returned by search or a seller profile. Prefer a seller URL when supported." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "seller_id" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://offerup.com/p/123456" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-offerup-seller-listings" }, "x-browsable-website-login-required": false } }, "/v1/tasks/olx-listing/runs": { "post": { "tags": [ "OLX" ], "summary": "OLX Listing API", "description": "Scrape a public OLX listing page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "olx-listing", "task_name": "OLX Listing API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "olx-listing", "task_name": "OLX Listing API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOlxListingCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.olx.com/item/example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.olx.com/item/example" } } } }, "x-browsable-website-login-required": false } }, "/v1/olx/listing": { "post": { "tags": [ "OLX" ], "summary": "OLX Listing API", "description": "Scrape a public OLX listing page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "olx-listing", "task_name": "OLX Listing API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "olx-listing", "task_name": "OLX Listing API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOlxListingAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.olx.com/item/example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.olx.com/item/example" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-olx-listing" }, "x-browsable-website-login-required": false } }, "/v1/tasks/olx-search/runs": { "post": { "tags": [ "OLX" ], "summary": "OLX API", "description": "Scrape public OLX listing search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "olx-search", "task_name": "OLX API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "olx-search", "task_name": "OLX API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOlxSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "bicycle", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. bicycle" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "bicycle" } } } }, "x-browsable-website-login-required": false } }, "/v1/olx/search": { "post": { "tags": [ "OLX" ], "summary": "OLX API", "description": "Scrape public OLX listing search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "olx-search", "task_name": "OLX API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "olx-search", "task_name": "OLX API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOlxSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "bicycle", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. bicycle" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "bicycle" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-olx-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/onlyfans-profile/runs": { "post": { "tags": [ "OnlyFans" ], "summary": "OnlyFans API", "description": "Fetch public OnlyFans profile details, subscription pricing and visible counts without connecting an OnlyFans account. Hidden counts are null; restricted profiles may be unavailable.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "username", "name", "title", "url", "description", "avatar_url", "image_url", "header_url", "subscription_price", "posts_count", "photos_count", "videos_count", "audios_count", "media_count", "likes_count", "subscribers_count", "is_verified", "is_performer", "website", "location", "joined_at", "fetched_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "fetched_at": { "type": "string" }, "header_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "description": "Creator biography; may contain HTML." }, "is_verified": { "type": [ "boolean", "null" ] }, "likes_count": { "type": [ "number", "null" ], "minimum": 0 }, "media_count": { "type": [ "number", "null" ], "minimum": 0 }, "posts_count": { "type": [ "number", "null" ], "minimum": 0 }, "audios_count": { "type": [ "number", "null" ], "minimum": 0 }, "is_performer": { "type": [ "boolean", "null" ] }, "photos_count": { "type": [ "number", "null" ], "minimum": 0 }, "videos_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscribers_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscription_price": { "type": [ "number", "null" ], "minimum": 0 } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "onlyfans-profile" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "username", "name", "title", "url", "description", "avatar_url", "image_url", "header_url", "subscription_price", "posts_count", "photos_count", "videos_count", "audios_count", "media_count", "likes_count", "subscribers_count", "is_verified", "is_performer", "website", "location", "joined_at", "fetched_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "fetched_at": { "type": "string" }, "header_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "description": "Creator biography; may contain HTML." }, "is_verified": { "type": [ "boolean", "null" ] }, "likes_count": { "type": [ "number", "null" ], "minimum": 0 }, "media_count": { "type": [ "number", "null" ], "minimum": 0 }, "posts_count": { "type": [ "number", "null" ], "minimum": 0 }, "audios_count": { "type": [ "number", "null" ], "minimum": 0 }, "is_performer": { "type": [ "boolean", "null" ] }, "photos_count": { "type": [ "number", "null" ], "minimum": 0 }, "videos_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscribers_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscription_price": { "type": [ "number", "null" ], "minimum": 0 } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "onlyfans-profile", "task_name": "OnlyFans API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "title": "Stylish Shoreditch Loft with Balcony", "website": "sample", "location": "London", "username": "Stylish Shoreditch Loft with Balcony", "image_url": "https://example.com/item-1", "joined_at": "sample", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "fetched_at": "sample", "header_url": "https://example.com/item-1", "description": "Sample description 1", "is_verified": true, "likes_count": 1, "media_count": 1, "posts_count": 1, "audios_count": 1, "is_performer": true, "photos_count": 1, "videos_count": 1, "subscribers_count": 1, "subscription_price": 180 }, "count": 1, "query": "London", "source": "onlyfans-profile", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "title": "Stylish Shoreditch Loft with Balcony", "website": "sample", "location": "London", "username": "Stylish Shoreditch Loft with Balcony", "image_url": "https://example.com/item-1", "joined_at": "sample", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "fetched_at": "sample", "header_url": "https://example.com/item-1", "description": "Sample description 1", "is_verified": true, "likes_count": 1, "media_count": 1, "posts_count": 1, "audios_count": 1, "is_performer": true, "photos_count": 1, "videos_count": 1, "subscribers_count": 1, "subscription_price": 180 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "username", "name", "title", "url", "description", "avatar_url", "image_url", "header_url", "subscription_price", "posts_count", "photos_count", "videos_count", "audios_count", "media_count", "likes_count", "subscribers_count", "is_verified", "is_performer", "website", "location", "joined_at", "fetched_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "fetched_at": { "type": "string" }, "header_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "description": "Creator biography; may contain HTML." }, "is_verified": { "type": [ "boolean", "null" ] }, "likes_count": { "type": [ "number", "null" ], "minimum": 0 }, "media_count": { "type": [ "number", "null" ], "minimum": 0 }, "posts_count": { "type": [ "number", "null" ], "minimum": 0 }, "audios_count": { "type": [ "number", "null" ], "minimum": 0 }, "is_performer": { "type": [ "boolean", "null" ] }, "photos_count": { "type": [ "number", "null" ], "minimum": 0 }, "videos_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscribers_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscription_price": { "type": [ "number", "null" ], "minimum": 0 } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "onlyfans-profile" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "username", "name", "title", "url", "description", "avatar_url", "image_url", "header_url", "subscription_price", "posts_count", "photos_count", "videos_count", "audios_count", "media_count", "likes_count", "subscribers_count", "is_verified", "is_performer", "website", "location", "joined_at", "fetched_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "fetched_at": { "type": "string" }, "header_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "description": "Creator biography; may contain HTML." }, "is_verified": { "type": [ "boolean", "null" ] }, "likes_count": { "type": [ "number", "null" ], "minimum": 0 }, "media_count": { "type": [ "number", "null" ], "minimum": 0 }, "posts_count": { "type": [ "number", "null" ], "minimum": 0 }, "audios_count": { "type": [ "number", "null" ], "minimum": 0 }, "is_performer": { "type": [ "boolean", "null" ] }, "photos_count": { "type": [ "number", "null" ], "minimum": 0 }, "videos_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscribers_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscription_price": { "type": [ "number", "null" ], "minimum": 0 } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "onlyfans-profile", "task_name": "OnlyFans API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOnlyfansProfileCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "maximum": 100, "minimum": 1, "x-advanced": true, "description": "Accepted for compatibility; a profile lookup returns one profile. It does not paginate posts." }, "username": { "type": "string", "x-sample": "onlyfans", "maxLength": 128, "minLength": 1, "description": "OnlyFans username, @handle, or profile URL." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "onlyfans" } } } }, "x-browsable-website-login-required": false } }, "/v1/onlyfans/profile": { "post": { "tags": [ "OnlyFans" ], "summary": "OnlyFans API", "description": "Fetch public OnlyFans profile details, subscription pricing and visible counts without connecting an OnlyFans account. Hidden counts are null; restricted profiles may be unavailable.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "username", "name", "title", "url", "description", "avatar_url", "image_url", "header_url", "subscription_price", "posts_count", "photos_count", "videos_count", "audios_count", "media_count", "likes_count", "subscribers_count", "is_verified", "is_performer", "website", "location", "joined_at", "fetched_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "fetched_at": { "type": "string" }, "header_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "description": "Creator biography; may contain HTML." }, "is_verified": { "type": [ "boolean", "null" ] }, "likes_count": { "type": [ "number", "null" ], "minimum": 0 }, "media_count": { "type": [ "number", "null" ], "minimum": 0 }, "posts_count": { "type": [ "number", "null" ], "minimum": 0 }, "audios_count": { "type": [ "number", "null" ], "minimum": 0 }, "is_performer": { "type": [ "boolean", "null" ] }, "photos_count": { "type": [ "number", "null" ], "minimum": 0 }, "videos_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscribers_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscription_price": { "type": [ "number", "null" ], "minimum": 0 } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "onlyfans-profile" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "username", "name", "title", "url", "description", "avatar_url", "image_url", "header_url", "subscription_price", "posts_count", "photos_count", "videos_count", "audios_count", "media_count", "likes_count", "subscribers_count", "is_verified", "is_performer", "website", "location", "joined_at", "fetched_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "fetched_at": { "type": "string" }, "header_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "description": "Creator biography; may contain HTML." }, "is_verified": { "type": [ "boolean", "null" ] }, "likes_count": { "type": [ "number", "null" ], "minimum": 0 }, "media_count": { "type": [ "number", "null" ], "minimum": 0 }, "posts_count": { "type": [ "number", "null" ], "minimum": 0 }, "audios_count": { "type": [ "number", "null" ], "minimum": 0 }, "is_performer": { "type": [ "boolean", "null" ] }, "photos_count": { "type": [ "number", "null" ], "minimum": 0 }, "videos_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscribers_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscription_price": { "type": [ "number", "null" ], "minimum": 0 } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "onlyfans-profile", "task_name": "OnlyFans API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "title": "Stylish Shoreditch Loft with Balcony", "website": "sample", "location": "London", "username": "Stylish Shoreditch Loft with Balcony", "image_url": "https://example.com/item-1", "joined_at": "sample", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "fetched_at": "sample", "header_url": "https://example.com/item-1", "description": "Sample description 1", "is_verified": true, "likes_count": 1, "media_count": 1, "posts_count": 1, "audios_count": 1, "is_performer": true, "photos_count": 1, "videos_count": 1, "subscribers_count": 1, "subscription_price": 180 }, "count": 1, "query": "London", "source": "onlyfans-profile", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "title": "Stylish Shoreditch Loft with Balcony", "website": "sample", "location": "London", "username": "Stylish Shoreditch Loft with Balcony", "image_url": "https://example.com/item-1", "joined_at": "sample", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "fetched_at": "sample", "header_url": "https://example.com/item-1", "description": "Sample description 1", "is_verified": true, "likes_count": 1, "media_count": 1, "posts_count": 1, "audios_count": 1, "is_performer": true, "photos_count": 1, "videos_count": 1, "subscribers_count": 1, "subscription_price": 180 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "id", "username", "name", "title", "url", "description", "avatar_url", "image_url", "header_url", "subscription_price", "posts_count", "photos_count", "videos_count", "audios_count", "media_count", "likes_count", "subscribers_count", "is_verified", "is_performer", "website", "location", "joined_at", "fetched_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "fetched_at": { "type": "string" }, "header_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "description": "Creator biography; may contain HTML." }, "is_verified": { "type": [ "boolean", "null" ] }, "likes_count": { "type": [ "number", "null" ], "minimum": 0 }, "media_count": { "type": [ "number", "null" ], "minimum": 0 }, "posts_count": { "type": [ "number", "null" ], "minimum": 0 }, "audios_count": { "type": [ "number", "null" ], "minimum": 0 }, "is_performer": { "type": [ "boolean", "null" ] }, "photos_count": { "type": [ "number", "null" ], "minimum": 0 }, "videos_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscribers_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscription_price": { "type": [ "number", "null" ], "minimum": 0 } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "onlyfans-profile" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "username", "name", "title", "url", "description", "avatar_url", "image_url", "header_url", "subscription_price", "posts_count", "photos_count", "videos_count", "audios_count", "media_count", "likes_count", "subscribers_count", "is_verified", "is_performer", "website", "location", "joined_at", "fetched_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "fetched_at": { "type": "string" }, "header_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "description": "Creator biography; may contain HTML." }, "is_verified": { "type": [ "boolean", "null" ] }, "likes_count": { "type": [ "number", "null" ], "minimum": 0 }, "media_count": { "type": [ "number", "null" ], "minimum": 0 }, "posts_count": { "type": [ "number", "null" ], "minimum": 0 }, "audios_count": { "type": [ "number", "null" ], "minimum": 0 }, "is_performer": { "type": [ "boolean", "null" ] }, "photos_count": { "type": [ "number", "null" ], "minimum": 0 }, "videos_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscribers_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscription_price": { "type": [ "number", "null" ], "minimum": 0 } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "onlyfans-profile", "task_name": "OnlyFans API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOnlyfansProfileAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "maximum": 100, "minimum": 1, "x-advanced": true, "description": "Accepted for compatibility; a profile lookup returns one profile. It does not paginate posts." }, "username": { "type": "string", "x-sample": "onlyfans", "maxLength": 128, "minLength": 1, "description": "OnlyFans username, @handle, or profile URL." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "onlyfans" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-onlyfans-profile" }, "x-browsable-website-login-required": false } }, "/v1/tasks/onlyfans-profiles/runs": { "post": { "tags": [ "OnlyFans" ], "summary": "OnlyFans Profiles API", "description": "Fetch public details for up to 10 OnlyFans profiles without connecting an account. Duplicate usernames are fetched once. Partial batches include per-profile errors; all-failed batches fail the run. Costs 10 credits per batch.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "requested", "succeeded", "failed", "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "username", "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false } }, "failed": { "type": "integer" }, "requested": { "type": "integer" }, "succeeded": { "type": "integer" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "onlyfans-profiles" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "username", "name", "title", "url", "description", "avatar_url", "image_url", "header_url", "subscription_price", "posts_count", "photos_count", "videos_count", "audios_count", "media_count", "likes_count", "subscribers_count", "is_verified", "is_performer", "website", "location", "joined_at", "fetched_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "fetched_at": { "type": "string" }, "header_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "description": "Creator biography; may contain HTML." }, "is_verified": { "type": [ "boolean", "null" ] }, "likes_count": { "type": [ "number", "null" ], "minimum": 0 }, "media_count": { "type": [ "number", "null" ], "minimum": 0 }, "posts_count": { "type": [ "number", "null" ], "minimum": 0 }, "audios_count": { "type": [ "number", "null" ], "minimum": 0 }, "is_performer": { "type": [ "boolean", "null" ] }, "photos_count": { "type": [ "number", "null" ], "minimum": 0 }, "videos_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscribers_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscription_price": { "type": [ "number", "null" ], "minimum": 0 } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "onlyfans-profiles", "task_name": "OnlyFans Profiles API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "errors": [ { "code": "sample", "message": "sample", "username": "Stylish Shoreditch Loft with Balcony" } ], "failed": 1, "requested": 1, "succeeded": 1 }, "count": 1, "query": "London", "source": "onlyfans-profiles", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "title": "Stylish Shoreditch Loft with Balcony", "website": "sample", "location": "London", "username": "Stylish Shoreditch Loft with Balcony", "image_url": "https://example.com/item-1", "joined_at": "sample", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "fetched_at": "sample", "header_url": "https://example.com/item-1", "description": "Sample description 1", "is_verified": true, "likes_count": 1, "media_count": 1, "posts_count": 1, "audios_count": 1, "is_performer": true, "photos_count": 1, "videos_count": 1, "subscribers_count": 1, "subscription_price": 180 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "requested", "succeeded", "failed", "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "username", "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false } }, "failed": { "type": "integer" }, "requested": { "type": "integer" }, "succeeded": { "type": "integer" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "onlyfans-profiles" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "username", "name", "title", "url", "description", "avatar_url", "image_url", "header_url", "subscription_price", "posts_count", "photos_count", "videos_count", "audios_count", "media_count", "likes_count", "subscribers_count", "is_verified", "is_performer", "website", "location", "joined_at", "fetched_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "fetched_at": { "type": "string" }, "header_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "description": "Creator biography; may contain HTML." }, "is_verified": { "type": [ "boolean", "null" ] }, "likes_count": { "type": [ "number", "null" ], "minimum": 0 }, "media_count": { "type": [ "number", "null" ], "minimum": 0 }, "posts_count": { "type": [ "number", "null" ], "minimum": 0 }, "audios_count": { "type": [ "number", "null" ], "minimum": 0 }, "is_performer": { "type": [ "boolean", "null" ] }, "photos_count": { "type": [ "number", "null" ], "minimum": 0 }, "videos_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscribers_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscription_price": { "type": [ "number", "null" ], "minimum": 0 } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "onlyfans-profiles", "task_name": "OnlyFans Profiles API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOnlyfansProfilesCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "usernames": { "type": "array", "items": { "type": "string", "x-sample": "onlyfans", "maxLength": 128, "minLength": 1, "description": "OnlyFans username, @handle, or profile URL." }, "maxItems": 10, "minItems": 1, "x-sample": [ "onlyfans", "oftv" ], "description": "Public usernames to retrieve. Errors or unavailable profiles are reported individually." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "usernames" ] }, "example": { "usernames": [ "onlyfans", "oftv" ] } } } }, "x-browsable-website-login-required": false } }, "/v1/onlyfans/profiles": { "post": { "tags": [ "OnlyFans" ], "summary": "OnlyFans Profiles API", "description": "Fetch public details for up to 10 OnlyFans profiles without connecting an account. Duplicate usernames are fetched once. Partial batches include per-profile errors; all-failed batches fail the run. Costs 10 credits per batch.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "requested", "succeeded", "failed", "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "username", "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false } }, "failed": { "type": "integer" }, "requested": { "type": "integer" }, "succeeded": { "type": "integer" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "onlyfans-profiles" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "username", "name", "title", "url", "description", "avatar_url", "image_url", "header_url", "subscription_price", "posts_count", "photos_count", "videos_count", "audios_count", "media_count", "likes_count", "subscribers_count", "is_verified", "is_performer", "website", "location", "joined_at", "fetched_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "fetched_at": { "type": "string" }, "header_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "description": "Creator biography; may contain HTML." }, "is_verified": { "type": [ "boolean", "null" ] }, "likes_count": { "type": [ "number", "null" ], "minimum": 0 }, "media_count": { "type": [ "number", "null" ], "minimum": 0 }, "posts_count": { "type": [ "number", "null" ], "minimum": 0 }, "audios_count": { "type": [ "number", "null" ], "minimum": 0 }, "is_performer": { "type": [ "boolean", "null" ] }, "photos_count": { "type": [ "number", "null" ], "minimum": 0 }, "videos_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscribers_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscription_price": { "type": [ "number", "null" ], "minimum": 0 } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "onlyfans-profiles", "task_name": "OnlyFans Profiles API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "errors": [ { "code": "sample", "message": "sample", "username": "Stylish Shoreditch Loft with Balcony" } ], "failed": 1, "requested": 1, "succeeded": 1 }, "count": 1, "query": "London", "source": "onlyfans-profiles", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "title": "Stylish Shoreditch Loft with Balcony", "website": "sample", "location": "London", "username": "Stylish Shoreditch Loft with Balcony", "image_url": "https://example.com/item-1", "joined_at": "sample", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "fetched_at": "sample", "header_url": "https://example.com/item-1", "description": "Sample description 1", "is_verified": true, "likes_count": 1, "media_count": 1, "posts_count": 1, "audios_count": 1, "is_performer": true, "photos_count": 1, "videos_count": 1, "subscribers_count": 1, "subscription_price": 180 } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "requested", "succeeded", "failed", "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "username", "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "username": { "type": "string" } }, "additionalProperties": false } }, "failed": { "type": "integer" }, "requested": { "type": "integer" }, "succeeded": { "type": "integer" } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "onlyfans-profiles" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "username", "name", "title", "url", "description", "avatar_url", "image_url", "header_url", "subscription_price", "posts_count", "photos_count", "videos_count", "audios_count", "media_count", "likes_count", "subscribers_count", "is_verified", "is_performer", "website", "location", "joined_at", "fetched_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "location": { "type": [ "string", "null" ] }, "username": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "joined_at": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "fetched_at": { "type": "string" }, "header_url": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ], "description": "Creator biography; may contain HTML." }, "is_verified": { "type": [ "boolean", "null" ] }, "likes_count": { "type": [ "number", "null" ], "minimum": 0 }, "media_count": { "type": [ "number", "null" ], "minimum": 0 }, "posts_count": { "type": [ "number", "null" ], "minimum": 0 }, "audios_count": { "type": [ "number", "null" ], "minimum": 0 }, "is_performer": { "type": [ "boolean", "null" ] }, "photos_count": { "type": [ "number", "null" ], "minimum": 0 }, "videos_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscribers_count": { "type": [ "number", "null" ], "minimum": 0 }, "subscription_price": { "type": [ "number", "null" ], "minimum": 0 } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "onlyfans-profiles", "task_name": "OnlyFans Profiles API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOnlyfansProfilesAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "usernames": { "type": "array", "items": { "type": "string", "x-sample": "onlyfans", "maxLength": 128, "minLength": 1, "description": "OnlyFans username, @handle, or profile URL." }, "maxItems": 10, "minItems": 1, "x-sample": [ "onlyfans", "oftv" ], "description": "Public usernames to retrieve. Errors or unavailable profiles are reported individually." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "usernames" ] }, "example": { "usernames": [ "onlyfans", "oftv" ] } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-onlyfans-profiles" }, "x-browsable-website-login-required": false } }, "/v1/tasks/onlyfans-search/runs": { "post": { "tags": [ "OnlyFans" ], "summary": "OnlyFans Creator Search API", "description": "Discover OnlyFans creator profile links and snippets from Google's search index. No OnlyFans login needed. Coverage is not exhaustive and snippets may be outdated; use the profile endpoint for current data. A page can contain fewer results or be empty after non-profile links are excluded; continue while next_cursor is present.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "discovery_source", "exhaustive", "profiles_fetched", "fetched_at" ], "properties": { "exhaustive": { "const": false }, "fetched_at": { "type": "string" }, "discovery_source": { "const": "google_via_serper" }, "profiles_fetched": { "const": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "onlyfans-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "username", "url", "title", "description" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "username": { "type": "string" }, "description": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "onlyfans-search", "task_name": "OnlyFans Creator Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "exhaustive": false, "fetched_at": "sample", "discovery_source": "google_via_serper", "profiles_fetched": false }, "count": 1, "query": "London", "source": "onlyfans-search", "results": [ { "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "username": "Stylish Shoreditch Loft with Balcony", "description": "Sample description 1" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "discovery_source", "exhaustive", "profiles_fetched", "fetched_at" ], "properties": { "exhaustive": { "const": false }, "fetched_at": { "type": "string" }, "discovery_source": { "const": "google_via_serper" }, "profiles_fetched": { "const": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "onlyfans-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "username", "url", "title", "description" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "username": { "type": "string" }, "description": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "onlyfans-search", "task_name": "OnlyFans Creator Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOnlyfansSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 10, "maximum": 10, "minimum": 1, "description": "Maximum creator profiles to return from this search page." }, "query": { "type": "string", "x-sample": "boxing", "maxLength": 200, "minLength": 1, "description": "Creator name, username or topic to search for." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from the previous response. Keep the same query. Search rankings can change between requests." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "boxing" } } } }, "x-browsable-website-login-required": false } }, "/v1/onlyfans/search": { "post": { "tags": [ "OnlyFans" ], "summary": "OnlyFans Creator Search API", "description": "Discover OnlyFans creator profile links and snippets from Google's search index. No OnlyFans login needed. Coverage is not exhaustive and snippets may be outdated; use the profile endpoint for current data. A page can contain fewer results or be empty after non-profile links are excluded; continue while next_cursor is present.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "discovery_source", "exhaustive", "profiles_fetched", "fetched_at" ], "properties": { "exhaustive": { "const": false }, "fetched_at": { "type": "string" }, "discovery_source": { "const": "google_via_serper" }, "profiles_fetched": { "const": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "onlyfans-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "username", "url", "title", "description" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "username": { "type": "string" }, "description": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "onlyfans-search", "task_name": "OnlyFans Creator Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": { "exhaustive": false, "fetched_at": "sample", "discovery_source": "google_via_serper", "profiles_fetched": false }, "count": 1, "query": "London", "source": "onlyfans-search", "results": [ { "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "username": "Stylish Shoreditch Loft with Balcony", "description": "Sample description 1" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "type": [ "string", "null" ] }, "data": { "type": "object", "required": [ "discovery_source", "exhaustive", "profiles_fetched", "fetched_at" ], "properties": { "exhaustive": { "const": false }, "fetched_at": { "type": "string" }, "discovery_source": { "const": "google_via_serper" }, "profiles_fetched": { "const": false } }, "additionalProperties": false }, "count": { "type": "integer", "minimum": 0 }, "query": { "type": [ "string", "null" ] }, "source": { "const": "onlyfans-search" }, "results": { "type": "array", "items": { "type": "object", "required": [ "username", "url", "title", "description" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "username": { "type": "string" }, "description": { "type": [ "string", "null" ] } }, "additionalProperties": false } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer", "minimum": 0 }, "cursor": { "type": [ "string", "null" ] }, "strategy": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer", "minimum": 1 } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "onlyfans-search", "task_name": "OnlyFans Creator Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runOnlyfansSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 10, "maximum": 10, "minimum": 1, "description": "Maximum creator profiles to return from this search page." }, "query": { "type": "string", "x-sample": "boxing", "maxLength": 200, "minLength": 1, "description": "Creator name, username or topic to search for." }, "cursor": { "type": "string", "maxLength": 131072, "description": "next_cursor from the previous response. Keep the same query. Search rankings can change between requests." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "boxing" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-onlyfans-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/patreon-campaign/runs": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Campaign API", "description": "Fetch public Patreon creator details, visible counts, membership tiers and goals. Hidden earnings remain null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-campaign", "task_name": "Patreon Campaign API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-campaign", "task_name": "Patreon Campaign API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonCampaignCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "username": { "type": "string", "x-sample": "waitbutwhy", "maxLength": 2000, "minLength": 1, "description": "Patreon creator username.", "x-placeholder": "e.g. waitbutwhy" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "waitbutwhy" } } } }, "x-browsable-website-login-required": false } }, "/v1/patreon/campaign": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Campaign API", "description": "Fetch public Patreon creator details, visible counts, membership tiers and goals. Hidden earnings remain null.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-campaign", "task_name": "Patreon Campaign API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-campaign", "task_name": "Patreon Campaign API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonCampaignAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "username": { "type": "string", "x-sample": "waitbutwhy", "maxLength": 2000, "minLength": 1, "description": "Patreon creator username.", "x-placeholder": "e.g. waitbutwhy" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "waitbutwhy" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-patreon-campaign" }, "x-browsable-website-login-required": false } }, "/v1/tasks/patreon-creator/runs": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Creator API", "description": "Scrape public Patreon creator metadata.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-creator", "task_name": "Patreon Creator API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-creator", "task_name": "Patreon Creator API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonCreatorCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "username": { "type": "string", "x-sample": "waitbutwhy", "maxLength": 2000, "minLength": 1, "description": "Patreon creator username.", "x-placeholder": "e.g. waitbutwhy" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "waitbutwhy" } } } }, "x-browsable-website-login-required": false } }, "/v1/patreon/creator": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Creator API", "description": "Scrape public Patreon creator metadata.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-creator", "task_name": "Patreon Creator API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-creator", "task_name": "Patreon Creator API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonCreatorAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "username": { "type": "string", "x-sample": "waitbutwhy", "maxLength": 2000, "minLength": 1, "description": "Patreon creator username.", "x-placeholder": "e.g. waitbutwhy" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "waitbutwhy" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-patreon-creator" }, "x-browsable-website-login-required": false } }, "/v1/tasks/patreon-creator-download/runs": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Creator Download", "description": "Export a Patreon creator's posts and accessible media as a ZIP file. Managed Patreon auth is optional and recommended for paid content your account can view.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "The result begins with an export ID. A completed run returns artifact details, download expiry and collection statistics. partial_success means some media could not be downloaded; inspect failed_media.", "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "export_id": { "type": "string", "description": "Export identifier. Poll the run until it succeeds before downloading." }, "status": { "type": "string", "enum": [ "completed", "partial_success", "pending" ] }, "file_name": { "type": "string" }, "download_url": { "type": "string", "description": "Short-lived signed download URL. It can be a pending:// placeholder before the artifact is ready." }, "download_url_expires_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "max_posts": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" }, "creator": { "type": "object", "properties": { "username": { "type": "string" }, "campaign_id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "creation_name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "patron_count": { "type": [ "number", "null" ] }, "post_count": { "type": [ "number", "null" ] }, "is_nsfw": { "type": [ "boolean", "null" ] }, "authenticated": { "type": "boolean" } }, "required": [ "username", "campaign_id", "name", "creation_name", "url", "avatar_url", "patron_count", "post_count", "is_nsfw", "authenticated" ], "additionalProperties": false }, "result_summary": { "type": "object", "properties": { "postsDiscovered": { "type": "number" }, "mediaDiscovered": { "type": "number" }, "estimatedBytes": { "type": "number" }, "downloadedFiles": { "type": "number" }, "failedFiles": { "type": "number" }, "skippedFiles": { "type": "number" }, "truncated": { "type": "boolean" }, "postsWithMedia": { "type": "number" }, "lockedPosts": { "type": "number" } }, "required": [ "postsDiscovered", "mediaDiscovered", "estimatedBytes", "downloadedFiles", "failedFiles", "skippedFiles", "truncated", "postsWithMedia", "lockedPosts" ], "additionalProperties": false }, "failed_media": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": [ "string", "null" ] }, "post_title": { "type": [ "string", "null" ] }, "post_url": { "type": [ "string", "null" ] }, "post_index": { "type": [ "number", "null" ] }, "media_index": { "type": [ "number", "null" ] }, "media_id": { "type": [ "string", "null" ] }, "file_name": { "type": [ "string", "null" ] }, "failure_reason": { "type": "string" } }, "required": [ "post_id", "post_title", "post_url", "post_index", "media_index", "media_id", "file_name", "failure_reason" ], "additionalProperties": false } } }, "required": [ "success", "export_id", "status", "file_name", "download_url", "download_url_expires_at", "expires_at", "error_code", "error_message", "max_posts", "truncated", "creator", "result_summary", "failed_media" ], "additionalProperties": false }, { "type": "object", "properties": { "export_id": { "type": "string" } }, "required": [ "export_id" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-creator-download", "task_name": "Patreon Creator Download", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "success": true, "export_id": "id-1", "status": "completed", "file_name": "Stylish Shoreditch Loft with Balcony", "download_url": "https://example.com/item-1", "download_url_expires_at": "https://example.com/item-1", "expires_at": "sample", "error_code": "sample", "error_message": "sample", "max_posts": 1.5, "truncated": true, "creator": { "username": "Stylish Shoreditch Loft with Balcony", "campaign_id": "id-1", "name": "Stylish Shoreditch Loft with Balcony", "creation_name": "Stylish Shoreditch Loft with Balcony", "url": "https://example.com/item-1", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "patron_count": 1, "post_count": 1, "is_nsfw": true, "authenticated": true }, "result_summary": { "postsDiscovered": 1.5, "mediaDiscovered": 1.5, "estimatedBytes": 1.5, "downloadedFiles": 1.5, "failedFiles": 1.5, "skippedFiles": 1.5, "truncated": true, "postsWithMedia": 1.5, "lockedPosts": 1.5 }, "failed_media": [ { "post_id": "id-1", "post_title": "Stylish Shoreditch Loft with Balcony", "post_url": "https://example.com/item-1", "post_index": 1.5, "media_index": 1.5, "media_id": "id-1", "file_name": "Stylish Shoreditch Loft with Balcony", "failure_reason": "sample" } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "The result begins with an export ID. A completed run returns artifact details, download expiry and collection statistics. partial_success means some media could not be downloaded; inspect failed_media.", "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "export_id": { "type": "string", "description": "Export identifier. Poll the run until it succeeds before downloading." }, "status": { "type": "string", "enum": [ "completed", "partial_success", "pending" ] }, "file_name": { "type": "string" }, "download_url": { "type": "string", "description": "Short-lived signed download URL. It can be a pending:// placeholder before the artifact is ready." }, "download_url_expires_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "max_posts": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" }, "creator": { "type": "object", "properties": { "username": { "type": "string" }, "campaign_id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "creation_name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "patron_count": { "type": [ "number", "null" ] }, "post_count": { "type": [ "number", "null" ] }, "is_nsfw": { "type": [ "boolean", "null" ] }, "authenticated": { "type": "boolean" } }, "required": [ "username", "campaign_id", "name", "creation_name", "url", "avatar_url", "patron_count", "post_count", "is_nsfw", "authenticated" ], "additionalProperties": false }, "result_summary": { "type": "object", "properties": { "postsDiscovered": { "type": "number" }, "mediaDiscovered": { "type": "number" }, "estimatedBytes": { "type": "number" }, "downloadedFiles": { "type": "number" }, "failedFiles": { "type": "number" }, "skippedFiles": { "type": "number" }, "truncated": { "type": "boolean" }, "postsWithMedia": { "type": "number" }, "lockedPosts": { "type": "number" } }, "required": [ "postsDiscovered", "mediaDiscovered", "estimatedBytes", "downloadedFiles", "failedFiles", "skippedFiles", "truncated", "postsWithMedia", "lockedPosts" ], "additionalProperties": false }, "failed_media": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": [ "string", "null" ] }, "post_title": { "type": [ "string", "null" ] }, "post_url": { "type": [ "string", "null" ] }, "post_index": { "type": [ "number", "null" ] }, "media_index": { "type": [ "number", "null" ] }, "media_id": { "type": [ "string", "null" ] }, "file_name": { "type": [ "string", "null" ] }, "failure_reason": { "type": "string" } }, "required": [ "post_id", "post_title", "post_url", "post_index", "media_index", "media_id", "file_name", "failure_reason" ], "additionalProperties": false } } }, "required": [ "success", "export_id", "status", "file_name", "download_url", "download_url_expires_at", "expires_at", "error_code", "error_message", "max_posts", "truncated", "creator", "result_summary", "failed_media" ], "additionalProperties": false }, { "type": "object", "properties": { "export_id": { "type": "string" } }, "required": [ "export_id" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-creator-download", "task_name": "Patreon Creator Download", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonCreatorDownloadCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "maximum": 100000, "minimum": 1, "x-sample": "1000", "description": "Optional maximum number of posts to include. Omit this field to attempt the full creator export. Preferred name; maxPosts remains supported.", "x-placeholder": "e.g. 1000" }, "creator": { "type": "string", "x-sample": "technologyconnections", "maxLength": 2000, "minLength": 1, "description": "Patreon creator username, vanity path, or creator URL to export as a ZIP file.", "x-placeholder": "e.g. technologyconnections" }, "maxPosts": { "type": "integer", "maximum": 100000, "minimum": 1, "x-sample": "1000", "x-advanced": true, "description": "Optional maximum number of posts to include. Omit this field to attempt the full creator export. You can also use limit.", "x-placeholder": "e.g. 1000" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "creator" ] }, "example": { "creator": "technologyconnections" } } } }, "x-browsable-website-login-required": false } }, "/v1/patreon/creator-download": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Creator Download", "description": "Export a Patreon creator's posts and accessible media as a ZIP file. Managed Patreon auth is optional and recommended for paid content your account can view.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "The result begins with an export ID. A completed run returns artifact details, download expiry and collection statistics. partial_success means some media could not be downloaded; inspect failed_media.", "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "export_id": { "type": "string", "description": "Export identifier. Poll the run until it succeeds before downloading." }, "status": { "type": "string", "enum": [ "completed", "partial_success", "pending" ] }, "file_name": { "type": "string" }, "download_url": { "type": "string", "description": "Short-lived signed download URL. It can be a pending:// placeholder before the artifact is ready." }, "download_url_expires_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "max_posts": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" }, "creator": { "type": "object", "properties": { "username": { "type": "string" }, "campaign_id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "creation_name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "patron_count": { "type": [ "number", "null" ] }, "post_count": { "type": [ "number", "null" ] }, "is_nsfw": { "type": [ "boolean", "null" ] }, "authenticated": { "type": "boolean" } }, "required": [ "username", "campaign_id", "name", "creation_name", "url", "avatar_url", "patron_count", "post_count", "is_nsfw", "authenticated" ], "additionalProperties": false }, "result_summary": { "type": "object", "properties": { "postsDiscovered": { "type": "number" }, "mediaDiscovered": { "type": "number" }, "estimatedBytes": { "type": "number" }, "downloadedFiles": { "type": "number" }, "failedFiles": { "type": "number" }, "skippedFiles": { "type": "number" }, "truncated": { "type": "boolean" }, "postsWithMedia": { "type": "number" }, "lockedPosts": { "type": "number" } }, "required": [ "postsDiscovered", "mediaDiscovered", "estimatedBytes", "downloadedFiles", "failedFiles", "skippedFiles", "truncated", "postsWithMedia", "lockedPosts" ], "additionalProperties": false }, "failed_media": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": [ "string", "null" ] }, "post_title": { "type": [ "string", "null" ] }, "post_url": { "type": [ "string", "null" ] }, "post_index": { "type": [ "number", "null" ] }, "media_index": { "type": [ "number", "null" ] }, "media_id": { "type": [ "string", "null" ] }, "file_name": { "type": [ "string", "null" ] }, "failure_reason": { "type": "string" } }, "required": [ "post_id", "post_title", "post_url", "post_index", "media_index", "media_id", "file_name", "failure_reason" ], "additionalProperties": false } } }, "required": [ "success", "export_id", "status", "file_name", "download_url", "download_url_expires_at", "expires_at", "error_code", "error_message", "max_posts", "truncated", "creator", "result_summary", "failed_media" ], "additionalProperties": false }, { "type": "object", "properties": { "export_id": { "type": "string" } }, "required": [ "export_id" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-creator-download", "task_name": "Patreon Creator Download", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "success": true, "export_id": "id-1", "status": "completed", "file_name": "Stylish Shoreditch Loft with Balcony", "download_url": "https://example.com/item-1", "download_url_expires_at": "https://example.com/item-1", "expires_at": "sample", "error_code": "sample", "error_message": "sample", "max_posts": 1.5, "truncated": true, "creator": { "username": "Stylish Shoreditch Loft with Balcony", "campaign_id": "id-1", "name": "Stylish Shoreditch Loft with Balcony", "creation_name": "Stylish Shoreditch Loft with Balcony", "url": "https://example.com/item-1", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "patron_count": 1, "post_count": 1, "is_nsfw": true, "authenticated": true }, "result_summary": { "postsDiscovered": 1.5, "mediaDiscovered": 1.5, "estimatedBytes": 1.5, "downloadedFiles": 1.5, "failedFiles": 1.5, "skippedFiles": 1.5, "truncated": true, "postsWithMedia": 1.5, "lockedPosts": 1.5 }, "failed_media": [ { "post_id": "id-1", "post_title": "Stylish Shoreditch Loft with Balcony", "post_url": "https://example.com/item-1", "post_index": 1.5, "media_index": 1.5, "media_id": "id-1", "file_name": "Stylish Shoreditch Loft with Balcony", "failure_reason": "sample" } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "The result begins with an export ID. A completed run returns artifact details, download expiry and collection statistics. partial_success means some media could not be downloaded; inspect failed_media.", "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "export_id": { "type": "string", "description": "Export identifier. Poll the run until it succeeds before downloading." }, "status": { "type": "string", "enum": [ "completed", "partial_success", "pending" ] }, "file_name": { "type": "string" }, "download_url": { "type": "string", "description": "Short-lived signed download URL. It can be a pending:// placeholder before the artifact is ready." }, "download_url_expires_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "error_code": { "type": [ "string", "null" ] }, "error_message": { "type": [ "string", "null" ] }, "max_posts": { "type": [ "number", "null" ] }, "truncated": { "type": "boolean" }, "creator": { "type": "object", "properties": { "username": { "type": "string" }, "campaign_id": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "creation_name": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "avatar_url": { "type": [ "string", "null" ] }, "patron_count": { "type": [ "number", "null" ] }, "post_count": { "type": [ "number", "null" ] }, "is_nsfw": { "type": [ "boolean", "null" ] }, "authenticated": { "type": "boolean" } }, "required": [ "username", "campaign_id", "name", "creation_name", "url", "avatar_url", "patron_count", "post_count", "is_nsfw", "authenticated" ], "additionalProperties": false }, "result_summary": { "type": "object", "properties": { "postsDiscovered": { "type": "number" }, "mediaDiscovered": { "type": "number" }, "estimatedBytes": { "type": "number" }, "downloadedFiles": { "type": "number" }, "failedFiles": { "type": "number" }, "skippedFiles": { "type": "number" }, "truncated": { "type": "boolean" }, "postsWithMedia": { "type": "number" }, "lockedPosts": { "type": "number" } }, "required": [ "postsDiscovered", "mediaDiscovered", "estimatedBytes", "downloadedFiles", "failedFiles", "skippedFiles", "truncated", "postsWithMedia", "lockedPosts" ], "additionalProperties": false }, "failed_media": { "type": "array", "items": { "type": "object", "properties": { "post_id": { "type": [ "string", "null" ] }, "post_title": { "type": [ "string", "null" ] }, "post_url": { "type": [ "string", "null" ] }, "post_index": { "type": [ "number", "null" ] }, "media_index": { "type": [ "number", "null" ] }, "media_id": { "type": [ "string", "null" ] }, "file_name": { "type": [ "string", "null" ] }, "failure_reason": { "type": "string" } }, "required": [ "post_id", "post_title", "post_url", "post_index", "media_index", "media_id", "file_name", "failure_reason" ], "additionalProperties": false } } }, "required": [ "success", "export_id", "status", "file_name", "download_url", "download_url_expires_at", "expires_at", "error_code", "error_message", "max_posts", "truncated", "creator", "result_summary", "failed_media" ], "additionalProperties": false }, { "type": "object", "properties": { "export_id": { "type": "string" } }, "required": [ "export_id" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-creator-download", "task_name": "Patreon Creator Download", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonCreatorDownloadAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "maximum": 100000, "minimum": 1, "x-sample": "1000", "description": "Optional maximum number of posts to include. Omit this field to attempt the full creator export. Preferred name; maxPosts remains supported.", "x-placeholder": "e.g. 1000" }, "creator": { "type": "string", "x-sample": "technologyconnections", "maxLength": 2000, "minLength": 1, "description": "Patreon creator username, vanity path, or creator URL to export as a ZIP file.", "x-placeholder": "e.g. technologyconnections" }, "maxPosts": { "type": "integer", "maximum": 100000, "minimum": 1, "x-sample": "1000", "x-advanced": true, "description": "Optional maximum number of posts to include. Omit this field to attempt the full creator export. You can also use limit.", "x-placeholder": "e.g. 1000" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "creator" ] }, "example": { "creator": "technologyconnections" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-patreon-creator-download" }, "x-browsable-website-login-required": false } }, "/v1/tasks/patreon-creator-posts/runs": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Creator Posts API", "description": "Fetch public Patreon post metadata from a creator by username, URL, or campaign id.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-creator-posts", "task_name": "Patreon Creator Posts API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-creator-posts", "task_name": "Patreon Creator Posts API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonCreatorPostsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.patreon.com/technologyconnections", "maxLength": 2000, "minLength": 1, "description": "Optional Patreon creator URL.", "x-placeholder": "e.g. https://www.patreon.com/technologyconnections" }, "limit": { "type": "integer", "default": 10, "maximum": 50, "minimum": 1, "description": "Maximum number of results to return." }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "creator": { "type": "string", "x-sample": "technologyconnections", "maxLength": 2000, "minLength": 1, "description": "Patreon creator username or vanity path.", "x-placeholder": "e.g. technologyconnections" }, "campaign_id": { "type": "string", "x-advanced": true, "description": "Optional Patreon campaign id returned by patreon/search.", "x-placeholder": "e.g. 1205741" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "creator" ] }, { "required": [ "url" ] }, { "required": [ "campaign_id" ] } ] }, "example": { "url": "https://www.patreon.com/technologyconnections" } } } }, "x-browsable-website-login-required": false } }, "/v1/patreon/creator-posts": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Creator Posts API", "description": "Fetch public Patreon post metadata from a creator by username, URL, or campaign id.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-creator-posts", "task_name": "Patreon Creator Posts API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-creator-posts", "task_name": "Patreon Creator Posts API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonCreatorPostsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.patreon.com/technologyconnections", "maxLength": 2000, "minLength": 1, "description": "Optional Patreon creator URL.", "x-placeholder": "e.g. https://www.patreon.com/technologyconnections" }, "limit": { "type": "integer", "default": 10, "maximum": 50, "minimum": 1, "description": "Maximum number of results to return." }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "creator": { "type": "string", "x-sample": "technologyconnections", "maxLength": 2000, "minLength": 1, "description": "Patreon creator username or vanity path.", "x-placeholder": "e.g. technologyconnections" }, "campaign_id": { "type": "string", "x-advanced": true, "description": "Optional Patreon campaign id returned by patreon/search.", "x-placeholder": "e.g. 1205741" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "creator" ] }, { "required": [ "url" ] }, { "required": [ "campaign_id" ] } ] }, "example": { "url": "https://www.patreon.com/technologyconnections" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-patreon-creator-posts" }, "x-browsable-website-login-required": false } }, "/v1/tasks/patreon-post/runs": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Post API", "description": "Fetch public Patreon post details by post URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-post", "task_name": "Patreon Post API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-post", "task_name": "Patreon Post API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonPostCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.patreon.com/technologyconnections/posts/ceiling-fans-161200155", "maxLength": 2000, "minLength": 1, "description": "Patreon post URL returned by patreon/creator-posts.", "x-placeholder": "e.g. https://www.patreon.com/technologyconnections/posts/ceiling-fans-161200155" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.patreon.com/technologyconnections/posts/ceiling-fans-161200155" } } } }, "x-browsable-website-login-required": false } }, "/v1/patreon/post": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Post API", "description": "Fetch public Patreon post details by post URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-post", "task_name": "Patreon Post API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-post", "task_name": "Patreon Post API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonPostAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.patreon.com/technologyconnections/posts/ceiling-fans-161200155", "maxLength": 2000, "minLength": 1, "description": "Patreon post URL returned by patreon/creator-posts.", "x-placeholder": "e.g. https://www.patreon.com/technologyconnections/posts/ceiling-fans-161200155" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.patreon.com/technologyconnections/posts/ceiling-fans-161200155" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-patreon-post" }, "x-browsable-website-login-required": false } }, "/v1/tasks/patreon-post-media/runs": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Post Media API", "description": "Extract public media and attachment metadata from a Patreon post by post URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-post-media", "task_name": "Patreon Post Media API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-post-media", "task_name": "Patreon Post Media API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonPostMediaCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.patreon.com/technologyconnections/posts/ceiling-fans-161200155", "maxLength": 2000, "minLength": 1, "description": "Patreon post URL returned by patreon/creator-posts.", "x-placeholder": "e.g. https://www.patreon.com/technologyconnections/posts/ceiling-fans-161200155" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.patreon.com/technologyconnections/posts/ceiling-fans-161200155" } } } }, "x-browsable-website-login-required": false } }, "/v1/patreon/post-media": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Post Media API", "description": "Extract public media and attachment metadata from a Patreon post by post URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-post-media", "task_name": "Patreon Post Media API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-post-media", "task_name": "Patreon Post Media API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonPostMediaAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.patreon.com/technologyconnections/posts/ceiling-fans-161200155", "maxLength": 2000, "minLength": 1, "description": "Patreon post URL returned by patreon/creator-posts.", "x-placeholder": "e.g. https://www.patreon.com/technologyconnections/posts/ceiling-fans-161200155" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.patreon.com/technologyconnections/posts/ceiling-fans-161200155" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-patreon-post-media" }, "x-browsable-website-login-required": false } }, "/v1/tasks/patreon-search/runs": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Search API", "description": "Search public Patreon creators by query with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-search", "task_name": "Patreon Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-search", "task_name": "Patreon Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "technology", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. technology" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "technology" } } } }, "x-browsable-website-login-required": false } }, "/v1/patreon/search": { "post": { "tags": [ "Patreon" ], "summary": "Patreon Search API", "description": "Search public Patreon creators by query with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-search", "task_name": "Patreon Search API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "patreon-search", "task_name": "Patreon Search API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPatreonSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "technology", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. technology" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "technology" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-patreon-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/pinterest-board/runs": { "post": { "tags": [ "Pinterest" ], "summary": "Pinterest Board API", "description": "Scrape pins from an accessible Pinterest board using your connected Pinterest account.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "board", "count", "pins", "limit", "pagination" ], "properties": { "pins": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "description", "alt_text", "image_url", "image_urls", "link_url", "is_video", "pinner_username", "pinner_name" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_video": { "type": "boolean" }, "link_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pinner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pinner_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "board": { "type": "object", "required": [ "url", "name", "owner", "privacy" ], "properties": { "url": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "privacy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "count": { "type": "integer" }, "limit": { "type": "integer" }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "pinterest-board", "task_name": "Pinterest Board API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "pins": [ { "id": "id-1", "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "alt_text": "Sample alt_text 1", "is_video": true, "link_url": "https://example.com/item-1", "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "pinner_name": "Stylish Shoreditch Loft with Balcony", "pinner_username": "Stylish Shoreditch Loft with Balcony" } ], "board": { "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "owner": "sample", "privacy": "sample" }, "count": 1, "limit": 1, "success": true, "pagination": { "next_cursor": "cursor-page-1", "has_next_page": true } }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "board", "count", "pins", "limit", "pagination" ], "properties": { "pins": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "description", "alt_text", "image_url", "image_urls", "link_url", "is_video", "pinner_username", "pinner_name" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_video": { "type": "boolean" }, "link_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pinner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pinner_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "board": { "type": "object", "required": [ "url", "name", "owner", "privacy" ], "properties": { "url": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "privacy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "count": { "type": "integer" }, "limit": { "type": "integer" }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "pinterest-board", "task_name": "Pinterest Board API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPinterestBoardCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 100, "maximum": 250, "minimum": 1, "description": "Maximum number of pins to return in this page." }, "cursor": { "type": "string", "description": "Offset cursor returned by the previous page. Omit it to start from the first pin." }, "board_url": { "type": "string", "examples": [ "https://www.pinterest.com/username/board-name/" ], "description": "URL of the Pinterest board to scrape. The board must be accessible to the connected Pinterest account." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "board_url" ] }, "example": { "board_url": "https://example.com/item-1" } } } }, "x-browsable-website-login-required": true } }, "/v1/pinterest/board": { "post": { "tags": [ "Pinterest" ], "summary": "Pinterest Board API", "description": "Scrape pins from an accessible Pinterest board using your connected Pinterest account.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "board", "count", "pins", "limit", "pagination" ], "properties": { "pins": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "description", "alt_text", "image_url", "image_urls", "link_url", "is_video", "pinner_username", "pinner_name" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_video": { "type": "boolean" }, "link_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pinner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pinner_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "board": { "type": "object", "required": [ "url", "name", "owner", "privacy" ], "properties": { "url": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "privacy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "count": { "type": "integer" }, "limit": { "type": "integer" }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "pinterest-board", "task_name": "Pinterest Board API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "pins": [ { "id": "id-1", "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "alt_text": "Sample alt_text 1", "is_video": true, "link_url": "https://example.com/item-1", "image_url": "https://example.com/item-1", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "pinner_name": "Stylish Shoreditch Loft with Balcony", "pinner_username": "Stylish Shoreditch Loft with Balcony" } ], "board": { "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "owner": "sample", "privacy": "sample" }, "count": 1, "limit": 1, "success": true, "pagination": { "next_cursor": "cursor-page-1", "has_next_page": true } }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "board", "count", "pins", "limit", "pagination" ], "properties": { "pins": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "title", "description", "alt_text", "image_url", "image_urls", "link_url", "is_video", "pinner_username", "pinner_name" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "alt_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_video": { "type": "boolean" }, "link_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pinner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pinner_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "board": { "type": "object", "required": [ "url", "name", "owner", "privacy" ], "properties": { "url": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "privacy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "count": { "type": "integer" }, "limit": { "type": "integer" }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "pinterest-board", "task_name": "Pinterest Board API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPinterestBoardAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 100, "maximum": 250, "minimum": 1, "description": "Maximum number of pins to return in this page." }, "cursor": { "type": "string", "description": "Offset cursor returned by the previous page. Omit it to start from the first pin." }, "board_url": { "type": "string", "examples": [ "https://www.pinterest.com/username/board-name/" ], "description": "URL of the Pinterest board to scrape. The board must be accessible to the connected Pinterest account." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "board_url" ] }, "example": { "board_url": "https://example.com/item-1" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-pinterest-board" }, "x-browsable-website-login-required": true } }, "/v1/tasks/pinterest-pin/runs": { "post": { "tags": [ "Pinterest" ], "summary": "Pinterest Pin API", "description": "Scrape a public Pinterest pin detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "pinterest-pin", "task_name": "Pinterest Pin API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "pinterest-pin", "task_name": "Pinterest Pin API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPinterestPinCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Pinterest pin URL returned by pinterest/search.", "x-placeholder": "e.g. https://www.pinterest.com/pin/123456789012345678/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.pinterest.com/pin/123456789012345678/" } } } }, "x-browsable-website-login-required": false } }, "/v1/pinterest/pin": { "post": { "tags": [ "Pinterest" ], "summary": "Pinterest Pin API", "description": "Scrape a public Pinterest pin detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "pinterest-pin", "task_name": "Pinterest Pin API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "pinterest-pin", "task_name": "Pinterest Pin API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runPinterestPinAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Pinterest pin URL returned by pinterest/search.", "x-placeholder": "e.g. https://www.pinterest.com/pin/123456789012345678/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.pinterest.com/pin/123456789012345678/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-pinterest-pin" }, "x-browsable-website-login-required": false } }, "/v1/tasks/producthunt-product/runs": { "post": { "tags": [ "Product Hunt" ], "summary": "Product Hunt Product API", "description": "Scrape a public Product Hunt product or launch page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "producthunt-product", "task_name": "Product Hunt Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "producthunt-product", "task_name": "Product Hunt Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runProducthuntProductCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.producthunt.com/products/notion" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.producthunt.com/products/notion" } } } }, "x-browsable-website-login-required": false } }, "/v1/producthunt/product": { "post": { "tags": [ "Product Hunt" ], "summary": "Product Hunt Product API", "description": "Scrape a public Product Hunt product or launch page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "producthunt-product", "task_name": "Product Hunt Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "producthunt-product", "task_name": "Product Hunt Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runProducthuntProductAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.producthunt.com/products/notion" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.producthunt.com/products/notion" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-producthunt-product" }, "x-browsable-website-login-required": false } }, "/v1/tasks/producthunt-search/runs": { "post": { "tags": [ "Product Hunt" ], "summary": "Product Hunt API", "description": "Scrape public Product Hunt product and launch search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "producthunt-search", "task_name": "Product Hunt API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "producthunt-search", "task_name": "Product Hunt API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runProducthuntSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "design tools", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. design tools" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "design tools" } } } }, "x-browsable-website-login-required": false } }, "/v1/producthunt/search": { "post": { "tags": [ "Product Hunt" ], "summary": "Product Hunt API", "description": "Scrape public Product Hunt product and launch search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "producthunt-search", "task_name": "Product Hunt API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "producthunt-search", "task_name": "Product Hunt API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runProducthuntSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "design tools", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. design tools" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "design tools" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-producthunt-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/quora-question/runs": { "post": { "tags": [ "Quora" ], "summary": "Quora Question API", "description": "Scrape a public Quora question page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "quora-question", "task_name": "Quora Question API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "quora-question", "task_name": "Quora Question API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runQuoraQuestionCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Public Quora question URL.", "x-placeholder": "e.g. https://www.quora.com/What-is-example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.quora.com/What-is-example" } } } }, "x-browsable-website-login-required": false } }, "/v1/quora/question": { "post": { "tags": [ "Quora" ], "summary": "Quora Question API", "description": "Scrape a public Quora question page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "quora-question", "task_name": "Quora Question API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "quora-question", "task_name": "Quora Question API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runQuoraQuestionAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Public Quora question URL.", "x-placeholder": "e.g. https://www.quora.com/What-is-example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.quora.com/What-is-example" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-quora-question" }, "x-browsable-website-login-required": false } }, "/v1/tasks/realtor-property/runs": { "post": { "tags": [ "Realtor" ], "summary": "Realtor.com Property API", "description": "Scrape a public Realtor.com property page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "realtor-property", "task_name": "Realtor.com Property API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "realtor-property", "task_name": "Realtor.com Property API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRealtorPropertyCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.realtor.com/realestateandhomes-detail/example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.realtor.com/realestateandhomes-detail/example" } } } }, "x-browsable-website-login-required": false } }, "/v1/realtor/property": { "post": { "tags": [ "Realtor" ], "summary": "Realtor.com Property API", "description": "Scrape a public Realtor.com property page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "realtor-property", "task_name": "Realtor.com Property API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "realtor-property", "task_name": "Realtor.com Property API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRealtorPropertyAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.realtor.com/realestateandhomes-detail/example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.realtor.com/realestateandhomes-detail/example" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-realtor-property" }, "x-browsable-website-login-required": false } }, "/v1/tasks/realtor-search/runs": { "post": { "tags": [ "Realtor" ], "summary": "Realtor.com API", "description": "Scrape public Realtor.com property search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "realtor-search", "task_name": "Realtor.com API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "realtor-search", "task_name": "Realtor.com API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRealtorSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Austin TX", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Austin TX" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Austin TX" } } } }, "x-browsable-website-login-required": false } }, "/v1/realtor/search": { "post": { "tags": [ "Realtor" ], "summary": "Realtor.com API", "description": "Scrape public Realtor.com property search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "realtor-search", "task_name": "Realtor.com API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "realtor-search", "task_name": "Realtor.com API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRealtorSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Austin TX", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Austin TX" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Austin TX" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-realtor-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/reddit-multireddit/runs": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Multireddit", "description": "Fetch posts from a user's multireddit.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "after": { "type": "string" }, "count": { "type": "integer" }, "before": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "author", "subreddit", "score", "upvoteRatio", "numComments", "created", "url", "isVideo" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "score": { "type": "number" }, "title": { "type": "string" }, "author": { "type": "string" }, "created": { "type": "number" }, "isVideo": { "type": "boolean" }, "selftext": { "type": "string" }, "subreddit": { "type": "string" }, "thumbnail": { "type": "string" }, "numComments": { "type": "number" }, "upvoteRatio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-multireddit", "task_name": "Reddit Multireddit", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "after": "sample", "count": 1, "before": "sample", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "score": 1.5, "title": "Stylish Shoreditch Loft with Balcony", "author": "user_1", "created": 1.5, "isVideo": true, "selftext": "Sample selftext 1", "subreddit": "programming", "thumbnail": "https://images.example.com/thumbnail-1.jpg", "numComments": 1.5, "upvoteRatio": 0.95 } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "after": { "type": "string" }, "count": { "type": "integer" }, "before": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "author", "subreddit", "score", "upvoteRatio", "numComments", "created", "url", "isVideo" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "score": { "type": "number" }, "title": { "type": "string" }, "author": { "type": "string" }, "created": { "type": "number" }, "isVideo": { "type": "boolean" }, "selftext": { "type": "string" }, "subreddit": { "type": "string" }, "thumbnail": { "type": "string" }, "numComments": { "type": "number" }, "upvoteRatio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-multireddit", "task_name": "Reddit Multireddit", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditMultiredditCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "after": { "type": "string", "description": "Cursor returned by the previous response." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of items to return." }, "before": { "type": "string", "description": "Cursor returned by the previous response." }, "username": { "type": "string", "x-sample": "goretsky", "maxLength": 2000, "minLength": 1, "description": "Reddit username.", "x-placeholder": "e.g. goretsky" }, "multiName": { "type": "string", "x-sample": "security", "description": "Multireddit name.", "x-placeholder": "e.g. security" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username", "multiName" ] }, "example": { "username": "goretsky", "multiName": "security" } } } }, "x-browsable-website-login-required": false } }, "/v1/reddit/multireddit": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Multireddit", "description": "Fetch posts from a user's multireddit.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "after": { "type": "string" }, "count": { "type": "integer" }, "before": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "author", "subreddit", "score", "upvoteRatio", "numComments", "created", "url", "isVideo" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "score": { "type": "number" }, "title": { "type": "string" }, "author": { "type": "string" }, "created": { "type": "number" }, "isVideo": { "type": "boolean" }, "selftext": { "type": "string" }, "subreddit": { "type": "string" }, "thumbnail": { "type": "string" }, "numComments": { "type": "number" }, "upvoteRatio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-multireddit", "task_name": "Reddit Multireddit", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "after": "sample", "count": 1, "before": "sample", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "score": 1.5, "title": "Stylish Shoreditch Loft with Balcony", "author": "user_1", "created": 1.5, "isVideo": true, "selftext": "Sample selftext 1", "subreddit": "programming", "thumbnail": "https://images.example.com/thumbnail-1.jpg", "numComments": 1.5, "upvoteRatio": 0.95 } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "after": { "type": "string" }, "count": { "type": "integer" }, "before": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "author", "subreddit", "score", "upvoteRatio", "numComments", "created", "url", "isVideo" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "score": { "type": "number" }, "title": { "type": "string" }, "author": { "type": "string" }, "created": { "type": "number" }, "isVideo": { "type": "boolean" }, "selftext": { "type": "string" }, "subreddit": { "type": "string" }, "thumbnail": { "type": "string" }, "numComments": { "type": "number" }, "upvoteRatio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-multireddit", "task_name": "Reddit Multireddit", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditMultiredditAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "after": { "type": "string", "description": "Cursor returned by the previous response." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of items to return." }, "before": { "type": "string", "description": "Cursor returned by the previous response." }, "username": { "type": "string", "x-sample": "goretsky", "maxLength": 2000, "minLength": 1, "description": "Reddit username.", "x-placeholder": "e.g. goretsky" }, "multiName": { "type": "string", "x-sample": "security", "description": "Multireddit name.", "x-placeholder": "e.g. security" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username", "multiName" ] }, "example": { "username": "goretsky", "multiName": "security" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-reddit-multireddit" }, "x-browsable-website-login-required": false } }, "/v1/tasks/reddit-post-comments/runs": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Post Comments", "description": "Fetch a Reddit post and its comments by URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-post-comments", "task_name": "Reddit Post Comments", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": {}, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-post-comments", "task_name": "Reddit Post Comments", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditPostCommentsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Reddit post URL.", "x-placeholder": "e.g. https://www.reddit.com/r/programming/comments/abc123/post/" }, "includeComments": { "type": "boolean", "default": true, "description": "Whether to include comments." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.reddit.com/r/programming/comments/abc123/post/" } } } }, "x-browsable-website-login-required": false } }, "/v1/reddit/post/comments": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Post Comments", "description": "Fetch a Reddit post and its comments by URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-post-comments", "task_name": "Reddit Post Comments", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": {}, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-post-comments", "task_name": "Reddit Post Comments", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditPostCommentsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Reddit post URL.", "x-placeholder": "e.g. https://www.reddit.com/r/programming/comments/abc123/post/" }, "includeComments": { "type": "boolean", "default": true, "description": "Whether to include comments." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.reddit.com/r/programming/comments/abc123/post/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-reddit-post-comments" }, "x-browsable-website-login-required": false } }, "/v1/tasks/reddit-posts/runs": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Posts", "description": "Fetch frontpage or subreddit posts with sort, timeframe, and cursor controls.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "after": { "type": "string" }, "count": { "type": "integer" }, "before": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "author", "subreddit", "score", "upvoteRatio", "numComments", "created", "url", "isVideo" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "score": { "type": "number" }, "title": { "type": "string" }, "author": { "type": "string" }, "created": { "type": "number" }, "isVideo": { "type": "boolean" }, "selftext": { "type": "string" }, "subreddit": { "type": "string" }, "thumbnail": { "type": "string" }, "numComments": { "type": "number" }, "upvoteRatio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-posts", "task_name": "Reddit Posts", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "after": "sample", "count": 1, "before": "sample", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "score": 1.5, "title": "Stylish Shoreditch Loft with Balcony", "author": "user_1", "created": 1.5, "isVideo": true, "selftext": "Sample selftext 1", "subreddit": "programming", "thumbnail": "https://images.example.com/thumbnail-1.jpg", "numComments": 1.5, "upvoteRatio": 0.95 } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "after": { "type": "string" }, "count": { "type": "integer" }, "before": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "author", "subreddit", "score", "upvoteRatio", "numComments", "created", "url", "isVideo" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "score": { "type": "number" }, "title": { "type": "string" }, "author": { "type": "string" }, "created": { "type": "number" }, "isVideo": { "type": "boolean" }, "selftext": { "type": "string" }, "subreddit": { "type": "string" }, "thumbnail": { "type": "string" }, "numComments": { "type": "number" }, "upvoteRatio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-posts", "task_name": "Reddit Posts", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditPostsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sort": { "enum": [ "hot", "new", "top", "rising", "controversial" ], "type": "string", "default": "hot", "description": "Listing sort." }, "after": { "type": "string", "description": "Cursor returned by the previous response." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of items to return." }, "before": { "type": "string", "description": "Cursor returned by the previous response." }, "subreddit": { "type": "string", "x-sample": "programming", "description": "Subreddit name, r/name, or subreddit URL.", "x-placeholder": "e.g. r/programming" }, "timeframe": { "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Timeframe for results where supported." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "x-browsable-website-login-required": false } }, "/v1/reddit/posts": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Posts", "description": "Fetch frontpage or subreddit posts with sort, timeframe, and cursor controls.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "after": { "type": "string" }, "count": { "type": "integer" }, "before": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "author", "subreddit", "score", "upvoteRatio", "numComments", "created", "url", "isVideo" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "score": { "type": "number" }, "title": { "type": "string" }, "author": { "type": "string" }, "created": { "type": "number" }, "isVideo": { "type": "boolean" }, "selftext": { "type": "string" }, "subreddit": { "type": "string" }, "thumbnail": { "type": "string" }, "numComments": { "type": "number" }, "upvoteRatio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-posts", "task_name": "Reddit Posts", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "after": "sample", "count": 1, "before": "sample", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "score": 1.5, "title": "Stylish Shoreditch Loft with Balcony", "author": "user_1", "created": 1.5, "isVideo": true, "selftext": "Sample selftext 1", "subreddit": "programming", "thumbnail": "https://images.example.com/thumbnail-1.jpg", "numComments": 1.5, "upvoteRatio": 0.95 } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "after": { "type": "string" }, "count": { "type": "integer" }, "before": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "author", "subreddit", "score", "upvoteRatio", "numComments", "created", "url", "isVideo" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "score": { "type": "number" }, "title": { "type": "string" }, "author": { "type": "string" }, "created": { "type": "number" }, "isVideo": { "type": "boolean" }, "selftext": { "type": "string" }, "subreddit": { "type": "string" }, "thumbnail": { "type": "string" }, "numComments": { "type": "number" }, "upvoteRatio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-posts", "task_name": "Reddit Posts", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditPostsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sort": { "enum": [ "hot", "new", "top", "rising", "controversial" ], "type": "string", "default": "hot", "description": "Listing sort." }, "after": { "type": "string", "description": "Cursor returned by the previous response." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of items to return." }, "before": { "type": "string", "description": "Cursor returned by the previous response." }, "subreddit": { "type": "string", "x-sample": "programming", "description": "Subreddit name, r/name, or subreddit URL.", "x-placeholder": "e.g. r/programming" }, "timeframe": { "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Timeframe for results where supported." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-reddit-posts" }, "x-browsable-website-login-required": false } }, "/v1/tasks/reddit-search/runs": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Search", "description": "Search Reddit posts globally or within a subreddit.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "after": { "type": "string" }, "count": { "type": "integer" }, "before": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "author", "subreddit", "score", "upvoteRatio", "numComments", "created", "url", "isVideo" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "score": { "type": "number" }, "title": { "type": "string" }, "author": { "type": "string" }, "created": { "type": "number" }, "isVideo": { "type": "boolean" }, "selftext": { "type": "string" }, "subreddit": { "type": "string" }, "thumbnail": { "type": "string" }, "numComments": { "type": "number" }, "upvoteRatio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-search", "task_name": "Reddit Search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "after": "sample", "count": 1, "before": "sample", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "score": 1.5, "title": "Stylish Shoreditch Loft with Balcony", "author": "user_1", "created": 1.5, "isVideo": true, "selftext": "Sample selftext 1", "subreddit": "programming", "thumbnail": "https://images.example.com/thumbnail-1.jpg", "numComments": 1.5, "upvoteRatio": 0.95 } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "after": { "type": "string" }, "count": { "type": "integer" }, "before": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "author", "subreddit", "score", "upvoteRatio", "numComments", "created", "url", "isVideo" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "score": { "type": "number" }, "title": { "type": "string" }, "author": { "type": "string" }, "created": { "type": "number" }, "isVideo": { "type": "boolean" }, "selftext": { "type": "string" }, "subreddit": { "type": "string" }, "thumbnail": { "type": "string" }, "numComments": { "type": "number" }, "upvoteRatio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-search", "task_name": "Reddit Search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sort": { "enum": [ "relevance", "new", "top", "comment_count", "hot", "comments" ], "type": "string", "description": "Sort order. Global search supports relevance, new, top, and comment_count; subreddit search also supports hot and comments." }, "after": { "type": "string", "description": "Cursor returned by the previous response." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of items to return." }, "query": { "type": "string", "x-sample": "machine learning", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. machine learning" }, "before": { "type": "string", "description": "Cursor returned by the previous response." }, "subreddit": { "type": "string", "x-sample": "programming", "description": "Subreddit name, r/name, or subreddit URL.", "x-placeholder": "e.g. r/programming" }, "timeframe": { "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Timeframe for results where supported." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "machine learning" } } } }, "x-browsable-website-login-required": false } }, "/v1/reddit/search": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Search", "description": "Search Reddit posts globally or within a subreddit.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "after": { "type": "string" }, "count": { "type": "integer" }, "before": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "author", "subreddit", "score", "upvoteRatio", "numComments", "created", "url", "isVideo" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "score": { "type": "number" }, "title": { "type": "string" }, "author": { "type": "string" }, "created": { "type": "number" }, "isVideo": { "type": "boolean" }, "selftext": { "type": "string" }, "subreddit": { "type": "string" }, "thumbnail": { "type": "string" }, "numComments": { "type": "number" }, "upvoteRatio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-search", "task_name": "Reddit Search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "after": "sample", "count": 1, "before": "sample", "results": [ { "id": "id-1", "url": "https://example.com/item-1", "score": 1.5, "title": "Stylish Shoreditch Loft with Balcony", "author": "user_1", "created": 1.5, "isVideo": true, "selftext": "Sample selftext 1", "subreddit": "programming", "thumbnail": "https://images.example.com/thumbnail-1.jpg", "numComments": 1.5, "upvoteRatio": 0.95 } ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "results", "count" ], "properties": { "after": { "type": "string" }, "count": { "type": "integer" }, "before": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "author", "subreddit", "score", "upvoteRatio", "numComments", "created", "url", "isVideo" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "score": { "type": "number" }, "title": { "type": "string" }, "author": { "type": "string" }, "created": { "type": "number" }, "isVideo": { "type": "boolean" }, "selftext": { "type": "string" }, "subreddit": { "type": "string" }, "thumbnail": { "type": "string" }, "numComments": { "type": "number" }, "upvoteRatio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-search", "task_name": "Reddit Search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sort": { "enum": [ "relevance", "new", "top", "comment_count", "hot", "comments" ], "type": "string", "description": "Sort order. Global search supports relevance, new, top, and comment_count; subreddit search also supports hot and comments." }, "after": { "type": "string", "description": "Cursor returned by the previous response." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of items to return." }, "query": { "type": "string", "x-sample": "machine learning", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. machine learning" }, "before": { "type": "string", "description": "Cursor returned by the previous response." }, "subreddit": { "type": "string", "x-sample": "programming", "description": "Subreddit name, r/name, or subreddit URL.", "x-placeholder": "e.g. r/programming" }, "timeframe": { "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Timeframe for results where supported." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "machine learning" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-reddit-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/reddit-subreddit-details/runs": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Subreddit Details", "description": "Fetch subreddit about data, rules, and optionally moderators.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "count": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-subreddit-details", "task_name": "Reddit Subreddit Details", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "data": {}, "count": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "count": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-subreddit-details", "task_name": "Reddit Subreddit Details", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditSubredditDetailsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Subreddit URL.", "x-placeholder": "e.g. https://www.reddit.com/r/programming/" }, "include": { "type": "array", "items": { "enum": [ "about", "rules", "moderators" ], "type": "string" }, "default": [ "about", "rules" ], "description": "Sections to include. Defaults to about and rules." }, "subreddit": { "type": "string", "x-sample": "programming", "description": "Subreddit name, r/name, or subreddit URL.", "x-placeholder": "e.g. r/programming" }, "includeModerators": { "type": "boolean", "default": false, "description": "Convenience flag to include moderators." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "subreddit" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.reddit.com/r/programming/" } } } }, "x-browsable-website-login-required": false } }, "/v1/reddit/subreddit/details": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Subreddit Details", "description": "Fetch subreddit about data, rules, and optionally moderators.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "count": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-subreddit-details", "task_name": "Reddit Subreddit Details", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "data": {}, "count": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "count": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-subreddit-details", "task_name": "Reddit Subreddit Details", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditSubredditDetailsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Subreddit URL.", "x-placeholder": "e.g. https://www.reddit.com/r/programming/" }, "include": { "type": "array", "items": { "enum": [ "about", "rules", "moderators" ], "type": "string" }, "default": [ "about", "rules" ], "description": "Sections to include. Defaults to about and rules." }, "subreddit": { "type": "string", "x-sample": "programming", "description": "Subreddit name, r/name, or subreddit URL.", "x-placeholder": "e.g. r/programming" }, "includeModerators": { "type": "boolean", "default": false, "description": "Convenience flag to include moderators." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "subreddit" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.reddit.com/r/programming/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-reddit-subreddit-details" }, "x-browsable-website-login-required": false } }, "/v1/tasks/reddit-subreddits/runs": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Subreddits", "description": "Discover popular, new, or trending subreddits.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data", "count" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "count": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-subreddits", "task_name": "Reddit Subreddits", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "data": [ {} ], "count": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data", "count" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "count": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-subreddits", "task_name": "Reddit Subreddits", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditSubredditsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "popular", "new", "trending" ], "type": "string", "default": "popular", "description": "Discovery feed type." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "x-browsable-website-login-required": false } }, "/v1/reddit/subreddits": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Subreddits", "description": "Discover popular, new, or trending subreddits.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data", "count" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "count": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-subreddits", "task_name": "Reddit Subreddits", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "data": [ {} ], "count": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data", "count" ], "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "count": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-subreddits", "task_name": "Reddit Subreddits", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditSubredditsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "popular", "new", "trending" ], "type": "string", "default": "popular", "description": "Discovery feed type." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-reddit-subreddits" }, "x-browsable-website-login-required": false } }, "/v1/tasks/reddit-user-content/runs": { "post": { "tags": [ "Reddit" ], "summary": "Reddit User Content", "description": "Fetch a Reddit user's overview, submitted posts, or comments.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "items", "count" ], "properties": { "count": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-user-content", "task_name": "Reddit User Content", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "items": [ {} ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "items", "count" ], "properties": { "count": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-user-content", "task_name": "Reddit User Content", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditUserContentCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "overview", "submitted", "comments" ], "type": "string", "default": "overview", "description": "User feed type." }, "after": { "type": "string", "description": "Cursor returned by the previous response." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of items to return." }, "before": { "type": "string", "description": "Cursor returned by the previous response." }, "username": { "type": "string", "x-sample": "spez", "maxLength": 2000, "minLength": 1, "description": "Reddit username.", "x-placeholder": "e.g. spez" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "spez" } } } }, "x-browsable-website-login-required": false } }, "/v1/reddit/user/content": { "post": { "tags": [ "Reddit" ], "summary": "Reddit User Content", "description": "Fetch a Reddit user's overview, submitted posts, or comments.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "items", "count" ], "properties": { "count": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-user-content", "task_name": "Reddit User Content", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "items": [ {} ] }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "items", "count" ], "properties": { "count": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-user-content", "task_name": "Reddit User Content", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditUserContentAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "enum": [ "overview", "submitted", "comments" ], "type": "string", "default": "overview", "description": "User feed type." }, "after": { "type": "string", "description": "Cursor returned by the previous response." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of items to return." }, "before": { "type": "string", "description": "Cursor returned by the previous response." }, "username": { "type": "string", "x-sample": "spez", "maxLength": 2000, "minLength": 1, "description": "Reddit username.", "x-placeholder": "e.g. spez" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "spez" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-reddit-user-content" }, "x-browsable-website-login-required": false } }, "/v1/tasks/reddit-wiki/runs": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Wiki", "description": "List subreddit wiki pages or fetch one wiki page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "count": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-wiki", "task_name": "Reddit Wiki", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "data": {}, "count": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "count": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-wiki", "task_name": "Reddit Wiki", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditWikiCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pageName": { "type": "string", "x-sample": "faq", "description": "Optional wiki page name. Omit to list pages.", "x-placeholder": "e.g. faq" }, "subreddit": { "type": "string", "x-sample": "learnprogramming", "description": "Subreddit name, r/name, or subreddit URL.", "x-placeholder": "e.g. r/learnprogramming" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "subreddit" ] }, "example": { "subreddit": "learnprogramming" } } } }, "x-browsable-website-login-required": false } }, "/v1/reddit/wiki": { "post": { "tags": [ "Reddit" ], "summary": "Reddit Wiki", "description": "List subreddit wiki pages or fetch one wiki page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "count": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-wiki", "task_name": "Reddit Wiki", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "data": {}, "count": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "data" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "count": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "reddit-wiki", "task_name": "Reddit Wiki", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedditWikiAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pageName": { "type": "string", "x-sample": "faq", "description": "Optional wiki page name. Omit to list pages.", "x-placeholder": "e.g. faq" }, "subreddit": { "type": "string", "x-sample": "learnprogramming", "description": "Subreddit name, r/name, or subreddit URL.", "x-placeholder": "e.g. r/learnprogramming" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "subreddit" ] }, "example": { "subreddit": "learnprogramming" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-reddit-wiki" }, "x-browsable-website-login-required": false } }, "/v1/tasks/redfin-property/runs": { "post": { "tags": [ "Redfin" ], "summary": "Redfin Property API", "description": "Scrape a public Redfin property detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "redfin-property", "task_name": "Redfin Property API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "redfin-property", "task_name": "Redfin Property API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedfinPropertyCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Redfin property URL returned by redfin/search.", "x-placeholder": "e.g. https://www.redfin.com/WA/Seattle/123-Main-St-98101/home/12345" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.redfin.com/WA/Seattle/123-Main-St-98101/home/12345" } } } }, "x-browsable-website-login-required": false } }, "/v1/redfin/property": { "post": { "tags": [ "Redfin" ], "summary": "Redfin Property API", "description": "Scrape a public Redfin property detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "redfin-property", "task_name": "Redfin Property API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "redfin-property", "task_name": "Redfin Property API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedfinPropertyAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Redfin property URL returned by redfin/search.", "x-placeholder": "e.g. https://www.redfin.com/WA/Seattle/123-Main-St-98101/home/12345" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.redfin.com/WA/Seattle/123-Main-St-98101/home/12345" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-redfin-property" }, "x-browsable-website-login-required": false } }, "/v1/tasks/redfin-search/runs": { "post": { "tags": [ "Redfin" ], "summary": "Redfin API", "description": "Search public Redfin property listings by location.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "redfin-search", "task_name": "Redfin API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "redfin-search", "task_name": "Redfin API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedfinSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Denver, CO", "maxLength": 2000, "minLength": 1, "description": "City, neighborhood, county, state, or ZIP code.", "x-placeholder": "e.g. Denver, CO" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Denver, CO" } } } }, "x-browsable-website-login-required": false } }, "/v1/redfin/search": { "post": { "tags": [ "Redfin" ], "summary": "Redfin API", "description": "Search public Redfin property listings by location.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "redfin-search", "task_name": "Redfin API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "redfin-search", "task_name": "Redfin API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRedfinSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Denver, CO", "maxLength": 2000, "minLength": 1, "description": "City, neighborhood, county, state, or ZIP code.", "x-placeholder": "e.g. Denver, CO" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Denver, CO" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-redfin-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/rightmove-property/runs": { "post": { "tags": [ "Rightmove" ], "summary": "Rightmove Property API", "description": "Scrape a public Rightmove property detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "rightmove-property", "task_name": "Rightmove Property API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "rightmove-property", "task_name": "Rightmove Property API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRightmovePropertyCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Rightmove property URL returned by rightmove/search.", "x-placeholder": "e.g. https://www.rightmove.co.uk/properties/123456789" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.rightmove.co.uk/properties/123456789" } } } }, "x-browsable-website-login-required": false } }, "/v1/rightmove/property": { "post": { "tags": [ "Rightmove" ], "summary": "Rightmove Property API", "description": "Scrape a public Rightmove property detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "rightmove-property", "task_name": "Rightmove Property API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "rightmove-property", "task_name": "Rightmove Property API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRightmovePropertyAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Rightmove property URL returned by rightmove/search.", "x-placeholder": "e.g. https://www.rightmove.co.uk/properties/123456789" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.rightmove.co.uk/properties/123456789" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-rightmove-property" }, "x-browsable-website-login-required": false } }, "/v1/tasks/rightmove-search/runs": { "post": { "tags": [ "Rightmove" ], "summary": "Rightmove API", "description": "Search public Rightmove property listings by location.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "rightmove-search", "task_name": "Rightmove API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "rightmove-search", "task_name": "Rightmove API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRightmoveSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Manchester", "maxLength": 2000, "minLength": 1, "description": "UK town, city, postcode, or area.", "x-placeholder": "e.g. Manchester" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Manchester" } } } }, "x-browsable-website-login-required": false } }, "/v1/rightmove/search": { "post": { "tags": [ "Rightmove" ], "summary": "Rightmove API", "description": "Search public Rightmove property listings by location.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "rightmove-search", "task_name": "Rightmove API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "rightmove-search", "task_name": "Rightmove API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runRightmoveSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Manchester", "maxLength": 2000, "minLength": 1, "description": "UK town, city, postcode, or area.", "x-placeholder": "e.g. Manchester" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Manchester" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-rightmove-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/skyscanner-search/runs": { "post": { "tags": [ "Skyscanner" ], "summary": "Skyscanner API", "description": "Search live flight itineraries from a Skyscanner-style route query. If Skyscanner blocks the browser, results transparently identify the live fallback provider.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "skyscanner-search", "task_name": "Skyscanner API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "skyscanner-search", "task_name": "Skyscanner API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSkyscannerSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "adults": { "type": "integer", "default": 1, "maximum": 9, "minimum": 1, "description": "Number of adult guests or travellers." }, "origin": { "type": "string", "x-sample": "US", "description": "Departure city or airport code, such as London or LHR. Use an airport code for a specific airport.", "x-placeholder": "e.g. US" }, "depart_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "x-sample": "2027-06-14", "description": "Departure date in YYYY-MM-DD format. Must not be in the past.", "x-placeholder": "e.g. 260701" }, "destination": { "type": "string", "x-sample": "UK", "description": "Arrival city or airport code, such as New York or JFK. Use an airport code for a specific airport.", "x-placeholder": "e.g. UK" }, "return_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "x-sample": "2027-06-21", "description": "Optional return date in YYYY-MM-DD format, on or after departure.", "x-placeholder": "e.g. 2026-07-08" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "origin", "depart_date", "destination" ] }, "example": { "origin": "US", "depart_date": "2027-06-14", "destination": "UK" } } } }, "x-browsable-website-login-required": false } }, "/v1/skyscanner/search": { "post": { "tags": [ "Skyscanner" ], "summary": "Skyscanner API", "description": "Search live flight itineraries from a Skyscanner-style route query. If Skyscanner blocks the browser, results transparently identify the live fallback provider.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "skyscanner-search", "task_name": "Skyscanner API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "skyscanner-search", "task_name": "Skyscanner API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSkyscannerSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "adults": { "type": "integer", "default": 1, "maximum": 9, "minimum": 1, "description": "Number of adult guests or travellers." }, "origin": { "type": "string", "x-sample": "US", "description": "Departure city or airport code, such as London or LHR. Use an airport code for a specific airport.", "x-placeholder": "e.g. US" }, "depart_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "x-sample": "2027-06-14", "description": "Departure date in YYYY-MM-DD format. Must not be in the past.", "x-placeholder": "e.g. 260701" }, "destination": { "type": "string", "x-sample": "UK", "description": "Arrival city or airport code, such as New York or JFK. Use an airport code for a specific airport.", "x-placeholder": "e.g. UK" }, "return_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "x-sample": "2027-06-21", "description": "Optional return date in YYYY-MM-DD format, on or after departure.", "x-placeholder": "e.g. 2026-07-08" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "origin", "depart_date", "destination" ] }, "example": { "origin": "US", "depart_date": "2027-06-14", "destination": "UK" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-skyscanner-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/soundcloud-page/runs": { "post": { "tags": [ "SoundCloud" ], "summary": "SoundCloud Page API", "description": "Scrape a public SoundCloud track, playlist, or profile page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "soundcloud-page", "task_name": "SoundCloud Page API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "soundcloud-page", "task_name": "SoundCloud Page API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSoundcloudPageCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://soundcloud.com/artist/track" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://soundcloud.com/artist/track" } } } }, "x-browsable-website-login-required": false } }, "/v1/soundcloud/page": { "post": { "tags": [ "SoundCloud" ], "summary": "SoundCloud Page API", "description": "Scrape a public SoundCloud track, playlist, or profile page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "soundcloud-page", "task_name": "SoundCloud Page API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "soundcloud-page", "task_name": "SoundCloud Page API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSoundcloudPageAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://soundcloud.com/artist/track" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://soundcloud.com/artist/track" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-soundcloud-page" }, "x-browsable-website-login-required": false } }, "/v1/tasks/soundcloud-search/runs": { "post": { "tags": [ "SoundCloud" ], "summary": "SoundCloud API", "description": "Scrape public SoundCloud search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "soundcloud-search", "task_name": "SoundCloud API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "soundcloud-search", "task_name": "SoundCloud API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSoundcloudSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "lo-fi beats", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. lo-fi beats" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "lo-fi beats" } } } }, "x-browsable-website-login-required": false } }, "/v1/soundcloud/search": { "post": { "tags": [ "SoundCloud" ], "summary": "SoundCloud API", "description": "Scrape public SoundCloud search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "soundcloud-search", "task_name": "SoundCloud API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "soundcloud-search", "task_name": "SoundCloud API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSoundcloudSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "lo-fi beats", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. lo-fi beats" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "lo-fi beats" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-soundcloud-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/spotify-metadata/runs": { "post": { "tags": [ "Spotify" ], "summary": "Spotify API", "description": "Fetch public Spotify oEmbed metadata for Spotify URLs. Search and catalog APIs require OAuth.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "spotify-metadata", "task_name": "Spotify API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "spotify-metadata", "task_name": "Spotify API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSpotifyMetadataCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://open.spotify.com/track/11dFghVXANMlKmJXsNCbNl", "maxLength": 2000, "minLength": 1, "description": "Spotify track, album, playlist, artist, episode, or show URL.", "x-placeholder": "e.g. https://open.spotify.com/track/11dFghVXANMlKmJXsNCbNl" }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://open.spotify.com/track/11dFghVXANMlKmJXsNCbNl" } } } }, "x-browsable-website-login-required": false } }, "/v1/spotify/metadata": { "post": { "tags": [ "Spotify" ], "summary": "Spotify API", "description": "Fetch public Spotify oEmbed metadata for Spotify URLs. Search and catalog APIs require OAuth.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "spotify-metadata", "task_name": "Spotify API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "spotify-metadata", "task_name": "Spotify API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSpotifyMetadataAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://open.spotify.com/track/11dFghVXANMlKmJXsNCbNl", "maxLength": 2000, "minLength": 1, "description": "Spotify track, album, playlist, artist, episode, or show URL.", "x-placeholder": "e.g. https://open.spotify.com/track/11dFghVXANMlKmJXsNCbNl" }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://open.spotify.com/track/11dFghVXANMlKmJXsNCbNl" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-spotify-metadata" }, "x-browsable-website-login-required": false } }, "/v1/tasks/stackoverflow-question/runs": { "post": { "tags": [ "Stack Overflow" ], "summary": "Stack Overflow Question API", "description": "Scrape a public Stack Overflow question detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "stackoverflow-question", "task_name": "Stack Overflow Question API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "stackoverflow-question", "task_name": "Stack Overflow Question API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runStackoverflowQuestionCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Stack Overflow question URL returned by stackoverflow/search.", "x-placeholder": "e.g. https://stackoverflow.com/questions/12345678/example-question" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://stackoverflow.com/questions/12345678/example-question" } } } }, "x-browsable-website-login-required": false } }, "/v1/stackoverflow/question": { "post": { "tags": [ "Stack Overflow" ], "summary": "Stack Overflow Question API", "description": "Scrape a public Stack Overflow question detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "stackoverflow-question", "task_name": "Stack Overflow Question API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "stackoverflow-question", "task_name": "Stack Overflow Question API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runStackoverflowQuestionAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Stack Overflow question URL returned by stackoverflow/search.", "x-placeholder": "e.g. https://stackoverflow.com/questions/12345678/example-question" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://stackoverflow.com/questions/12345678/example-question" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-stackoverflow-question" }, "x-browsable-website-login-required": false } }, "/v1/tasks/stackoverflow-search/runs": { "post": { "tags": [ "Stack Overflow" ], "summary": "Stack Overflow API", "description": "Search Stack Overflow through the public Stack Exchange API with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "stackoverflow-search", "task_name": "Stack Overflow API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "stackoverflow-search", "task_name": "Stack Overflow API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runStackoverflowSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "playwright timeout", "maxLength": 2000, "minLength": 1, "description": "Programming question keywords.", "x-placeholder": "e.g. playwright timeout" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "playwright timeout" } } } }, "x-browsable-website-login-required": false } }, "/v1/stackoverflow/search": { "post": { "tags": [ "Stack Overflow" ], "summary": "Stack Overflow API", "description": "Search Stack Overflow through the public Stack Exchange API with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "stackoverflow-search", "task_name": "Stack Overflow API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "stackoverflow-search", "task_name": "Stack Overflow API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runStackoverflowSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "playwright timeout", "maxLength": 2000, "minLength": 1, "description": "Programming question keywords.", "x-placeholder": "e.g. playwright timeout" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "playwright timeout" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-stackoverflow-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/steam-app/runs": { "post": { "tags": [ "Steam" ], "summary": "Steam App API", "description": "Scrape a public Steam Store app page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "steam-app", "task_name": "Steam App API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "steam-app", "task_name": "Steam App API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSteamAppCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://store.steampowered.com/app/730/CounterStrike_2/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://store.steampowered.com/app/730/CounterStrike_2/" } } } }, "x-browsable-website-login-required": false } }, "/v1/steam/app": { "post": { "tags": [ "Steam" ], "summary": "Steam App API", "description": "Scrape a public Steam Store app page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "steam-app", "task_name": "Steam App API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "steam-app", "task_name": "Steam App API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSteamAppAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://store.steampowered.com/app/730/CounterStrike_2/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://store.steampowered.com/app/730/CounterStrike_2/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-steam-app" }, "x-browsable-website-login-required": false } }, "/v1/tasks/steam-search/runs": { "post": { "tags": [ "Steam" ], "summary": "Steam API", "description": "Scrape public Steam Store search results with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "steam-search", "task_name": "Steam API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "steam-search", "task_name": "Steam API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSteamSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "roguelike", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. roguelike" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "roguelike" } } } }, "x-browsable-website-login-required": false } }, "/v1/steam/search": { "post": { "tags": [ "Steam" ], "summary": "Steam API", "description": "Scrape public Steam Store search results with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "steam-search", "task_name": "Steam API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "steam-search", "task_name": "Steam API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSteamSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "roguelike", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. roguelike" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "roguelike" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-steam-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/substack-post/runs": { "post": { "tags": [ "Substack" ], "summary": "Substack Post API", "description": "Scrape a public Substack post page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "substack-post", "task_name": "Substack Post API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "substack-post", "task_name": "Substack Post API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSubstackPostCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://example.substack.com/p/post-title" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://example.substack.com/p/post-title" } } } }, "x-browsable-website-login-required": false } }, "/v1/substack/post": { "post": { "tags": [ "Substack" ], "summary": "Substack Post API", "description": "Scrape a public Substack post page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "substack-post", "task_name": "Substack Post API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "substack-post", "task_name": "Substack Post API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSubstackPostAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://example.substack.com/p/post-title" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://example.substack.com/p/post-title" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-substack-post" }, "x-browsable-website-login-required": false } }, "/v1/tasks/substack-search/runs": { "post": { "tags": [ "Substack" ], "summary": "Substack API", "description": "Scrape public Substack search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "substack-search", "task_name": "Substack API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "substack-search", "task_name": "Substack API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSubstackSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "fintech", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. fintech" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "fintech" } } } }, "x-browsable-website-login-required": false } }, "/v1/substack/search": { "post": { "tags": [ "Substack" ], "summary": "Substack API", "description": "Scrape public Substack search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "substack-search", "task_name": "Substack API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "substack-search", "task_name": "Substack API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runSubstackSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "fintech", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. fintech" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "fintech" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-substack-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/threads-profile/runs": { "post": { "tags": [ "Threads" ], "summary": "Threads Profile API", "description": "Scrape a public Threads profile or post page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "threads-profile", "task_name": "Threads Profile API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "threads-profile", "task_name": "Threads Profile API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runThreadsProfileCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.threads.net/@instagram" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.threads.net/@instagram" } } } }, "x-browsable-website-login-required": false } }, "/v1/threads/profile": { "post": { "tags": [ "Threads" ], "summary": "Threads Profile API", "description": "Scrape a public Threads profile or post page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "threads-profile", "task_name": "Threads Profile API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "threads-profile", "task_name": "Threads Profile API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runThreadsProfileAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.threads.net/@instagram" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.threads.net/@instagram" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-threads-profile" }, "x-browsable-website-login-required": false } }, "/v1/tasks/threads-search/runs": { "post": { "tags": [ "Threads" ], "summary": "Threads API", "description": "Scrape public Threads search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "threads-search", "task_name": "Threads API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "threads-search", "task_name": "Threads API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runThreadsSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "open source", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. open source" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "open source" } } } }, "x-browsable-website-login-required": false } }, "/v1/threads/search": { "post": { "tags": [ "Threads" ], "summary": "Threads API", "description": "Scrape public Threads search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "threads-search", "task_name": "Threads API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "threads-search", "task_name": "Threads API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runThreadsSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "open source", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. open source" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "open source" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-threads-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/tiktok-comments/runs": { "post": { "tags": [ "TikTok" ], "summary": "TikTok comments", "description": "Get comments for a TikTok video using a connected TikTok account. The current website requires sign-in to open comments; video and profile metadata remain available through the public endpoints.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "video", "comments", "count", "max_comments_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "video": { "type": "object", "required": [ "id", "url", "username" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "author_username", "author_display_name", "text", "created_at_text", "likes_text", "like_count", "reply_count", "url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "type": "string" }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "likes_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reply_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_comments_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-comments", "task_name": "TikTok comments", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "video": { "id": "id-1", "url": "https://example.com/item-1", "username": "Stylish Shoreditch Loft with Balcony" }, "success": true, "comments": [ { "id": "id-1", "url": "https://example.com/item-1", "text": "Sample text 1", "like_count": 1, "likes_text": "Sample likes_text 1", "reply_count": 1, "author_username": "Stylish Shoreditch Loft with Balcony", "created_at_text": "2026-06-14T15:30:00Z", "author_display_name": "Stylish Shoreditch Loft with Balcony" } ], "pagination": { "count": 1, "cursor": "cursor-page-1", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_comments_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "video", "comments", "count", "max_comments_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "video": { "type": "object", "required": [ "id", "url", "username" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "author_username", "author_display_name", "text", "created_at_text", "likes_text", "like_count", "reply_count", "url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "type": "string" }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "likes_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reply_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_comments_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-comments", "task_name": "TikTok comments", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokCommentsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.tiktok.com/@tiktok/video/7641647587056962846", "maxLength": 2000, "minLength": 1, "description": "Full public TikTok video URL.", "x-placeholder": "e.g. https://www.tiktok.com/@tiktok/video/7641647587056962846" }, "limit": { "type": "integer", "default": 50, "maximum": 200, "minimum": 0, "x-sample": "50", "description": "Maximum number of public comments to collect from the rendered page. Preferred name; max_comments remains supported.", "x-placeholder": "e.g. 50" }, "cursor": { "type": "string", "x-sample": "30", "description": "Zero-based pagination cursor returned as next_cursor from the previous response.", "x-placeholder": "e.g. 30" }, "username": { "type": "string", "x-sample": "tiktok", "maxLength": 2000, "minLength": 1, "description": "TikTok username, with or without the leading @.", "x-placeholder": "e.g. tiktok" }, "video_id": { "type": "string", "x-sample": "7641647587056962846", "description": "TikTok numeric video id. Use with username when url is not provided.", "x-placeholder": "e.g. 7641647587056962846" }, "max_comments": { "type": "integer", "default": 50, "maximum": 200, "minimum": 0, "x-sample": "50", "x-advanced": true, "description": "Maximum number of public comments to collect from the rendered page. You can also use limit.", "x-placeholder": "e.g. 50" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "username", "video_id" ] } ] }, "example": { "url": "https://www.tiktok.com/@tiktok/video/7641647587056962846" } } } }, "x-browsable-website-login-required": true } }, "/v1/tiktok/comments": { "post": { "tags": [ "TikTok" ], "summary": "TikTok comments", "description": "Get comments for a TikTok video using a connected TikTok account. The current website requires sign-in to open comments; video and profile metadata remain available through the public endpoints.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "video", "comments", "count", "max_comments_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "video": { "type": "object", "required": [ "id", "url", "username" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "author_username", "author_display_name", "text", "created_at_text", "likes_text", "like_count", "reply_count", "url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "type": "string" }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "likes_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reply_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_comments_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-comments", "task_name": "TikTok comments", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "video": { "id": "id-1", "url": "https://example.com/item-1", "username": "Stylish Shoreditch Loft with Balcony" }, "success": true, "comments": [ { "id": "id-1", "url": "https://example.com/item-1", "text": "Sample text 1", "like_count": 1, "likes_text": "Sample likes_text 1", "reply_count": 1, "author_username": "Stylish Shoreditch Loft with Balcony", "created_at_text": "2026-06-14T15:30:00Z", "author_display_name": "Stylish Shoreditch Loft with Balcony" } ], "pagination": { "count": 1, "cursor": "cursor-page-1", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_comments_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "video", "comments", "count", "max_comments_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "video": { "type": "object", "required": [ "id", "url", "username" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "author_username", "author_display_name", "text", "created_at_text", "likes_text", "like_count", "reply_count", "url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "type": "string" }, "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "likes_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reply_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_comments_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-comments", "task_name": "TikTok comments", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokCommentsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.tiktok.com/@tiktok/video/7641647587056962846", "maxLength": 2000, "minLength": 1, "description": "Full public TikTok video URL.", "x-placeholder": "e.g. https://www.tiktok.com/@tiktok/video/7641647587056962846" }, "limit": { "type": "integer", "default": 50, "maximum": 200, "minimum": 0, "x-sample": "50", "description": "Maximum number of public comments to collect from the rendered page. Preferred name; max_comments remains supported.", "x-placeholder": "e.g. 50" }, "cursor": { "type": "string", "x-sample": "30", "description": "Zero-based pagination cursor returned as next_cursor from the previous response.", "x-placeholder": "e.g. 30" }, "username": { "type": "string", "x-sample": "tiktok", "maxLength": 2000, "minLength": 1, "description": "TikTok username, with or without the leading @.", "x-placeholder": "e.g. tiktok" }, "video_id": { "type": "string", "x-sample": "7641647587056962846", "description": "TikTok numeric video id. Use with username when url is not provided.", "x-placeholder": "e.g. 7641647587056962846" }, "max_comments": { "type": "integer", "default": 50, "maximum": 200, "minimum": 0, "x-sample": "50", "x-advanced": true, "description": "Maximum number of public comments to collect from the rendered page. You can also use limit.", "x-placeholder": "e.g. 50" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "username", "video_id" ] } ] }, "example": { "url": "https://www.tiktok.com/@tiktok/video/7641647587056962846" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-tiktok-comments" }, "x-browsable-website-login-required": true } }, "/v1/tasks/tiktok-follower-count/runs": { "post": { "tags": [ "TikTok" ], "summary": "TikTok Follower Count", "description": "Get public follower counts and profile statistics for a TikTok username. Individual follower identities are not returned.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-follower-count", "task_name": "TikTok Follower Count", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-follower-count", "task_name": "TikTok Follower Count", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokFollowerCountCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "x-advanced": true, "description": "Compatibility result cap; this endpoint returns profile statistics rather than a list of followers." }, "username": { "type": "string", "x-sample": "natgeo", "maxLength": 2000, "minLength": 1, "description": "TikTok username.", "x-placeholder": "e.g. natgeo" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "natgeo" } } } }, "x-browsable-website-login-required": false } }, "/v1/tiktok/follower-count": { "post": { "tags": [ "TikTok" ], "summary": "TikTok Follower Count", "description": "Get public follower counts and profile statistics for a TikTok username. Individual follower identities are not returned.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-follower-count", "task_name": "TikTok Follower Count", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-follower-count", "task_name": "TikTok Follower Count", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokFollowerCountAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "x-advanced": true, "description": "Compatibility result cap; this endpoint returns profile statistics rather than a list of followers." }, "username": { "type": "string", "x-sample": "natgeo", "maxLength": 2000, "minLength": 1, "description": "TikTok username.", "x-placeholder": "e.g. natgeo" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "natgeo" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-tiktok-follower-count" }, "x-browsable-website-login-required": false } }, "/v1/tasks/tiktok-hashtag/runs": { "post": { "tags": [ "TikTok" ], "summary": "TikTok hashtag", "description": "Fetch public hashtag metadata and a paginated slice of rendered public videos for a TikTok hashtag.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "hashtag", "videos", "count", "max_videos_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "hashtag": { "type": "object", "required": [ "name", "title", "post_count_text", "post_count", "url" ], "properties": { "url": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "post_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "post_count_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_videos_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-hashtag", "task_name": "TikTok hashtag", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "videos": [ { "id": "id-1", "url": "https://example.com/item-1", "caption": "sample", "hashtags": [ "Featured" ], "view_count": 1, "views_text": "Sample views_text 1", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "author_username": "Stylish Shoreditch Loft with Balcony", "author_display_name": "Stylish Shoreditch Loft with Balcony" } ], "hashtag": { "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "title": "Stylish Shoreditch Loft with Balcony", "post_count": 1, "post_count_text": "Sample post_count_text 1" }, "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_videos_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "hashtag", "videos", "count", "max_videos_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "hashtag": { "type": "object", "required": [ "name", "title", "post_count_text", "post_count", "url" ], "properties": { "url": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "post_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "post_count_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_videos_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-hashtag", "task_name": "TikTok hashtag", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokHashtagCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "description": "Maximum number of public videos to collect from the rendered page. Preferred name; max_videos remains supported.", "x-placeholder": "e.g. 30" }, "cursor": { "type": "string", "x-sample": "30", "description": "Zero-based pagination cursor returned as next_cursor from the previous response.", "x-placeholder": "e.g. 30" }, "hashtag": { "type": "string", "x-sample": "tiktok", "maxLength": 2000, "minLength": 1, "description": "TikTok hashtag, with or without the leading #.", "x-placeholder": "e.g. tiktok" }, "max_videos": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "x-advanced": true, "description": "Maximum number of public videos to collect from the rendered page. You can also use limit.", "x-placeholder": "e.g. 30" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "hashtag" ] }, "example": { "hashtag": "tiktok" } } } }, "x-browsable-website-login-required": false } }, "/v1/tiktok/hashtag": { "post": { "tags": [ "TikTok" ], "summary": "TikTok hashtag", "description": "Fetch public hashtag metadata and a paginated slice of rendered public videos for a TikTok hashtag.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "hashtag", "videos", "count", "max_videos_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "hashtag": { "type": "object", "required": [ "name", "title", "post_count_text", "post_count", "url" ], "properties": { "url": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "post_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "post_count_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_videos_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-hashtag", "task_name": "TikTok hashtag", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "videos": [ { "id": "id-1", "url": "https://example.com/item-1", "caption": "sample", "hashtags": [ "Featured" ], "view_count": 1, "views_text": "Sample views_text 1", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "author_username": "Stylish Shoreditch Loft with Balcony", "author_display_name": "Stylish Shoreditch Loft with Balcony" } ], "hashtag": { "url": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "title": "Stylish Shoreditch Loft with Balcony", "post_count": 1, "post_count_text": "Sample post_count_text 1" }, "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_videos_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "hashtag", "videos", "count", "max_videos_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "hashtag": { "type": "object", "required": [ "name", "title", "post_count_text", "post_count", "url" ], "properties": { "url": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "post_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "post_count_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_videos_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-hashtag", "task_name": "TikTok hashtag", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokHashtagAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "description": "Maximum number of public videos to collect from the rendered page. Preferred name; max_videos remains supported.", "x-placeholder": "e.g. 30" }, "cursor": { "type": "string", "x-sample": "30", "description": "Zero-based pagination cursor returned as next_cursor from the previous response.", "x-placeholder": "e.g. 30" }, "hashtag": { "type": "string", "x-sample": "tiktok", "maxLength": 2000, "minLength": 1, "description": "TikTok hashtag, with or without the leading #.", "x-placeholder": "e.g. tiktok" }, "max_videos": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "x-advanced": true, "description": "Maximum number of public videos to collect from the rendered page. You can also use limit.", "x-placeholder": "e.g. 30" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "hashtag" ] }, "example": { "hashtag": "tiktok" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-tiktok-hashtag" }, "x-browsable-website-login-required": false } }, "/v1/tasks/tiktok-profile/runs": { "post": { "tags": [ "TikTok" ], "summary": "TikTok profile", "description": "Fetch public TikTok profile metadata and a paginated slice of recent public videos from a creator profile.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "videos", "count", "max_videos_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "profile": { "type": "object", "required": [ "id", "username", "display_name", "bio", "bio_link", "avatar_url", "avatar_url_hd", "verified", "private", "followers", "following", "likes", "video_count", "profile_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "private": { "type": "boolean" }, "bio_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "type": "string" }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "type": "string" }, "video_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatar_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_videos_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-profile", "task_name": "TikTok profile", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "videos": [ { "id": "id-1", "url": "https://example.com/item-1", "caption": "sample", "hashtags": [ "Featured" ], "view_count": 1, "views_text": "Sample views_text 1", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "author_username": "Stylish Shoreditch Loft with Balcony", "author_display_name": "Stylish Shoreditch Loft with Balcony" } ], "profile": { "id": "id-1", "bio": "sample", "likes": 1.5, "private": true, "bio_link": "https://example.com/item-1", "username": "Stylish Shoreditch Loft with Balcony", "verified": true, "followers": 1.5, "following": 1.5, "avatar_url": "https://images.example.com/avatar_url-1.jpg", "profile_url": "https://example.com/item-1", "video_count": 1, "display_name": "Stylish Shoreditch Loft with Balcony", "avatar_url_hd": "https://images.example.com/avatar_url_hd-1.jpg" }, "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_videos_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "videos", "count", "max_videos_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "profile": { "type": "object", "required": [ "id", "username", "display_name", "bio", "bio_link", "avatar_url", "avatar_url_hd", "verified", "private", "followers", "following", "likes", "video_count", "profile_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "private": { "type": "boolean" }, "bio_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "type": "string" }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "type": "string" }, "video_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatar_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_videos_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-profile", "task_name": "TikTok profile", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokProfileCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "description": "Maximum number of public videos to collect from the rendered page. Preferred name; max_videos remains supported.", "x-placeholder": "e.g. 30" }, "cursor": { "type": "string", "x-sample": "30", "description": "Zero-based pagination cursor returned as next_cursor from the previous response.", "x-placeholder": "e.g. 30" }, "username": { "type": "string", "x-sample": "tiktok", "maxLength": 2000, "minLength": 1, "description": "TikTok username, with or without the leading @.", "x-placeholder": "e.g. tiktok" }, "max_videos": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "x-advanced": true, "description": "Maximum number of public videos to collect from the rendered page. You can also use limit.", "x-placeholder": "e.g. 30" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "tiktok" } } } }, "x-browsable-website-login-required": false } }, "/v1/tiktok/profile": { "post": { "tags": [ "TikTok" ], "summary": "TikTok profile", "description": "Fetch public TikTok profile metadata and a paginated slice of recent public videos from a creator profile.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "videos", "count", "max_videos_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "profile": { "type": "object", "required": [ "id", "username", "display_name", "bio", "bio_link", "avatar_url", "avatar_url_hd", "verified", "private", "followers", "following", "likes", "video_count", "profile_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "private": { "type": "boolean" }, "bio_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "type": "string" }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "type": "string" }, "video_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatar_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_videos_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-profile", "task_name": "TikTok profile", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "videos": [ { "id": "id-1", "url": "https://example.com/item-1", "caption": "sample", "hashtags": [ "Featured" ], "view_count": 1, "views_text": "Sample views_text 1", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "author_username": "Stylish Shoreditch Loft with Balcony", "author_display_name": "Stylish Shoreditch Loft with Balcony" } ], "profile": { "id": "id-1", "bio": "sample", "likes": 1.5, "private": true, "bio_link": "https://example.com/item-1", "username": "Stylish Shoreditch Loft with Balcony", "verified": true, "followers": 1.5, "following": 1.5, "avatar_url": "https://images.example.com/avatar_url-1.jpg", "profile_url": "https://example.com/item-1", "video_count": 1, "display_name": "Stylish Shoreditch Loft with Balcony", "avatar_url_hd": "https://images.example.com/avatar_url_hd-1.jpg" }, "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_videos_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "videos", "count", "max_videos_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "profile": { "type": "object", "required": [ "id", "username", "display_name", "bio", "bio_link", "avatar_url", "avatar_url_hd", "verified", "private", "followers", "following", "likes", "video_count", "profile_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "private": { "type": "boolean" }, "bio_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "type": "string" }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "type": "string" }, "video_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatar_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_videos_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-profile", "task_name": "TikTok profile", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokProfileAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "description": "Maximum number of public videos to collect from the rendered page. Preferred name; max_videos remains supported.", "x-placeholder": "e.g. 30" }, "cursor": { "type": "string", "x-sample": "30", "description": "Zero-based pagination cursor returned as next_cursor from the previous response.", "x-placeholder": "e.g. 30" }, "username": { "type": "string", "x-sample": "tiktok", "maxLength": 2000, "minLength": 1, "description": "TikTok username, with or without the leading @.", "x-placeholder": "e.g. tiktok" }, "max_videos": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "x-advanced": true, "description": "Maximum number of public videos to collect from the rendered page. You can also use limit.", "x-placeholder": "e.g. 30" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "tiktok" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-tiktok-profile" }, "x-browsable-website-login-required": false } }, "/v1/tasks/tiktok-search/runs": { "post": { "tags": [ "TikTok" ], "summary": "TikTok search", "description": "Fetch a paginated slice of public rendered TikTok video search results for a query.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "search_type", "search_url", "results", "count", "max_results_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "type", "id", "sec_uid", "username", "display_name", "bio", "avatar_url", "verified", "followers", "likes", "profile_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "const": "user" }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sec_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "type": "string" }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "type": { "const": "video" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "search_url": { "type": "string" }, "search_type": { "enum": [ "users", "videos" ], "type": "string" }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-search", "task_name": "TikTok search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "query": "London", "results": [ { "id": "id-1", "bio": "sample", "type": "user", "likes": 1.5, "sec_uid": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "verified": true, "followers": 1.5, "avatar_url": "https://images.example.com/avatar_url-1.jpg", "profile_url": "https://example.com/item-1", "display_name": "Stylish Shoreditch Loft with Balcony" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "next_cursor": "cursor-page-1", "has_next_page": true }, "search_url": "https://example.com/item-1", "search_type": "users", "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "search_type", "search_url", "results", "count", "max_results_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "type", "id", "sec_uid", "username", "display_name", "bio", "avatar_url", "verified", "followers", "likes", "profile_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "const": "user" }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sec_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "type": "string" }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "type": { "const": "video" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "search_url": { "type": "string" }, "search_type": { "enum": [ "users", "videos" ], "type": "string" }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-search", "task_name": "TikTok search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "description": "Maximum number of public search results to collect. Preferred name; max_results remains supported.", "x-placeholder": "e.g. 30" }, "query": { "type": "string", "x-sample": "dance", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. dance" }, "cursor": { "type": "string", "x-sample": "30", "description": "Zero-based pagination cursor returned as next_cursor from the previous response.", "x-placeholder": "e.g. 30" }, "max_results": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "x-advanced": true, "description": "Maximum number of public search results to collect. You can also use limit.", "x-placeholder": "e.g. 30" }, "search_type": { "enum": [ "users", "videos" ], "type": "string", "default": "users", "x-sample": "users", "description": "Search result type. Public unauthenticated TikTok search is most reliable for users; videos may require managed auth.", "x-placeholder": "e.g. users" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "dance" } } } }, "x-browsable-website-login-required": false } }, "/v1/tiktok/search": { "post": { "tags": [ "TikTok" ], "summary": "TikTok search", "description": "Fetch a paginated slice of public rendered TikTok video search results for a query.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "search_type", "search_url", "results", "count", "max_results_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "type", "id", "sec_uid", "username", "display_name", "bio", "avatar_url", "verified", "followers", "likes", "profile_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "const": "user" }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sec_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "type": "string" }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "type": { "const": "video" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "search_url": { "type": "string" }, "search_type": { "enum": [ "users", "videos" ], "type": "string" }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-search", "task_name": "TikTok search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "query": "London", "results": [ { "id": "id-1", "bio": "sample", "type": "user", "likes": 1.5, "sec_uid": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "verified": true, "followers": 1.5, "avatar_url": "https://images.example.com/avatar_url-1.jpg", "profile_url": "https://example.com/item-1", "display_name": "Stylish Shoreditch Loft with Balcony" } ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "next_cursor": "cursor-page-1", "has_next_page": true }, "search_url": "https://example.com/item-1", "search_type": "users", "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "search_type", "search_url", "results", "count", "max_results_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "oneOf": [ { "type": "object", "required": [ "type", "id", "sec_uid", "username", "display_name", "bio", "avatar_url", "verified", "followers", "likes", "profile_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "const": "user" }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sec_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "type": "string" }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "object", "required": [ "type", "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "type": { "const": "video" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } ] } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "search_url": { "type": "string" }, "search_type": { "enum": [ "users", "videos" ], "type": "string" }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-search", "task_name": "TikTok search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "description": "Maximum number of public search results to collect. Preferred name; max_results remains supported.", "x-placeholder": "e.g. 30" }, "query": { "type": "string", "x-sample": "dance", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. dance" }, "cursor": { "type": "string", "x-sample": "30", "description": "Zero-based pagination cursor returned as next_cursor from the previous response.", "x-placeholder": "e.g. 30" }, "max_results": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "x-advanced": true, "description": "Maximum number of public search results to collect. You can also use limit.", "x-placeholder": "e.g. 30" }, "search_type": { "enum": [ "users", "videos" ], "type": "string", "default": "users", "x-sample": "users", "description": "Search result type. Public unauthenticated TikTok search is most reliable for users; videos may require managed auth.", "x-placeholder": "e.g. users" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "dance" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-tiktok-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/tiktok-video/runs": { "post": { "tags": [ "TikTok" ], "summary": "TikTok video", "description": "Fetch public metadata, stats, media, music, hashtags, and author data for a TikTok video.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "video" ], "properties": { "video": { "type": "object", "required": [ "id", "url", "description", "created_at", "create_time", "duration", "region", "author", "stats", "music", "hashtags", "mentions", "media", "subtitles" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "media": { "type": "object", "required": [ "cover_url", "dynamic_cover_url", "origin_cover_url", "play_url", "download_url", "width", "height", "duration", "format", "ratio", "definition" ], "properties": { "ratio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "play_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "definition": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "download_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dynamic_cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "music": { "type": "object", "required": [ "id", "title", "author_name", "duration", "original", "play_url", "cover_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "original": { "type": "boolean" }, "play_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "stats": { "type": "object", "required": [ "play_count", "like_count", "comment_count", "share_count", "collect_count", "repost_count" ], "properties": { "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "play_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "share_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "repost_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "collect_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "author": { "type": "object", "required": [ "id", "username", "display_name", "verified", "avatar_url", "profile_url", "followers", "following", "likes", "video_count" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "video_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "object", "required": [ "id", "title" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "mentions": { "type": "array", "items": { "type": "object", "required": [ "username", "user_id", "sec_uid" ], "properties": { "sec_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "subtitles": { "type": "array", "items": { "type": "object", "required": [ "language", "language_code", "url", "format", "source" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "create_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-video", "task_name": "TikTok video", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "video": { "id": "id-1", "url": "https://example.com/item-1", "media": { "ratio": "sample", "width": 1.5, "format": "sample", "height": 1.5, "duration": 1.5, "play_url": "https://example.com/item-1", "cover_url": "https://example.com/item-1", "definition": "sample", "download_url": "https://example.com/item-1", "origin_cover_url": "https://example.com/item-1", "dynamic_cover_url": "https://example.com/item-1" }, "music": { "id": "id-1", "title": "Stylish Shoreditch Loft with Balcony", "duration": 1.5, "original": true, "play_url": "https://example.com/item-1", "cover_url": "https://example.com/item-1", "author_name": "Stylish Shoreditch Loft with Balcony" }, "stats": { "like_count": 1, "play_count": 1, "share_count": 1, "repost_count": 1, "collect_count": 1, "comment_count": 1 }, "author": { "id": "id-1", "likes": 1.5, "username": "Stylish Shoreditch Loft with Balcony", "verified": true, "followers": 1.5, "following": 1.5, "avatar_url": "https://images.example.com/avatar_url-1.jpg", "profile_url": "https://example.com/item-1", "video_count": 1, "display_name": "Stylish Shoreditch Loft with Balcony" }, "region": "London", "duration": 1.5, "hashtags": [ { "id": "id-1", "title": "Stylish Shoreditch Loft with Balcony" } ], "mentions": [ { "sec_uid": "id-1", "user_id": "user_1", "username": "Stylish Shoreditch Loft with Balcony" } ], "subtitles": [ { "url": "https://example.com/item-1", "format": "sample", "source": "sample", "language": "sample", "language_code": "sample" } ], "created_at": "2026-06-14T15:30:00Z", "create_time": 1.5, "description": "Sample description 1" }, "success": true }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "video" ], "properties": { "video": { "type": "object", "required": [ "id", "url", "description", "created_at", "create_time", "duration", "region", "author", "stats", "music", "hashtags", "mentions", "media", "subtitles" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "media": { "type": "object", "required": [ "cover_url", "dynamic_cover_url", "origin_cover_url", "play_url", "download_url", "width", "height", "duration", "format", "ratio", "definition" ], "properties": { "ratio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "play_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "definition": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "download_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dynamic_cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "music": { "type": "object", "required": [ "id", "title", "author_name", "duration", "original", "play_url", "cover_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "original": { "type": "boolean" }, "play_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "stats": { "type": "object", "required": [ "play_count", "like_count", "comment_count", "share_count", "collect_count", "repost_count" ], "properties": { "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "play_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "share_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "repost_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "collect_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "author": { "type": "object", "required": [ "id", "username", "display_name", "verified", "avatar_url", "profile_url", "followers", "following", "likes", "video_count" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "video_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "object", "required": [ "id", "title" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "mentions": { "type": "array", "items": { "type": "object", "required": [ "username", "user_id", "sec_uid" ], "properties": { "sec_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "subtitles": { "type": "array", "items": { "type": "object", "required": [ "language", "language_code", "url", "format", "source" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "create_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-video", "task_name": "TikTok video", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokVideoCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.tiktok.com/@tiktok/video/7641647587056962846", "maxLength": 2000, "minLength": 1, "description": "Full public TikTok video URL.", "x-placeholder": "e.g. https://www.tiktok.com/@tiktok/video/7641647587056962846" }, "username": { "type": "string", "x-sample": "tiktok", "maxLength": 2000, "minLength": 1, "description": "TikTok username, with or without the leading @.", "x-placeholder": "e.g. tiktok" }, "video_id": { "type": "string", "x-sample": "7641647587056962846", "description": "TikTok numeric video id. Use with username when url is not provided.", "x-placeholder": "e.g. 7641647587056962846" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "username", "video_id" ] } ] }, "example": { "url": "https://www.tiktok.com/@tiktok/video/7641647587056962846" } } } }, "x-browsable-website-login-required": false } }, "/v1/tiktok/video": { "post": { "tags": [ "TikTok" ], "summary": "TikTok video", "description": "Fetch public metadata, stats, media, music, hashtags, and author data for a TikTok video.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "video" ], "properties": { "video": { "type": "object", "required": [ "id", "url", "description", "created_at", "create_time", "duration", "region", "author", "stats", "music", "hashtags", "mentions", "media", "subtitles" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "media": { "type": "object", "required": [ "cover_url", "dynamic_cover_url", "origin_cover_url", "play_url", "download_url", "width", "height", "duration", "format", "ratio", "definition" ], "properties": { "ratio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "play_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "definition": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "download_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dynamic_cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "music": { "type": "object", "required": [ "id", "title", "author_name", "duration", "original", "play_url", "cover_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "original": { "type": "boolean" }, "play_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "stats": { "type": "object", "required": [ "play_count", "like_count", "comment_count", "share_count", "collect_count", "repost_count" ], "properties": { "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "play_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "share_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "repost_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "collect_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "author": { "type": "object", "required": [ "id", "username", "display_name", "verified", "avatar_url", "profile_url", "followers", "following", "likes", "video_count" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "video_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "object", "required": [ "id", "title" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "mentions": { "type": "array", "items": { "type": "object", "required": [ "username", "user_id", "sec_uid" ], "properties": { "sec_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "subtitles": { "type": "array", "items": { "type": "object", "required": [ "language", "language_code", "url", "format", "source" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "create_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-video", "task_name": "TikTok video", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "video": { "id": "id-1", "url": "https://example.com/item-1", "media": { "ratio": "sample", "width": 1.5, "format": "sample", "height": 1.5, "duration": 1.5, "play_url": "https://example.com/item-1", "cover_url": "https://example.com/item-1", "definition": "sample", "download_url": "https://example.com/item-1", "origin_cover_url": "https://example.com/item-1", "dynamic_cover_url": "https://example.com/item-1" }, "music": { "id": "id-1", "title": "Stylish Shoreditch Loft with Balcony", "duration": 1.5, "original": true, "play_url": "https://example.com/item-1", "cover_url": "https://example.com/item-1", "author_name": "Stylish Shoreditch Loft with Balcony" }, "stats": { "like_count": 1, "play_count": 1, "share_count": 1, "repost_count": 1, "collect_count": 1, "comment_count": 1 }, "author": { "id": "id-1", "likes": 1.5, "username": "Stylish Shoreditch Loft with Balcony", "verified": true, "followers": 1.5, "following": 1.5, "avatar_url": "https://images.example.com/avatar_url-1.jpg", "profile_url": "https://example.com/item-1", "video_count": 1, "display_name": "Stylish Shoreditch Loft with Balcony" }, "region": "London", "duration": 1.5, "hashtags": [ { "id": "id-1", "title": "Stylish Shoreditch Loft with Balcony" } ], "mentions": [ { "sec_uid": "id-1", "user_id": "user_1", "username": "Stylish Shoreditch Loft with Balcony" } ], "subtitles": [ { "url": "https://example.com/item-1", "format": "sample", "source": "sample", "language": "sample", "language_code": "sample" } ], "created_at": "2026-06-14T15:30:00Z", "create_time": 1.5, "description": "Sample description 1" }, "success": true }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "video" ], "properties": { "video": { "type": "object", "required": [ "id", "url", "description", "created_at", "create_time", "duration", "region", "author", "stats", "music", "hashtags", "mentions", "media", "subtitles" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "media": { "type": "object", "required": [ "cover_url", "dynamic_cover_url", "origin_cover_url", "play_url", "download_url", "width", "height", "duration", "format", "ratio", "definition" ], "properties": { "ratio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "width": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "height": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "play_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "definition": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "download_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dynamic_cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "music": { "type": "object", "required": [ "id", "title", "author_name", "duration", "original", "play_url", "cover_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "original": { "type": "boolean" }, "play_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cover_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "stats": { "type": "object", "required": [ "play_count", "like_count", "comment_count", "share_count", "collect_count", "repost_count" ], "properties": { "like_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "play_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "share_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "repost_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "collect_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comment_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "author": { "type": "object", "required": [ "id", "username", "display_name", "verified", "avatar_url", "profile_url", "followers", "following", "likes", "video_count" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "video_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "duration": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "object", "required": [ "id", "title" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "mentions": { "type": "array", "items": { "type": "object", "required": [ "username", "user_id", "sec_uid" ], "properties": { "sec_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "subtitles": { "type": "array", "items": { "type": "object", "required": [ "language", "language_code", "url", "format", "source" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "create_time": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-video", "task_name": "TikTok video", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokVideoAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.tiktok.com/@tiktok/video/7641647587056962846", "maxLength": 2000, "minLength": 1, "description": "Full public TikTok video URL.", "x-placeholder": "e.g. https://www.tiktok.com/@tiktok/video/7641647587056962846" }, "username": { "type": "string", "x-sample": "tiktok", "maxLength": 2000, "minLength": 1, "description": "TikTok username, with or without the leading @.", "x-placeholder": "e.g. tiktok" }, "video_id": { "type": "string", "x-sample": "7641647587056962846", "description": "TikTok numeric video id. Use with username when url is not provided.", "x-placeholder": "e.g. 7641647587056962846" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "username", "video_id" ] } ] }, "example": { "url": "https://www.tiktok.com/@tiktok/video/7641647587056962846" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-tiktok-video" }, "x-browsable-website-login-required": false } }, "/v1/tasks/tiktok-videos/runs": { "post": { "tags": [ "TikTok" ], "summary": "TikTok videos", "description": "Fetch a paginated slice of public videos from a TikTok creator profile.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "username", "profile", "videos", "count", "max_videos_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "profile": { "type": "object", "required": [ "id", "username", "display_name", "bio", "bio_link", "avatar_url", "avatar_url_hd", "verified", "private", "followers", "following", "likes", "video_count", "profile_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "private": { "type": "boolean" }, "bio_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "type": "string" }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "type": "string" }, "video_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatar_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "username": { "type": "string" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_videos_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-videos", "task_name": "TikTok videos", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "videos": [ { "id": "id-1", "url": "https://example.com/item-1", "caption": "sample", "hashtags": [ "Featured" ], "view_count": 1, "views_text": "Sample views_text 1", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "author_username": "Stylish Shoreditch Loft with Balcony", "author_display_name": "Stylish Shoreditch Loft with Balcony" } ], "profile": { "id": "id-1", "bio": "sample", "likes": 1.5, "private": true, "bio_link": "https://example.com/item-1", "username": "Stylish Shoreditch Loft with Balcony", "verified": true, "followers": 1.5, "following": 1.5, "avatar_url": "https://images.example.com/avatar_url-1.jpg", "profile_url": "https://example.com/item-1", "video_count": 1, "display_name": "Stylish Shoreditch Loft with Balcony", "avatar_url_hd": "https://images.example.com/avatar_url_hd-1.jpg" }, "success": true, "username": "Stylish Shoreditch Loft with Balcony", "pagination": { "count": 1, "cursor": "cursor-page-1", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_videos_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "username", "profile", "videos", "count", "max_videos_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "profile": { "type": "object", "required": [ "id", "username", "display_name", "bio", "bio_link", "avatar_url", "avatar_url_hd", "verified", "private", "followers", "following", "likes", "video_count", "profile_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "private": { "type": "boolean" }, "bio_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "type": "string" }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "type": "string" }, "video_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatar_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "username": { "type": "string" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_videos_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-videos", "task_name": "TikTok videos", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokVideosCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "description": "Maximum number of public videos to collect from the rendered page. Preferred name; max_videos remains supported.", "x-placeholder": "e.g. 30" }, "cursor": { "type": "string", "x-sample": "30", "description": "Zero-based pagination cursor returned as next_cursor from the previous response.", "x-placeholder": "e.g. 30" }, "username": { "type": "string", "x-sample": "tiktok", "maxLength": 2000, "minLength": 1, "description": "TikTok username, with or without the leading @.", "x-placeholder": "e.g. tiktok" }, "max_videos": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "x-advanced": true, "description": "Maximum number of public videos to collect from the rendered page. You can also use limit.", "x-placeholder": "e.g. 30" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "tiktok" } } } }, "x-browsable-website-login-required": false } }, "/v1/tiktok/videos": { "post": { "tags": [ "TikTok" ], "summary": "TikTok videos", "description": "Fetch a paginated slice of public videos from a TikTok creator profile.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "username", "profile", "videos", "count", "max_videos_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "profile": { "type": "object", "required": [ "id", "username", "display_name", "bio", "bio_link", "avatar_url", "avatar_url_hd", "verified", "private", "followers", "following", "likes", "video_count", "profile_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "private": { "type": "boolean" }, "bio_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "type": "string" }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "type": "string" }, "video_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatar_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "username": { "type": "string" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_videos_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-videos", "task_name": "TikTok videos", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "videos": [ { "id": "id-1", "url": "https://example.com/item-1", "caption": "sample", "hashtags": [ "Featured" ], "view_count": 1, "views_text": "Sample views_text 1", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "author_username": "Stylish Shoreditch Loft with Balcony", "author_display_name": "Stylish Shoreditch Loft with Balcony" } ], "profile": { "id": "id-1", "bio": "sample", "likes": 1.5, "private": true, "bio_link": "https://example.com/item-1", "username": "Stylish Shoreditch Loft with Balcony", "verified": true, "followers": 1.5, "following": 1.5, "avatar_url": "https://images.example.com/avatar_url-1.jpg", "profile_url": "https://example.com/item-1", "video_count": 1, "display_name": "Stylish Shoreditch Loft with Balcony", "avatar_url_hd": "https://images.example.com/avatar_url_hd-1.jpg" }, "success": true, "username": "Stylish Shoreditch Loft with Balcony", "pagination": { "count": 1, "cursor": "cursor-page-1", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_videos_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "username", "profile", "videos", "count", "max_videos_requested", "pagination" ], "properties": { "count": { "type": "integer" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "url", "caption", "thumbnail_url", "views_text", "view_count", "author_username", "author_display_name", "hashtags" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "caption": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "hashtags": { "type": "array", "items": { "type": "string" } }, "view_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "views_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "profile": { "type": "object", "required": [ "id", "username", "display_name", "bio", "bio_link", "avatar_url", "avatar_url_hd", "verified", "private", "followers", "following", "likes", "video_count", "profile_url" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "bio": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "likes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "private": { "type": "boolean" }, "bio_link": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "username": { "type": "string" }, "verified": { "type": "boolean" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "profile_url": { "type": "string" }, "video_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "avatar_url_hd": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "username": { "type": "string" }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_videos_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tiktok-videos", "task_name": "TikTok videos", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTiktokVideosAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "description": "Maximum number of public videos to collect from the rendered page. Preferred name; max_videos remains supported.", "x-placeholder": "e.g. 30" }, "cursor": { "type": "string", "x-sample": "30", "description": "Zero-based pagination cursor returned as next_cursor from the previous response.", "x-placeholder": "e.g. 30" }, "username": { "type": "string", "x-sample": "tiktok", "maxLength": 2000, "minLength": 1, "description": "TikTok username, with or without the leading @.", "x-placeholder": "e.g. tiktok" }, "max_videos": { "type": "integer", "default": 30, "maximum": 100, "minimum": 0, "x-sample": "30", "x-advanced": true, "description": "Maximum number of public videos to collect from the rendered page. You can also use limit.", "x-placeholder": "e.g. 30" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "username" ] }, "example": { "username": "tiktok" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-tiktok-videos" }, "x-browsable-website-login-required": false } }, "/v1/tasks/tripadvisor-detail/runs": { "post": { "tags": [ "Tripadvisor" ], "summary": "Tripadvisor Detail API", "description": "Scrape a public Tripadvisor hotel, restaurant, or attraction page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tripadvisor-detail", "task_name": "Tripadvisor Detail API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tripadvisor-detail", "task_name": "Tripadvisor Detail API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTripadvisorDetailCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.tripadvisor.com/Restaurant_Review-example.html" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.tripadvisor.com/Restaurant_Review-example.html" } } } }, "x-browsable-website-login-required": false } }, "/v1/tripadvisor/detail": { "post": { "tags": [ "Tripadvisor" ], "summary": "Tripadvisor Detail API", "description": "Scrape a public Tripadvisor hotel, restaurant, or attraction page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tripadvisor-detail", "task_name": "Tripadvisor Detail API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tripadvisor-detail", "task_name": "Tripadvisor Detail API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTripadvisorDetailAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.tripadvisor.com/Restaurant_Review-example.html" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.tripadvisor.com/Restaurant_Review-example.html" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-tripadvisor-detail" }, "x-browsable-website-login-required": false } }, "/v1/tasks/tripadvisor-search/runs": { "post": { "tags": [ "Tripadvisor" ], "summary": "Tripadvisor API", "description": "Scrape public Tripadvisor search results for hotels, restaurants, and attractions.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tripadvisor-search", "task_name": "Tripadvisor API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tripadvisor-search", "task_name": "Tripadvisor API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTripadvisorSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Rome restaurants", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Rome restaurants" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Rome restaurants" } } } }, "x-browsable-website-login-required": false } }, "/v1/tripadvisor/search": { "post": { "tags": [ "Tripadvisor" ], "summary": "Tripadvisor API", "description": "Scrape public Tripadvisor search results for hotels, restaurants, and attractions.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tripadvisor-search", "task_name": "Tripadvisor API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "tripadvisor-search", "task_name": "Tripadvisor API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTripadvisorSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Rome restaurants", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Rome restaurants" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Rome restaurants" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-tripadvisor-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/trustpilot-company/runs": { "post": { "tags": [ "Trustpilot" ], "summary": "Trustpilot Company API", "description": "Scrape a public Trustpilot company review page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "trustpilot-company", "task_name": "Trustpilot Company API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "trustpilot-company", "task_name": "Trustpilot Company API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTrustpilotCompanyCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.trustpilot.com/review/www.example.com" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.trustpilot.com/review/www.example.com" } } } }, "x-browsable-website-login-required": false } }, "/v1/trustpilot/company": { "post": { "tags": [ "Trustpilot" ], "summary": "Trustpilot Company API", "description": "Scrape a public Trustpilot company review page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "trustpilot-company", "task_name": "Trustpilot Company API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "trustpilot-company", "task_name": "Trustpilot Company API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTrustpilotCompanyAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.trustpilot.com/review/www.example.com" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.trustpilot.com/review/www.example.com" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-trustpilot-company" }, "x-browsable-website-login-required": false } }, "/v1/tasks/trustpilot-search/runs": { "post": { "tags": [ "Trustpilot" ], "summary": "Trustpilot API", "description": "Scrape public Trustpilot company search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "trustpilot-search", "task_name": "Trustpilot API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "trustpilot-search", "task_name": "Trustpilot API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTrustpilotSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "monzo", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. monzo" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "monzo" } } } }, "x-browsable-website-login-required": false } }, "/v1/trustpilot/search": { "post": { "tags": [ "Trustpilot" ], "summary": "Trustpilot API", "description": "Scrape public Trustpilot company search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "trustpilot-search", "task_name": "Trustpilot API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "trustpilot-search", "task_name": "Trustpilot API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTrustpilotSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "monzo", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. monzo" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "monzo" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-trustpilot-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/twitch-channel/runs": { "post": { "tags": [ "Twitch" ], "summary": "Twitch Channel API", "description": "Scrape a public Twitch channel page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "twitch-channel", "task_name": "Twitch Channel API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "twitch-channel", "task_name": "Twitch Channel API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTwitchChannelCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.twitch.tv/chess" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.twitch.tv/chess" } } } }, "x-browsable-website-login-required": false } }, "/v1/twitch/channel": { "post": { "tags": [ "Twitch" ], "summary": "Twitch Channel API", "description": "Scrape a public Twitch channel page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "twitch-channel", "task_name": "Twitch Channel API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "twitch-channel", "task_name": "Twitch Channel API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTwitchChannelAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.twitch.tv/chess" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.twitch.tv/chess" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-twitch-channel" }, "x-browsable-website-login-required": false } }, "/v1/tasks/twitch-search/runs": { "post": { "tags": [ "Twitch" ], "summary": "Twitch API", "description": "Scrape public Twitch search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "twitch-search", "task_name": "Twitch API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "twitch-search", "task_name": "Twitch API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTwitchSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "chess", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. chess" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "chess" } } } }, "x-browsable-website-login-required": false } }, "/v1/twitch/search": { "post": { "tags": [ "Twitch" ], "summary": "Twitch API", "description": "Scrape public Twitch search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "twitch-search", "task_name": "Twitch API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "twitch-search", "task_name": "Twitch API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runTwitchSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "chess", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. chess" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "chess" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-twitch-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/vimeo-search/runs": { "post": { "tags": [ "Vimeo" ], "summary": "Vimeo API", "description": "Scrape public Vimeo video search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vimeo-search", "task_name": "Vimeo API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vimeo-search", "task_name": "Vimeo API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVimeoSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "short film", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. short film" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "short film" } } } }, "x-browsable-website-login-required": false } }, "/v1/vimeo/search": { "post": { "tags": [ "Vimeo" ], "summary": "Vimeo API", "description": "Scrape public Vimeo video search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vimeo-search", "task_name": "Vimeo API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vimeo-search", "task_name": "Vimeo API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVimeoSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "short film", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. short film" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "short film" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-vimeo-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/vimeo-video/runs": { "post": { "tags": [ "Vimeo" ], "summary": "Vimeo Video API", "description": "Scrape a public Vimeo video page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vimeo-video", "task_name": "Vimeo Video API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vimeo-video", "task_name": "Vimeo Video API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVimeoVideoCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://vimeo.com/123456789" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://vimeo.com/123456789" } } } }, "x-browsable-website-login-required": false } }, "/v1/vimeo/video": { "post": { "tags": [ "Vimeo" ], "summary": "Vimeo Video API", "description": "Scrape a public Vimeo video page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vimeo-video", "task_name": "Vimeo Video API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vimeo-video", "task_name": "Vimeo Video API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVimeoVideoAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://vimeo.com/123456789" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://vimeo.com/123456789" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-vimeo-video" }, "x-browsable-website-login-required": false } }, "/v1/tasks/vinted-brand/runs": { "post": { "tags": [ "Vinted" ], "summary": "Vinted Brand Feed API", "description": "Scrape public Vinted catalog results for a brand.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-brand", "task_name": "Vinted Brand Feed API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-brand", "task_name": "Vinted Brand Feed API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVintedBrandCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "brand": { "type": "string", "x-sample": "Patagonia", "description": "Brand name.", "x-placeholder": "e.g. Patagonia" }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "brand" ] }, "example": { "brand": "Patagonia" } } } }, "x-browsable-website-login-required": false } }, "/v1/vinted/brand": { "post": { "tags": [ "Vinted" ], "summary": "Vinted Brand Feed API", "description": "Scrape public Vinted catalog results for a brand.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-brand", "task_name": "Vinted Brand Feed API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-brand", "task_name": "Vinted Brand Feed API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVintedBrandAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "brand": { "type": "string", "x-sample": "Patagonia", "description": "Brand name.", "x-placeholder": "e.g. Patagonia" }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "brand" ] }, "example": { "brand": "Patagonia" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-vinted-brand" }, "x-browsable-website-login-required": false } }, "/v1/tasks/vinted-item/runs": { "post": { "tags": [ "Vinted" ], "summary": "Vinted item", "description": "Fetch a Vinted item page and return normalized item details plus similar items from the same page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "item_id", "item_url", "price", "price_including_buyer_protection", "service_fee", "shipping_price", "image_urls", "attributes", "similar_items" ], "properties": { "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "is_sold": { "type": "boolean" }, "item_id": { "type": "string" }, "success": { "type": "boolean" }, "item_url": { "type": "string" }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "is_hidden": { "type": "boolean" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false } }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "updated_at": { "type": "string" }, "description": { "type": "string" }, "is_reserved": { "type": "boolean" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "similar_items": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "thumbnail_url": { "type": "string" }, "shipping_price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-item", "task_name": "Vinted item", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "size": "sample", "brand": "sample", "color": "sample", "likes": 1.5, "price": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "title": "Stylish Shoreditch Loft with Balcony", "views": 1.5, "seller": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "is_business": true, "profile_url": "https://example.com/item-1", "feedback_count": 1, "feedback_reputation": 1.5 }, "is_sold": true, "item_id": "id-1", "success": true, "item_url": "https://example.com/item-1", "location": "London", "material": "sample", "promoted": true, "condition": "sample", "is_hidden": true, "attributes": [ { "code": "sample", "label": "Stylish Shoreditch Loft with Balcony", "value": "180" } ], "catalog_id": "id-1", "created_at": "2026-06-14T15:30:00Z", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "updated_at": "2026-06-14T15:30:00Z", "description": "Sample description 1", "is_reserved": true, "service_fee": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "is_favourite": true, "similar_items": [ { "id": "id-1", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "page": 1, "size": "sample", "brand": "sample", "color": "sample", "likes": 1.5, "price": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "views": 1.5, "seller": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "is_business": true, "profile_url": "https://example.com/item-1", "feedback_count": 1, "feedback_reputation": 1.5 }, "location": "London", "material": "sample", "promoted": true, "condition": "sample", "catalog_id": "id-1", "created_at": "2026-06-14T15:30:00Z", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "service_fee": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "is_favourite": true, "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "price_including_buyer_protection": { "amount": "180", "currency": "USD", "amount_numeric": 180 } } ], "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "shipping_price": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "price_including_buyer_protection": { "amount": "180", "currency": "USD", "amount_numeric": 180 } }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "item_id", "item_url", "price", "price_including_buyer_protection", "service_fee", "shipping_price", "image_urls", "attributes", "similar_items" ], "properties": { "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "is_sold": { "type": "boolean" }, "item_id": { "type": "string" }, "success": { "type": "boolean" }, "item_url": { "type": "string" }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "is_hidden": { "type": "boolean" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false } }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "updated_at": { "type": "string" }, "description": { "type": "string" }, "is_reserved": { "type": "boolean" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "similar_items": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "thumbnail_url": { "type": "string" }, "shipping_price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-item", "task_name": "Vinted item", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVintedItemCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Vinted item URL (e.g. https://www.vinted.co.uk/items/8289132552-foo). Preferred name; item_url remains supported." }, "domain": { "type": "string", "default": "vinted.co.uk", "description": "Optional Vinted domain/origin (e.g. vinted.de, www.vinted.fr, or https://www.vinted.co.uk). Used when item_id is provided or to override the default UK domain." }, "item_id": { "type": "string", "description": "Numeric Vinted item ID. When used without item_url, the scraper defaults to vinted.co.uk unless domain is provided." }, "item_url": { "type": "string", "x-advanced": true, "description": "Vinted item URL (e.g. https://www.vinted.co.uk/items/8289132552-foo). You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "x-browsable-website-login-required": false } }, "/v1/vinted/item": { "post": { "tags": [ "Vinted" ], "summary": "Vinted item", "description": "Fetch a Vinted item page and return normalized item details plus similar items from the same page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "item_id", "item_url", "price", "price_including_buyer_protection", "service_fee", "shipping_price", "image_urls", "attributes", "similar_items" ], "properties": { "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "is_sold": { "type": "boolean" }, "item_id": { "type": "string" }, "success": { "type": "boolean" }, "item_url": { "type": "string" }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "is_hidden": { "type": "boolean" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false } }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "updated_at": { "type": "string" }, "description": { "type": "string" }, "is_reserved": { "type": "boolean" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "similar_items": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "thumbnail_url": { "type": "string" }, "shipping_price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-item", "task_name": "Vinted item", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "size": "sample", "brand": "sample", "color": "sample", "likes": 1.5, "price": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "title": "Stylish Shoreditch Loft with Balcony", "views": 1.5, "seller": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "is_business": true, "profile_url": "https://example.com/item-1", "feedback_count": 1, "feedback_reputation": 1.5 }, "is_sold": true, "item_id": "id-1", "success": true, "item_url": "https://example.com/item-1", "location": "London", "material": "sample", "promoted": true, "condition": "sample", "is_hidden": true, "attributes": [ { "code": "sample", "label": "Stylish Shoreditch Loft with Balcony", "value": "180" } ], "catalog_id": "id-1", "created_at": "2026-06-14T15:30:00Z", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "updated_at": "2026-06-14T15:30:00Z", "description": "Sample description 1", "is_reserved": true, "service_fee": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "is_favourite": true, "similar_items": [ { "id": "id-1", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "page": 1, "size": "sample", "brand": "sample", "color": "sample", "likes": 1.5, "price": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "views": 1.5, "seller": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "is_business": true, "profile_url": "https://example.com/item-1", "feedback_count": 1, "feedback_reputation": 1.5 }, "location": "London", "material": "sample", "promoted": true, "condition": "sample", "catalog_id": "id-1", "created_at": "2026-06-14T15:30:00Z", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "service_fee": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "is_favourite": true, "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "price_including_buyer_protection": { "amount": "180", "currency": "USD", "amount_numeric": 180 } } ], "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "shipping_price": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "price_including_buyer_protection": { "amount": "180", "currency": "USD", "amount_numeric": 180 } }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "item_id", "item_url", "price", "price_including_buyer_protection", "service_fee", "shipping_price", "image_urls", "attributes", "similar_items" ], "properties": { "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "is_sold": { "type": "boolean" }, "item_id": { "type": "string" }, "success": { "type": "boolean" }, "item_url": { "type": "string" }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "is_hidden": { "type": "boolean" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": false } }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "updated_at": { "type": "string" }, "description": { "type": "string" }, "is_reserved": { "type": "boolean" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "similar_items": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "thumbnail_url": { "type": "string" }, "shipping_price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-item", "task_name": "Vinted item", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVintedItemAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Vinted item URL (e.g. https://www.vinted.co.uk/items/8289132552-foo). Preferred name; item_url remains supported." }, "domain": { "type": "string", "default": "vinted.co.uk", "description": "Optional Vinted domain/origin (e.g. vinted.de, www.vinted.fr, or https://www.vinted.co.uk). Used when item_id is provided or to override the default UK domain." }, "item_id": { "type": "string", "description": "Numeric Vinted item ID. When used without item_url, the scraper defaults to vinted.co.uk unless domain is provided." }, "item_url": { "type": "string", "x-advanced": true, "description": "Vinted item URL (e.g. https://www.vinted.co.uk/items/8289132552-foo). You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-vinted-item" }, "x-browsable-website-login-required": false } }, "/v1/tasks/vinted-member-items/runs": { "post": { "tags": [ "Vinted" ], "summary": "Vinted member items", "description": "Fetch a Vinted member wardrobe feed with pagination and normalized item data.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "member_id", "member_url", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "member_id": { "type": "string" }, "member_url": { "type": "string" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-member-items", "task_name": "Vinted member items", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "results": [ { "id": "id-1", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "page": 1, "size": "sample", "brand": "sample", "color": "sample", "likes": 1.5, "price": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "views": 1.5, "seller": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "is_business": true, "profile_url": "https://example.com/item-1", "feedback_count": 1, "feedback_reputation": 1.5 }, "location": "London", "material": "sample", "promoted": true, "condition": "sample", "catalog_id": "id-1", "created_at": "2026-06-14T15:30:00Z", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "service_fee": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "is_favourite": true, "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "price_including_buyer_protection": { "amount": "180", "currency": "USD", "amount_numeric": 180 } } ], "success": true, "member_id": "id-1", "member_url": "https://example.com/item-1", "pagination": { "per_page": 1, "next_page": 1, "total_pages": 1, "current_page": 1, "has_next_page": true, "total_entries": 180 }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "member_id", "member_url", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "member_id": { "type": "string" }, "member_url": { "type": "string" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-member-items", "task_name": "Vinted member items", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVintedMemberItemsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Vinted member profile URL (e.g. https://www.vinted.co.uk/member/189338805 or https://www.vinted.fr/member/40333919). Preferred name; member_url remains supported." }, "limit": { "type": "integer", "default": 20, "maximum": 96, "minimum": 1, "description": "Items per page (default 20, max 96). Preferred name; per_page remains supported." }, "order": { "type": "string", "default": "relevance", "description": "Wardrobe sort order." }, "pages": { "type": "integer", "default": 1, "maximum": 50, "minimum": 1, "description": "Number of infinite-scroll pages to fetch (1-50)." }, "per_page": { "type": "integer", "default": 20, "maximum": 96, "minimum": 1, "x-advanced": true, "description": "Items per page (default 20, max 96). You can also use limit." }, "member_url": { "type": "string", "x-advanced": true, "description": "Vinted member profile URL (e.g. https://www.vinted.co.uk/member/189338805 or https://www.vinted.fr/member/40333919). You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "url" ] }, { "required": [ "member_url" ] } ] } ] }, "example": { "url": "https://example.com/item-1" } } } }, "x-browsable-website-login-required": false } }, "/v1/vinted/member/items": { "post": { "tags": [ "Vinted" ], "summary": "Vinted member items", "description": "Fetch a Vinted member wardrobe feed with pagination and normalized item data.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "member_id", "member_url", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "member_id": { "type": "string" }, "member_url": { "type": "string" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-member-items", "task_name": "Vinted member items", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "results": [ { "id": "id-1", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "page": 1, "size": "sample", "brand": "sample", "color": "sample", "likes": 1.5, "price": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "views": 1.5, "seller": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "is_business": true, "profile_url": "https://example.com/item-1", "feedback_count": 1, "feedback_reputation": 1.5 }, "location": "London", "material": "sample", "promoted": true, "condition": "sample", "catalog_id": "id-1", "created_at": "2026-06-14T15:30:00Z", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "service_fee": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "is_favourite": true, "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "price_including_buyer_protection": { "amount": "180", "currency": "USD", "amount_numeric": 180 } } ], "success": true, "member_id": "id-1", "member_url": "https://example.com/item-1", "pagination": { "per_page": 1, "next_page": 1, "total_pages": 1, "current_page": 1, "has_next_page": true, "total_entries": 180 }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "member_id", "member_url", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "member_id": { "type": "string" }, "member_url": { "type": "string" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-member-items", "task_name": "Vinted member items", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVintedMemberItemsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Vinted member profile URL (e.g. https://www.vinted.co.uk/member/189338805 or https://www.vinted.fr/member/40333919). Preferred name; member_url remains supported." }, "limit": { "type": "integer", "default": 20, "maximum": 96, "minimum": 1, "description": "Items per page (default 20, max 96). Preferred name; per_page remains supported." }, "order": { "type": "string", "default": "relevance", "description": "Wardrobe sort order." }, "pages": { "type": "integer", "default": 1, "maximum": 50, "minimum": 1, "description": "Number of infinite-scroll pages to fetch (1-50)." }, "per_page": { "type": "integer", "default": 20, "maximum": 96, "minimum": 1, "x-advanced": true, "description": "Items per page (default 20, max 96). You can also use limit." }, "member_url": { "type": "string", "x-advanced": true, "description": "Vinted member profile URL (e.g. https://www.vinted.co.uk/member/189338805 or https://www.vinted.fr/member/40333919). You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "url" ] }, { "required": [ "member_url" ] } ] } ] }, "example": { "url": "https://example.com/item-1" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-vinted-member-items" }, "x-browsable-website-login-required": false } }, "/v1/tasks/vinted-member-search/runs": { "post": { "tags": [ "Vinted" ], "summary": "Vinted member search", "description": "Search Vinted member profiles by username and return normalized member matches across multiple pages.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "member_id", "page", "profile_url" ], "properties": { "page": { "type": "number" }, "username": { "type": "string" }, "member_id": { "type": "string" }, "avatar_url": { "type": "string" }, "profile_url": { "type": "string" }, "review_count": { "type": "number" }, "rating_average": { "type": "number" }, "review_summary": { "type": "string" } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-member-search", "task_name": "Vinted member search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "query": "London", "results": [ { "page": 1, "username": "Stylish Shoreditch Loft with Balcony", "member_id": "id-1", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "profile_url": "https://example.com/item-1", "review_count": 1, "rating_average": 4.91, "review_summary": "Sample review_summary 1" } ], "success": true, "pagination": { "per_page": 1, "next_page": 1, "total_pages": 1, "current_page": 1, "has_next_page": true, "total_entries": 180 }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "member_id", "page", "profile_url" ], "properties": { "page": { "type": "number" }, "username": { "type": "string" }, "member_id": { "type": "string" }, "avatar_url": { "type": "string" }, "profile_url": { "type": "string" }, "review_count": { "type": "number" }, "rating_average": { "type": "number" }, "review_summary": { "type": "string" } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-member-search", "task_name": "Vinted member search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVintedMemberSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of result pages to fetch (1-20)." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Vinted member search term." }, "domain": { "type": "string", "default": "vinted.co.uk", "description": "Optional Vinted domain/origin (e.g. vinted.de, www.vinted.fr, or https://www.vinted.co.uk). Defaults to UK." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "x-browsable-website-login-required": false } }, "/v1/vinted/member/search": { "post": { "tags": [ "Vinted" ], "summary": "Vinted member search", "description": "Search Vinted member profiles by username and return normalized member matches across multiple pages.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "member_id", "page", "profile_url" ], "properties": { "page": { "type": "number" }, "username": { "type": "string" }, "member_id": { "type": "string" }, "avatar_url": { "type": "string" }, "profile_url": { "type": "string" }, "review_count": { "type": "number" }, "rating_average": { "type": "number" }, "review_summary": { "type": "string" } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-member-search", "task_name": "Vinted member search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "query": "London", "results": [ { "page": 1, "username": "Stylish Shoreditch Loft with Balcony", "member_id": "id-1", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "profile_url": "https://example.com/item-1", "review_count": 1, "rating_average": 4.91, "review_summary": "Sample review_summary 1" } ], "success": true, "pagination": { "per_page": 1, "next_page": 1, "total_pages": 1, "current_page": 1, "has_next_page": true, "total_entries": 180 }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "member_id", "page", "profile_url" ], "properties": { "page": { "type": "number" }, "username": { "type": "string" }, "member_id": { "type": "string" }, "avatar_url": { "type": "string" }, "profile_url": { "type": "string" }, "review_count": { "type": "number" }, "rating_average": { "type": "number" }, "review_summary": { "type": "string" } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-member-search", "task_name": "Vinted member search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVintedMemberSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of result pages to fetch (1-20)." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Vinted member search term." }, "domain": { "type": "string", "default": "vinted.co.uk", "description": "Optional Vinted domain/origin (e.g. vinted.de, www.vinted.fr, or https://www.vinted.co.uk). Defaults to UK." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-vinted-member-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/vinted-search/runs": { "post": { "tags": [ "Vinted" ], "summary": "Vinted search", "description": "Search Vinted listings by keyword and return normalized item data across multiple pages.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" }, "search_session_id": { "type": "string" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-search", "task_name": "Vinted search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "query": "London", "results": [ { "id": "id-1", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "page": 1, "size": "sample", "brand": "sample", "color": "sample", "likes": 1.5, "price": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "views": 1.5, "seller": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "is_business": true, "profile_url": "https://example.com/item-1", "feedback_count": 1, "feedback_reputation": 1.5 }, "location": "London", "material": "sample", "promoted": true, "condition": "sample", "catalog_id": "id-1", "created_at": "2026-06-14T15:30:00Z", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "service_fee": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "is_favourite": true, "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "price_including_buyer_protection": { "amount": "180", "currency": "USD", "amount_numeric": 180 } } ], "success": true, "pagination": { "per_page": 1, "next_page": 1, "total_pages": 1, "current_page": 1, "has_next_page": true, "total_entries": 180 }, "pages_fetched": 1, "pages_requested": 1, "search_session_id": "search-session-1" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" }, "search_session_id": { "type": "string" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-search", "task_name": "Vinted search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVintedSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of result pages to fetch (1-20)." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Vinted search term." }, "domain": { "type": "string", "default": "vinted.co.uk", "description": "Optional Vinted domain/origin (e.g. vinted.de, www.vinted.fr, or https://www.vinted.co.uk). Defaults to UK." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "x-browsable-website-login-required": false } }, "/v1/vinted/search": { "post": { "tags": [ "Vinted" ], "summary": "Vinted search", "description": "Search Vinted listings by keyword and return normalized item data across multiple pages.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" }, "search_session_id": { "type": "string" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-search", "task_name": "Vinted search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "query": "London", "results": [ { "id": "id-1", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "page": 1, "size": "sample", "brand": "sample", "color": "sample", "likes": 1.5, "price": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "views": 1.5, "seller": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "is_business": true, "profile_url": "https://example.com/item-1", "feedback_count": 1, "feedback_reputation": 1.5 }, "location": "London", "material": "sample", "promoted": true, "condition": "sample", "catalog_id": "id-1", "created_at": "2026-06-14T15:30:00Z", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "service_fee": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "is_favourite": true, "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "price_including_buyer_protection": { "amount": "180", "currency": "USD", "amount_numeric": 180 } } ], "success": true, "pagination": { "per_page": 1, "next_page": 1, "total_pages": 1, "current_page": 1, "has_next_page": true, "total_entries": 180 }, "pages_fetched": 1, "pages_requested": 1, "search_session_id": "search-session-1" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" }, "search_session_id": { "type": "string" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-search", "task_name": "Vinted search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVintedSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of result pages to fetch (1-20)." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Vinted search term." }, "domain": { "type": "string", "default": "vinted.co.uk", "description": "Optional Vinted domain/origin (e.g. vinted.de, www.vinted.fr, or https://www.vinted.co.uk). Defaults to UK." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-vinted-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/vinted-search-filtered/runs": { "post": { "tags": [ "Vinted" ], "summary": "Vinted filtered search", "description": "Search Vinted listings with catalog, size, brand, condition, color, pattern, material, price, and sort filters.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" }, "search_session_id": { "type": "string" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-search-filtered", "task_name": "Vinted filtered search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "query": "London", "results": [ { "id": "id-1", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "page": 1, "size": "sample", "brand": "sample", "color": "sample", "likes": 1.5, "price": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "views": 1.5, "seller": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "is_business": true, "profile_url": "https://example.com/item-1", "feedback_count": 1, "feedback_reputation": 1.5 }, "location": "London", "material": "sample", "promoted": true, "condition": "sample", "catalog_id": "id-1", "created_at": "2026-06-14T15:30:00Z", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "service_fee": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "is_favourite": true, "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "price_including_buyer_protection": { "amount": "180", "currency": "USD", "amount_numeric": 180 } } ], "success": true, "pagination": { "per_page": 1, "next_page": 1, "total_pages": 1, "current_page": 1, "has_next_page": true, "total_entries": 180 }, "pages_fetched": 1, "pages_requested": 1, "search_session_id": "search-session-1" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" }, "search_session_id": { "type": "string" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-search-filtered", "task_name": "Vinted filtered search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVintedSearchFilteredCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "x-sample": "https://www.vinted.co.uk/catalog?search_text=nike&brand_ids[]=53", "maxLength": 500, "minLength": 1, "description": "Copy a filtered Vinted catalogue search URL. Search text, category, size, brand, colour, condition and material filters are extracted automatically." }, "order": { "type": "string", "default": "relevance", "description": "Sort order (e.g. relevance, newest_first, price_high_to_low)." }, "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of result pages to fetch (1-20)." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Vinted search term." }, "domain": { "type": "string", "default": "vinted.co.uk", "description": "Optional Vinted domain/origin (e.g. vinted.de, www.vinted.fr, or https://www.vinted.co.uk). Defaults to UK." }, "catalog": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Catalog/category IDs. Accepts a comma-separated string or an array." }, "price_to": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "x-advanced": true, "description": "Maximum item price. Prefer min_price/max_price." }, "size_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Size filter IDs. Accepts a comma-separated string or an array." }, "brand_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Brand filter IDs. Accepts a comma-separated string or an array." }, "color_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Color filter IDs. Accepts a comma-separated string or an array." }, "max_price": { "type": "number", "minimum": 0, "description": "Maximum price in the selected Vinted marketplace currency." }, "min_price": { "type": "number", "minimum": 0, "description": "Minimum price in the selected Vinted marketplace currency." }, "price_from": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "x-advanced": true, "description": "Minimum item price. Prefer min_price/max_price." }, "status_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Condition/status filter IDs. Accepts a comma-separated string or an array." }, "catalog_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Catalog/category IDs. Accepts a comma-separated string or an array." }, "material_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Material filter IDs. Accepts a comma-separated string or an array." }, "patterns_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Pattern filter IDs. Accepts a comma-separated string or an array." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "query" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.vinted.co.uk/catalog?search_text=nike&brand_ids[]=53" } } } }, "x-browsable-website-login-required": false } }, "/v1/vinted/search/filtered": { "post": { "tags": [ "Vinted" ], "summary": "Vinted filtered search", "description": "Search Vinted listings with catalog, size, brand, condition, color, pattern, material, price, and sort filters.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" }, "search_session_id": { "type": "string" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-search-filtered", "task_name": "Vinted filtered search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "query": "London", "results": [ { "id": "id-1", "link": "https://example.com/item-1", "name": "Stylish Shoreditch Loft with Balcony", "page": 1, "size": "sample", "brand": "sample", "color": "sample", "likes": 1.5, "price": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "views": 1.5, "seller": { "id": "id-1", "username": "Stylish Shoreditch Loft with Balcony", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "is_business": true, "profile_url": "https://example.com/item-1", "feedback_count": 1, "feedback_reputation": 1.5 }, "location": "London", "material": "sample", "promoted": true, "condition": "sample", "catalog_id": "id-1", "created_at": "2026-06-14T15:30:00Z", "image_urls": [ "https://images.example.com/image_urls-1.jpg" ], "description": "Sample description 1", "service_fee": { "amount": "180", "currency": "USD", "amount_numeric": 180 }, "is_favourite": true, "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "price_including_buyer_protection": { "amount": "180", "currency": "USD", "amount_numeric": 180 } } ], "success": true, "pagination": { "per_page": 1, "next_page": 1, "total_pages": 1, "current_page": 1, "has_next_page": true, "total_entries": 180 }, "pages_fetched": 1, "pages_requested": 1, "search_session_id": "search-session-1" }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "image_urls", "price", "price_including_buyer_protection", "service_fee" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "page": { "type": "number" }, "size": { "type": "string" }, "brand": { "type": "string" }, "color": { "type": "string" }, "likes": { "type": "number" }, "price": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "views": { "type": "number" }, "seller": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "username": { "type": "string" }, "avatar_url": { "type": "string" }, "is_business": { "type": "boolean" }, "profile_url": { "type": "string" }, "feedback_count": { "type": "number" }, "feedback_reputation": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "location": { "type": "string" }, "material": { "type": "string" }, "promoted": { "type": "boolean" }, "condition": { "type": "string" }, "catalog_id": { "type": "string" }, "created_at": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "service_fee": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "is_favourite": { "type": "boolean" }, "thumbnail_url": { "type": "string" }, "price_including_buyer_protection": { "anyOf": [ { "type": "object", "required": [ "amount", "amount_numeric", "currency" ], "properties": { "amount": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_numeric": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_page" ], "properties": { "per_page": { "type": "number" }, "next_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_pages": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "current_page": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" }, "total_entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" }, "search_session_id": { "type": "string" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "vinted-search-filtered", "task_name": "Vinted filtered search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runVintedSearchFilteredAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "x-sample": "https://www.vinted.co.uk/catalog?search_text=nike&brand_ids[]=53", "maxLength": 500, "minLength": 1, "description": "Copy a filtered Vinted catalogue search URL. Search text, category, size, brand, colour, condition and material filters are extracted automatically." }, "order": { "type": "string", "default": "relevance", "description": "Sort order (e.g. relevance, newest_first, price_high_to_low)." }, "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of result pages to fetch (1-20)." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Vinted search term." }, "domain": { "type": "string", "default": "vinted.co.uk", "description": "Optional Vinted domain/origin (e.g. vinted.de, www.vinted.fr, or https://www.vinted.co.uk). Defaults to UK." }, "catalog": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Catalog/category IDs. Accepts a comma-separated string or an array." }, "price_to": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "x-advanced": true, "description": "Maximum item price. Prefer min_price/max_price." }, "size_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Size filter IDs. Accepts a comma-separated string or an array." }, "brand_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Brand filter IDs. Accepts a comma-separated string or an array." }, "color_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Color filter IDs. Accepts a comma-separated string or an array." }, "max_price": { "type": "number", "minimum": 0, "description": "Maximum price in the selected Vinted marketplace currency." }, "min_price": { "type": "number", "minimum": 0, "description": "Minimum price in the selected Vinted marketplace currency." }, "price_from": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "x-advanced": true, "description": "Minimum item price. Prefer min_price/max_price." }, "status_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Condition/status filter IDs. Accepts a comma-separated string or an array." }, "catalog_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Catalog/category IDs. Accepts a comma-separated string or an array." }, "material_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Material filter IDs. Accepts a comma-separated string or an array." }, "patterns_ids": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } ], "x-advanced": true, "description": "Pattern filter IDs. Accepts a comma-separated string or an array." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "query" ] }, { "required": [ "url" ] } ] }, "example": { "url": "https://www.vinted.co.uk/catalog?search_text=nike&brand_ids[]=53" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-vinted-search-filtered" }, "x-browsable-website-login-required": false } }, "/v1/tasks/walmart-product/runs": { "post": { "tags": [ "Walmart" ], "summary": "Walmart Product API", "description": "Scrape a public Walmart product detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "walmart-product", "task_name": "Walmart Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "walmart-product", "task_name": "Walmart Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runWalmartProductCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Walmart product URL returned by walmart/search.", "x-placeholder": "e.g. https://www.walmart.com/ip/123456789" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.walmart.com/ip/123456789" } } } }, "x-browsable-website-login-required": false } }, "/v1/walmart/product": { "post": { "tags": [ "Walmart" ], "summary": "Walmart Product API", "description": "Scrape a public Walmart product detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "walmart-product", "task_name": "Walmart Product API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "walmart-product", "task_name": "Walmart Product API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runWalmartProductAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Walmart product URL returned by walmart/search.", "x-placeholder": "e.g. https://www.walmart.com/ip/123456789" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.walmart.com/ip/123456789" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-walmart-product" }, "x-browsable-website-login-required": false } }, "/v1/tasks/walmart-search/runs": { "post": { "tags": [ "Walmart" ], "summary": "Walmart API", "description": "Scrape public Walmart search result pages by query with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "walmart-search", "task_name": "Walmart API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "walmart-search", "task_name": "Walmart API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runWalmartSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "air fryer", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. air fryer" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "air fryer" } } } }, "x-browsable-website-login-required": false } }, "/v1/walmart/search": { "post": { "tags": [ "Walmart" ], "summary": "Walmart API", "description": "Scrape public Walmart search result pages by query with page pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "walmart-search", "task_name": "Walmart API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "walmart-search", "task_name": "Walmart API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runWalmartSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "air fryer", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. air fryer" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "air fryer" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-walmart-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/wellfound-profile/runs": { "post": { "tags": [ "Wellfound" ], "summary": "Wellfound Profile API", "description": "Scrape a public Wellfound company or job page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wellfound-profile", "task_name": "Wellfound Profile API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wellfound-profile", "task_name": "Wellfound Profile API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runWellfoundProfileCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://wellfound.com/company/example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://wellfound.com/company/example" } } } }, "x-browsable-website-login-required": false } }, "/v1/wellfound/profile": { "post": { "tags": [ "Wellfound" ], "summary": "Wellfound Profile API", "description": "Scrape a public Wellfound company or job page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wellfound-profile", "task_name": "Wellfound Profile API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wellfound-profile", "task_name": "Wellfound Profile API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runWellfoundProfileAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://wellfound.com/company/example" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://wellfound.com/company/example" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-wellfound-profile" }, "x-browsable-website-login-required": false } }, "/v1/tasks/wellfound-search/runs": { "post": { "tags": [ "Wellfound" ], "summary": "Wellfound API", "description": "Find public Wellfound jobs by role or company name.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wellfound-search", "task_name": "Wellfound API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wellfound-search", "task_name": "Wellfound API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runWellfoundSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "frontend engineer", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. frontend engineer" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "frontend engineer" } } } }, "x-browsable-website-login-required": false } }, "/v1/wellfound/search": { "post": { "tags": [ "Wellfound" ], "summary": "Wellfound API", "description": "Find public Wellfound jobs by role or company name.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wellfound-search", "task_name": "Wellfound API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wellfound-search", "task_name": "Wellfound API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runWellfoundSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "frontend engineer", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. frontend engineer" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "frontend engineer" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-wellfound-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/wikipedia-page/runs": { "post": { "tags": [ "Wikipedia" ], "summary": "Wikipedia Page API", "description": "Scrape a public Wikipedia article page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wikipedia-page", "task_name": "Wikipedia Page API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wikipedia-page", "task_name": "Wikipedia Page API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runWikipediaPageCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://en.wikipedia.org/wiki/Ada_Lovelace", "maxLength": 2000, "minLength": 1, "description": "Wikipedia page URL returned by wikipedia/search.", "x-placeholder": "e.g. https://en.wikipedia.org/wiki/Ada_Lovelace" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://en.wikipedia.org/wiki/Ada_Lovelace" } } } }, "x-browsable-website-login-required": false } }, "/v1/wikipedia/page": { "post": { "tags": [ "Wikipedia" ], "summary": "Wikipedia Page API", "description": "Scrape a public Wikipedia article page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wikipedia-page", "task_name": "Wikipedia Page API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wikipedia-page", "task_name": "Wikipedia Page API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runWikipediaPageAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://en.wikipedia.org/wiki/Ada_Lovelace", "maxLength": 2000, "minLength": 1, "description": "Wikipedia page URL returned by wikipedia/search.", "x-placeholder": "e.g. https://en.wikipedia.org/wiki/Ada_Lovelace" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://en.wikipedia.org/wiki/Ada_Lovelace" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-wikipedia-page" }, "x-browsable-website-login-required": false } }, "/v1/tasks/wikipedia-search/runs": { "post": { "tags": [ "Wikipedia" ], "summary": "Wikipedia API", "description": "Search Wikipedia through the public MediaWiki API with offset pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wikipedia-search", "task_name": "Wikipedia API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wikipedia-search", "task_name": "Wikipedia API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runWikipediaSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Ada Lovelace", "maxLength": 2000, "minLength": 1, "description": "Wikipedia article search query.", "x-placeholder": "e.g. Ada Lovelace" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Ada Lovelace" } } } }, "x-browsable-website-login-required": false } }, "/v1/wikipedia/search": { "post": { "tags": [ "Wikipedia" ], "summary": "Wikipedia API", "description": "Search Wikipedia through the public MediaWiki API with offset pagination.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wikipedia-search", "task_name": "Wikipedia API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "wikipedia-search", "task_name": "Wikipedia API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runWikipediaSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Ada Lovelace", "maxLength": 2000, "minLength": 1, "description": "Wikipedia article search query.", "x-placeholder": "e.g. Ada Lovelace" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Ada Lovelace" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-wikipedia-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/x-lists/runs": { "post": { "tags": [ "X" ], "summary": "X Lists API", "description": "Scrape a public X or Twitter list page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-lists", "task_name": "X Lists API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-lists", "task_name": "X Lists API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runXListsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://x.com/i/lists/123456789" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://x.com/i/lists/123456789" } } } }, "x-browsable-website-login-required": true } }, "/v1/x/lists": { "post": { "tags": [ "X" ], "summary": "X Lists API", "description": "Scrape a public X or Twitter list page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-lists", "task_name": "X Lists API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-lists", "task_name": "X Lists API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runXListsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://x.com/i/lists/123456789" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://x.com/i/lists/123456789" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-x-lists" }, "x-browsable-website-login-required": true } }, "/v1/tasks/x-profile/runs": { "post": { "tags": [ "X" ], "summary": "X profile", "description": "Fetch tweets from an X profile inside a managed signed-in session.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "max_tweets_requested", "count", "tweets", "pagination" ], "properties": { "count": { "type": "integer" }, "tweets": { "type": "array", "items": { "type": "object", "required": [ "textContent", "displayName", "username", "profilePhotoUrl", "timestamp", "tweetLink", "isAd", "numberOfReplies", "numberOfRetweets", "numberOfLikes", "numberOfViews" ], "properties": { "isAd": { "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tweetLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textContent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfLikes": { "type": "integer" }, "numberOfViews": { "type": "integer" }, "numberOfReplies": { "type": "integer" }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfRetweets": { "type": "integer" } }, "additionalProperties": false } }, "profile": { "type": "object", "required": [ "url", "username" ], "properties": { "url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "type": "null" }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_tweets_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-profile", "task_name": "X profile", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "tweets": [ { "isAd": true, "username": "Stylish Shoreditch Loft with Balcony", "timestamp": "sample", "tweetLink": "https://example.com/item-1", "displayName": "Stylish Shoreditch Loft with Balcony", "textContent": "Sample textcontent 1", "numberOfLikes": 1, "numberOfViews": 1, "numberOfReplies": 1, "profilePhotoUrl": "https://images.example.com/profilephotourl-1.jpg", "numberOfRetweets": 1 } ], "profile": { "url": "https://example.com/item-1", "username": "Stylish Shoreditch Loft with Balcony" }, "success": true, "pagination": { "next_cursor": null, "has_next_page": true }, "max_tweets_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "max_tweets_requested", "count", "tweets", "pagination" ], "properties": { "count": { "type": "integer" }, "tweets": { "type": "array", "items": { "type": "object", "required": [ "textContent", "displayName", "username", "profilePhotoUrl", "timestamp", "tweetLink", "isAd", "numberOfReplies", "numberOfRetweets", "numberOfLikes", "numberOfViews" ], "properties": { "isAd": { "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tweetLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textContent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfLikes": { "type": "integer" }, "numberOfViews": { "type": "integer" }, "numberOfReplies": { "type": "integer" }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfRetweets": { "type": "integer" } }, "additionalProperties": false } }, "profile": { "type": "object", "required": [ "url", "username" ], "properties": { "url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "type": "null" }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_tweets_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-profile", "task_name": "X profile", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runXProfileCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "X profile URL, for example https://x.com/jack. Preferred name; profile_url remains supported." }, "limit": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "description": "Maximum number of tweets to collect from the profile timeline. Preferred name; max_tweets remains supported." }, "username": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "X username without the leading @." }, "max_tweets": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "x-advanced": true, "description": "Maximum number of tweets to collect from the profile timeline. You can also use limit." }, "profile_url": { "type": "string", "x-advanced": true, "description": "X profile URL, for example https://x.com/jack. You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "profile_url" ] }, { "required": [ "username" ] } ] }, "example": { "profile_url": "https://example.com/item-1" } } } }, "x-browsable-website-login-required": true } }, "/v1/x/profile": { "post": { "tags": [ "X" ], "summary": "X profile", "description": "Fetch tweets from an X profile inside a managed signed-in session.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "max_tweets_requested", "count", "tweets", "pagination" ], "properties": { "count": { "type": "integer" }, "tweets": { "type": "array", "items": { "type": "object", "required": [ "textContent", "displayName", "username", "profilePhotoUrl", "timestamp", "tweetLink", "isAd", "numberOfReplies", "numberOfRetweets", "numberOfLikes", "numberOfViews" ], "properties": { "isAd": { "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tweetLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textContent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfLikes": { "type": "integer" }, "numberOfViews": { "type": "integer" }, "numberOfReplies": { "type": "integer" }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfRetweets": { "type": "integer" } }, "additionalProperties": false } }, "profile": { "type": "object", "required": [ "url", "username" ], "properties": { "url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "type": "null" }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_tweets_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-profile", "task_name": "X profile", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "tweets": [ { "isAd": true, "username": "Stylish Shoreditch Loft with Balcony", "timestamp": "sample", "tweetLink": "https://example.com/item-1", "displayName": "Stylish Shoreditch Loft with Balcony", "textContent": "Sample textcontent 1", "numberOfLikes": 1, "numberOfViews": 1, "numberOfReplies": 1, "profilePhotoUrl": "https://images.example.com/profilephotourl-1.jpg", "numberOfRetweets": 1 } ], "profile": { "url": "https://example.com/item-1", "username": "Stylish Shoreditch Loft with Balcony" }, "success": true, "pagination": { "next_cursor": null, "has_next_page": true }, "max_tweets_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "profile", "max_tweets_requested", "count", "tweets", "pagination" ], "properties": { "count": { "type": "integer" }, "tweets": { "type": "array", "items": { "type": "object", "required": [ "textContent", "displayName", "username", "profilePhotoUrl", "timestamp", "tweetLink", "isAd", "numberOfReplies", "numberOfRetweets", "numberOfLikes", "numberOfViews" ], "properties": { "isAd": { "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tweetLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textContent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfLikes": { "type": "integer" }, "numberOfViews": { "type": "integer" }, "numberOfReplies": { "type": "integer" }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfRetweets": { "type": "integer" } }, "additionalProperties": false } }, "profile": { "type": "object", "required": [ "url", "username" ], "properties": { "url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "type": "null" }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_tweets_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-profile", "task_name": "X profile", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runXProfileAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "X profile URL, for example https://x.com/jack. Preferred name; profile_url remains supported." }, "limit": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "description": "Maximum number of tweets to collect from the profile timeline. Preferred name; max_tweets remains supported." }, "username": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "X username without the leading @." }, "max_tweets": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "x-advanced": true, "description": "Maximum number of tweets to collect from the profile timeline. You can also use limit." }, "profile_url": { "type": "string", "x-advanced": true, "description": "X profile URL, for example https://x.com/jack. You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "profile_url" ] }, { "required": [ "username" ] } ] }, "example": { "profile_url": "https://example.com/item-1" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-x-profile" }, "x-browsable-website-login-required": true } }, "/v1/tasks/x-search/runs": { "post": { "tags": [ "X" ], "summary": "X search", "description": "Search X posts inside a managed signed-in session.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "tab", "max_tweets_requested", "count", "tweets", "pagination" ], "properties": { "tab": { "enum": [ "top", "latest", "people", "media", "lists" ], "type": "string" }, "count": { "type": "integer" }, "query": { "type": "string" }, "tweets": { "type": "array", "items": { "type": "object", "required": [ "textContent", "displayName", "username", "profilePhotoUrl", "timestamp", "tweetLink", "isAd", "numberOfReplies", "numberOfRetweets", "numberOfLikes", "numberOfViews" ], "properties": { "isAd": { "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tweetLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textContent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfLikes": { "type": "integer" }, "numberOfViews": { "type": "integer" }, "numberOfReplies": { "type": "integer" }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfRetweets": { "type": "integer" } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "type": "null" }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_tweets_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-search", "task_name": "X search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "tab": "top", "count": 1, "query": "London", "tweets": [ { "isAd": true, "username": "Stylish Shoreditch Loft with Balcony", "timestamp": "sample", "tweetLink": "https://example.com/item-1", "displayName": "Stylish Shoreditch Loft with Balcony", "textContent": "Sample textcontent 1", "numberOfLikes": 1, "numberOfViews": 1, "numberOfReplies": 1, "profilePhotoUrl": "https://images.example.com/profilephotourl-1.jpg", "numberOfRetweets": 1 } ], "success": true, "pagination": { "next_cursor": null, "has_next_page": true }, "max_tweets_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "tab", "max_tweets_requested", "count", "tweets", "pagination" ], "properties": { "tab": { "enum": [ "top", "latest", "people", "media", "lists" ], "type": "string" }, "count": { "type": "integer" }, "query": { "type": "string" }, "tweets": { "type": "array", "items": { "type": "object", "required": [ "textContent", "displayName", "username", "profilePhotoUrl", "timestamp", "tweetLink", "isAd", "numberOfReplies", "numberOfRetweets", "numberOfLikes", "numberOfViews" ], "properties": { "isAd": { "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tweetLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textContent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfLikes": { "type": "integer" }, "numberOfViews": { "type": "integer" }, "numberOfReplies": { "type": "integer" }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfRetweets": { "type": "integer" } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "type": "null" }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_tweets_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-search", "task_name": "X search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runXSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tab": { "enum": [ "top", "latest", "people", "media", "lists" ], "type": "string", "default": "top", "description": "Search tab to scrape." }, "limit": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "description": "Maximum number of tweets to collect from the current search surface. Preferred name; max_tweets remains supported." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Keyword or phrase to search on X." }, "max_tweets": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "x-advanced": true, "description": "Maximum number of tweets to collect from the current search surface. You can also use limit." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "x-browsable-website-login-required": true } }, "/v1/x/search": { "post": { "tags": [ "X" ], "summary": "X search", "description": "Search X posts inside a managed signed-in session.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "tab", "max_tweets_requested", "count", "tweets", "pagination" ], "properties": { "tab": { "enum": [ "top", "latest", "people", "media", "lists" ], "type": "string" }, "count": { "type": "integer" }, "query": { "type": "string" }, "tweets": { "type": "array", "items": { "type": "object", "required": [ "textContent", "displayName", "username", "profilePhotoUrl", "timestamp", "tweetLink", "isAd", "numberOfReplies", "numberOfRetweets", "numberOfLikes", "numberOfViews" ], "properties": { "isAd": { "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tweetLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textContent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfLikes": { "type": "integer" }, "numberOfViews": { "type": "integer" }, "numberOfReplies": { "type": "integer" }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfRetweets": { "type": "integer" } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "type": "null" }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_tweets_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-search", "task_name": "X search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "tab": "top", "count": 1, "query": "London", "tweets": [ { "isAd": true, "username": "Stylish Shoreditch Loft with Balcony", "timestamp": "sample", "tweetLink": "https://example.com/item-1", "displayName": "Stylish Shoreditch Loft with Balcony", "textContent": "Sample textcontent 1", "numberOfLikes": 1, "numberOfViews": 1, "numberOfReplies": 1, "profilePhotoUrl": "https://images.example.com/profilephotourl-1.jpg", "numberOfRetweets": 1 } ], "success": true, "pagination": { "next_cursor": null, "has_next_page": true }, "max_tweets_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "tab", "max_tweets_requested", "count", "tweets", "pagination" ], "properties": { "tab": { "enum": [ "top", "latest", "people", "media", "lists" ], "type": "string" }, "count": { "type": "integer" }, "query": { "type": "string" }, "tweets": { "type": "array", "items": { "type": "object", "required": [ "textContent", "displayName", "username", "profilePhotoUrl", "timestamp", "tweetLink", "isAd", "numberOfReplies", "numberOfRetweets", "numberOfLikes", "numberOfViews" ], "properties": { "isAd": { "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tweetLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textContent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfLikes": { "type": "integer" }, "numberOfViews": { "type": "integer" }, "numberOfReplies": { "type": "integer" }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfRetweets": { "type": "integer" } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "type": "null" }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_tweets_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-search", "task_name": "X search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runXSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tab": { "enum": [ "top", "latest", "people", "media", "lists" ], "type": "string", "default": "top", "description": "Search tab to scrape." }, "limit": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "description": "Maximum number of tweets to collect from the current search surface. Preferred name; max_tweets remains supported." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Keyword or phrase to search on X." }, "max_tweets": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "x-advanced": true, "description": "Maximum number of tweets to collect from the current search surface. You can also use limit." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-x-search" }, "x-browsable-website-login-required": true } }, "/v1/tasks/x-timeline/runs": { "post": { "tags": [ "X" ], "summary": "X timeline", "description": "Fetch tweets from the signed-in X home timeline using managed auth.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "timeline_type", "max_tweets_requested", "count", "tweets", "pagination" ], "properties": { "count": { "type": "integer" }, "tweets": { "type": "array", "items": { "type": "object", "required": [ "textContent", "displayName", "username", "profilePhotoUrl", "timestamp", "tweetLink", "isAd", "numberOfReplies", "numberOfRetweets", "numberOfLikes", "numberOfViews" ], "properties": { "isAd": { "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tweetLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textContent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfLikes": { "type": "integer" }, "numberOfViews": { "type": "integer" }, "numberOfReplies": { "type": "integer" }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfRetweets": { "type": "integer" } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "type": "null" }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "timeline_type": { "enum": [ "following", "for_you" ], "type": "string" }, "max_tweets_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-timeline", "task_name": "X timeline", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "tweets": [ { "isAd": true, "username": "Stylish Shoreditch Loft with Balcony", "timestamp": "sample", "tweetLink": "https://example.com/item-1", "displayName": "Stylish Shoreditch Loft with Balcony", "textContent": "Sample textcontent 1", "numberOfLikes": 1, "numberOfViews": 1, "numberOfReplies": 1, "profilePhotoUrl": "https://images.example.com/profilephotourl-1.jpg", "numberOfRetweets": 1 } ], "success": true, "pagination": { "next_cursor": null, "has_next_page": true }, "timeline_type": "following", "max_tweets_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "timeline_type", "max_tweets_requested", "count", "tweets", "pagination" ], "properties": { "count": { "type": "integer" }, "tweets": { "type": "array", "items": { "type": "object", "required": [ "textContent", "displayName", "username", "profilePhotoUrl", "timestamp", "tweetLink", "isAd", "numberOfReplies", "numberOfRetweets", "numberOfLikes", "numberOfViews" ], "properties": { "isAd": { "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tweetLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textContent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfLikes": { "type": "integer" }, "numberOfViews": { "type": "integer" }, "numberOfReplies": { "type": "integer" }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfRetweets": { "type": "integer" } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "type": "null" }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "timeline_type": { "enum": [ "following", "for_you" ], "type": "string" }, "max_tweets_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-timeline", "task_name": "X timeline", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runXTimelineCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "description": "Maximum number of tweets to collect from the requested home timeline. Preferred name; max_tweets remains supported." }, "max_tweets": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "x-advanced": true, "description": "Maximum number of tweets to collect from the requested home timeline. You can also use limit." }, "timeline_type": { "enum": [ "following", "for_you" ], "type": "string", "default": "following", "description": "Which signed-in home timeline to scrape." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "x-browsable-website-login-required": true } }, "/v1/x/timeline": { "post": { "tags": [ "X" ], "summary": "X timeline", "description": "Fetch tweets from the signed-in X home timeline using managed auth.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "timeline_type", "max_tweets_requested", "count", "tweets", "pagination" ], "properties": { "count": { "type": "integer" }, "tweets": { "type": "array", "items": { "type": "object", "required": [ "textContent", "displayName", "username", "profilePhotoUrl", "timestamp", "tweetLink", "isAd", "numberOfReplies", "numberOfRetweets", "numberOfLikes", "numberOfViews" ], "properties": { "isAd": { "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tweetLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textContent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfLikes": { "type": "integer" }, "numberOfViews": { "type": "integer" }, "numberOfReplies": { "type": "integer" }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfRetweets": { "type": "integer" } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "type": "null" }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "timeline_type": { "enum": [ "following", "for_you" ], "type": "string" }, "max_tweets_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-timeline", "task_name": "X timeline", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "tweets": [ { "isAd": true, "username": "Stylish Shoreditch Loft with Balcony", "timestamp": "sample", "tweetLink": "https://example.com/item-1", "displayName": "Stylish Shoreditch Loft with Balcony", "textContent": "Sample textcontent 1", "numberOfLikes": 1, "numberOfViews": 1, "numberOfReplies": 1, "profilePhotoUrl": "https://images.example.com/profilephotourl-1.jpg", "numberOfRetweets": 1 } ], "success": true, "pagination": { "next_cursor": null, "has_next_page": true }, "timeline_type": "following", "max_tweets_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "timeline_type", "max_tweets_requested", "count", "tweets", "pagination" ], "properties": { "count": { "type": "integer" }, "tweets": { "type": "array", "items": { "type": "object", "required": [ "textContent", "displayName", "username", "profilePhotoUrl", "timestamp", "tweetLink", "isAd", "numberOfReplies", "numberOfRetweets", "numberOfLikes", "numberOfViews" ], "properties": { "isAd": { "type": "boolean" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tweetLink": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textContent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfLikes": { "type": "integer" }, "numberOfViews": { "type": "integer" }, "numberOfReplies": { "type": "integer" }, "profilePhotoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "numberOfRetweets": { "type": "integer" } }, "additionalProperties": false } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_cursor" ], "properties": { "next_cursor": { "type": "null" }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "timeline_type": { "enum": [ "following", "for_you" ], "type": "string" }, "max_tweets_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-timeline", "task_name": "X timeline", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runXTimelineAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "description": "Maximum number of tweets to collect from the requested home timeline. Preferred name; max_tweets remains supported." }, "max_tweets": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1, "x-advanced": true, "description": "Maximum number of tweets to collect from the requested home timeline. You can also use limit." }, "timeline_type": { "enum": [ "following", "for_you" ], "type": "string", "default": "following", "description": "Which signed-in home timeline to scrape." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-x-timeline" }, "x-browsable-website-login-required": true } }, "/v1/tasks/x-trends/runs": { "post": { "tags": [ "X" ], "summary": "X Trends API", "description": "Scrape public X explore trends.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-trends", "task_name": "X Trends API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-trends", "task_name": "X Trends API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runXTrendsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "AI", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. AI" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "x-browsable-website-login-required": true } }, "/v1/x/trends": { "post": { "tags": [ "X" ], "summary": "X Trends API", "description": "Scrape public X explore trends.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-trends", "task_name": "X Trends API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "x-trends", "task_name": "X Trends API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runXTrendsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "AI", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. AI" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false }, "example": {} } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-x-trends" }, "x-browsable-website-login-required": true } }, "/v1/tasks/yelp-business/runs": { "post": { "tags": [ "Yelp" ], "summary": "Yelp Business API", "description": "Scrape a public Yelp business detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "yelp-business", "task_name": "Yelp Business API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "yelp-business", "task_name": "Yelp Business API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYelpBusinessCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.yelp.com/biz/ramen-tatsu-ya-austin-2", "maxLength": 2000, "minLength": 1, "description": "Yelp business URL returned by yelp/search.", "x-placeholder": "e.g. https://www.yelp.com/biz/ramen-tatsu-ya-austin-2" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.yelp.com/biz/ramen-tatsu-ya-austin-2" } } } }, "x-browsable-website-login-required": false } }, "/v1/yelp/business": { "post": { "tags": [ "Yelp" ], "summary": "Yelp Business API", "description": "Scrape a public Yelp business detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "yelp-business", "task_name": "Yelp Business API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "yelp-business", "task_name": "Yelp Business API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYelpBusinessAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.yelp.com/biz/ramen-tatsu-ya-austin-2", "maxLength": 2000, "minLength": 1, "description": "Yelp business URL returned by yelp/search.", "x-placeholder": "e.g. https://www.yelp.com/biz/ramen-tatsu-ya-austin-2" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.yelp.com/biz/ramen-tatsu-ya-austin-2" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-yelp-business" }, "x-browsable-website-login-required": false } }, "/v1/tasks/yelp-reviews/runs": { "post": { "tags": [ "Yelp" ], "summary": "Yelp Reviews API", "description": "Scrape public reviews visible on a Yelp business page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "yelp-reviews", "task_name": "Yelp Reviews API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "yelp-reviews", "task_name": "Yelp Reviews API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYelpReviewsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.yelp.com/biz/ramen-tatsu-ya-austin-2" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.yelp.com/biz/ramen-tatsu-ya-austin-2" } } } }, "x-browsable-website-login-required": false } }, "/v1/yelp/reviews": { "post": { "tags": [ "Yelp" ], "summary": "Yelp Reviews API", "description": "Scrape public reviews visible on a Yelp business page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "yelp-reviews", "task_name": "Yelp Reviews API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "yelp-reviews", "task_name": "Yelp Reviews API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYelpReviewsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.yelp.com/biz/ramen-tatsu-ya-austin-2" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.yelp.com/biz/ramen-tatsu-ya-austin-2" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-yelp-reviews" }, "x-browsable-website-login-required": false } }, "/v1/tasks/yelp-search/runs": { "post": { "tags": [ "Yelp" ], "summary": "Yelp API", "description": "Scrape public Yelp search results by query and optional location. The official Yelp Fusion API requires credentials.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "yelp-search", "task_name": "Yelp API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "yelp-search", "task_name": "Yelp API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYelpSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "ramen", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. ramen" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "location": { "type": "string", "x-sample": "Austin, TX", "maxLength": 2000, "minLength": 1, "description": "Location filter.", "x-placeholder": "e.g. Austin, TX" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "ramen" } } } }, "x-browsable-website-login-required": false } }, "/v1/yelp/search": { "post": { "tags": [ "Yelp" ], "summary": "Yelp API", "description": "Scrape public Yelp search results by query and optional location. The official Yelp Fusion API requires credentials.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "yelp-search", "task_name": "Yelp API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "yelp-search", "task_name": "Yelp API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYelpSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "ramen", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. ramen" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "location": { "type": "string", "x-sample": "Austin, TX", "maxLength": 2000, "minLength": 1, "description": "Location filter.", "x-placeholder": "e.g. Austin, TX" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "ramen" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-yelp-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/youtube-channel-email/runs": { "post": { "tags": [ "YouTube" ], "summary": "YouTube channel email", "description": "Reveal the protected public business email from a YouTube channel's about panel using a managed signed-in browser.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "channel", "source_url", "status", "email", "requires_sign_in", "captcha_required", "captcha_solved", "access_limited", "view_email_clicked", "sign_in_recovery_attempted" ], "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "enum": [ "found", "requires_sign_in", "captcha_required", "access_limited", "not_available" ], "type": "string", "description": "The protected email reveal result. access_limited means YouTube has throttled the managed account and callers should stop retrying it." }, "channel": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "handle": { "type": "string" }, "rss_url": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "shorts_url": { "type": "string" }, "videos_url": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": true }, "message": { "type": "string" }, "success": { "type": "boolean" }, "email_href": { "type": "string" }, "source_url": { "type": "string" }, "access_limited": { "type": "boolean" }, "captcha_solved": { "type": "boolean" }, "captcha_required": { "type": "boolean" }, "requires_sign_in": { "type": "boolean" }, "view_email_clicked": { "type": "boolean" }, "sign_in_recovery_attempted": { "type": "boolean" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-channel-email", "task_name": "YouTube channel email", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "email": "user1@example.com", "status": "found", "channel": { "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "handle": "sample", "rss_url": "https://example.com/item-1", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "channel_id": "id-1", "shorts_url": "https://example.com/item-1", "videos_url": "https://example.com/item-1", "description": "Sample description 1" }, "message": "sample", "success": true, "email_href": "https://example.com/item-1", "source_url": "https://example.com/item-1", "access_limited": true, "captcha_solved": true, "captcha_required": true, "requires_sign_in": true, "view_email_clicked": true, "sign_in_recovery_attempted": true }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "channel", "source_url", "status", "email", "requires_sign_in", "captcha_required", "captcha_solved", "access_limited", "view_email_clicked", "sign_in_recovery_attempted" ], "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "enum": [ "found", "requires_sign_in", "captcha_required", "access_limited", "not_available" ], "type": "string", "description": "The protected email reveal result. access_limited means YouTube has throttled the managed account and callers should stop retrying it." }, "channel": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "handle": { "type": "string" }, "rss_url": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "shorts_url": { "type": "string" }, "videos_url": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": true }, "message": { "type": "string" }, "success": { "type": "boolean" }, "email_href": { "type": "string" }, "source_url": { "type": "string" }, "access_limited": { "type": "boolean" }, "captcha_solved": { "type": "boolean" }, "captcha_required": { "type": "boolean" }, "requires_sign_in": { "type": "boolean" }, "view_email_clicked": { "type": "boolean" }, "sign_in_recovery_attempted": { "type": "boolean" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-channel-email", "task_name": "YouTube channel email", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeChannelEmailCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "YouTube channel URL or tab URL. Handles like https://www.youtube.com/@MrBeast and channel IDs are normalized to the requested tab. Preferred name; channel_url remains supported." }, "handle": { "type": "string", "description": "YouTube channel handle, with or without the leading @." }, "channel_id": { "type": "string", "description": "YouTube channel ID (for example UCX6OQ3DkcsbYNE6H8uQQuVA)." }, "channel_url": { "type": "string", "x-advanced": true, "description": "YouTube channel URL or tab URL. Handles like https://www.youtube.com/@MrBeast and channel IDs are normalized to the requested tab. You can also use url." }, "captcha_timeout_ms": { "type": "number", "default": 180000, "maximum": 300000, "minimum": 0, "x-advanced": true, "description": "Milliseconds to wait for YouTube's captcha and email reveal flow (0-300000). Defaults to 180000." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "channel_url" ] }, { "required": [ "handle" ] }, { "required": [ "channel_id" ] } ] }, "example": { "channel_url": "https://example.com/item-1" } } } }, "x-browsable-website-login-required": true } }, "/v1/youtube/channel/email": { "post": { "tags": [ "YouTube" ], "summary": "YouTube channel email", "description": "Reveal the protected public business email from a YouTube channel's about panel using a managed signed-in browser.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "channel", "source_url", "status", "email", "requires_sign_in", "captcha_required", "captcha_solved", "access_limited", "view_email_clicked", "sign_in_recovery_attempted" ], "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "enum": [ "found", "requires_sign_in", "captcha_required", "access_limited", "not_available" ], "type": "string", "description": "The protected email reveal result. access_limited means YouTube has throttled the managed account and callers should stop retrying it." }, "channel": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "handle": { "type": "string" }, "rss_url": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "shorts_url": { "type": "string" }, "videos_url": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": true }, "message": { "type": "string" }, "success": { "type": "boolean" }, "email_href": { "type": "string" }, "source_url": { "type": "string" }, "access_limited": { "type": "boolean" }, "captcha_solved": { "type": "boolean" }, "captcha_required": { "type": "boolean" }, "requires_sign_in": { "type": "boolean" }, "view_email_clicked": { "type": "boolean" }, "sign_in_recovery_attempted": { "type": "boolean" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-channel-email", "task_name": "YouTube channel email", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "email": "user1@example.com", "status": "found", "channel": { "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "handle": "sample", "rss_url": "https://example.com/item-1", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "channel_id": "id-1", "shorts_url": "https://example.com/item-1", "videos_url": "https://example.com/item-1", "description": "Sample description 1" }, "message": "sample", "success": true, "email_href": "https://example.com/item-1", "source_url": "https://example.com/item-1", "access_limited": true, "captcha_solved": true, "captcha_required": true, "requires_sign_in": true, "view_email_clicked": true, "sign_in_recovery_attempted": true }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "channel", "source_url", "status", "email", "requires_sign_in", "captcha_required", "captcha_solved", "access_limited", "view_email_clicked", "sign_in_recovery_attempted" ], "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "enum": [ "found", "requires_sign_in", "captcha_required", "access_limited", "not_available" ], "type": "string", "description": "The protected email reveal result. access_limited means YouTube has throttled the managed account and callers should stop retrying it." }, "channel": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "handle": { "type": "string" }, "rss_url": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "shorts_url": { "type": "string" }, "videos_url": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": true }, "message": { "type": "string" }, "success": { "type": "boolean" }, "email_href": { "type": "string" }, "source_url": { "type": "string" }, "access_limited": { "type": "boolean" }, "captcha_solved": { "type": "boolean" }, "captcha_required": { "type": "boolean" }, "requires_sign_in": { "type": "boolean" }, "view_email_clicked": { "type": "boolean" }, "sign_in_recovery_attempted": { "type": "boolean" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-channel-email", "task_name": "YouTube channel email", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeChannelEmailAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "YouTube channel URL or tab URL. Handles like https://www.youtube.com/@MrBeast and channel IDs are normalized to the requested tab. Preferred name; channel_url remains supported." }, "handle": { "type": "string", "description": "YouTube channel handle, with or without the leading @." }, "channel_id": { "type": "string", "description": "YouTube channel ID (for example UCX6OQ3DkcsbYNE6H8uQQuVA)." }, "channel_url": { "type": "string", "x-advanced": true, "description": "YouTube channel URL or tab URL. Handles like https://www.youtube.com/@MrBeast and channel IDs are normalized to the requested tab. You can also use url." }, "captcha_timeout_ms": { "type": "number", "default": 180000, "maximum": 300000, "minimum": 0, "x-advanced": true, "description": "Milliseconds to wait for YouTube's captcha and email reveal flow (0-300000). Defaults to 180000." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "channel_url" ] }, { "required": [ "handle" ] }, { "required": [ "channel_id" ] } ] }, "example": { "channel_url": "https://example.com/item-1" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-youtube-channel-email" }, "x-browsable-website-login-required": true } }, "/v1/tasks/youtube-channel-shorts/runs": { "post": { "tags": [ "YouTube" ], "summary": "YouTube channel shorts", "description": "Fetch shorts from a YouTube channel shorts tab using the public web client sort chips and continuations.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "channel", "sort", "pages_requested", "pages_fetched", "count", "shorts", "pagination" ], "properties": { "sort": { "enum": [ "latest", "popular", "oldest" ], "type": "string" }, "count": { "type": "number" }, "shorts": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "thumbnail_urls" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "page": { "type": "number" }, "title": { "type": "string" }, "is_live": { "type": "boolean" }, "duration": { "type": "string" }, "view_count": { "type": "number" }, "description": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_time": { "type": "string" }, "thumbnail_urls": { "type": "array", "items": { "type": "string" } }, "view_count_text": { "type": "string" } }, "additionalProperties": true } }, "channel": { "type": "object", "required": [ "url", "shorts_url" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "handle": { "type": "string" }, "rss_url": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "shorts_url": { "type": "string" }, "videos_url": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-channel-shorts", "task_name": "YouTube channel shorts", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "sort": "latest", "count": 1, "shorts": [ { "id": "id-1", "link": "https://example.com/item-1", "page": 1, "title": "Stylish Shoreditch Loft with Balcony", "is_live": true, "duration": "sample", "view_count": 1, "description": "Sample description 1", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "published_time": "sample", "thumbnail_urls": [ "https://images.example.com/thumbnail_urls-1.jpg" ], "view_count_text": "Sample view_count_text 1" } ], "channel": { "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "handle": "sample", "rss_url": "https://example.com/item-1", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "channel_id": "id-1", "shorts_url": "https://example.com/item-1", "videos_url": "https://example.com/item-1", "description": "Sample description 1" }, "success": true, "pagination": { "has_next_page": true, "next_continuation": "sample" }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "channel", "sort", "pages_requested", "pages_fetched", "count", "shorts", "pagination" ], "properties": { "sort": { "enum": [ "latest", "popular", "oldest" ], "type": "string" }, "count": { "type": "number" }, "shorts": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "thumbnail_urls" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "page": { "type": "number" }, "title": { "type": "string" }, "is_live": { "type": "boolean" }, "duration": { "type": "string" }, "view_count": { "type": "number" }, "description": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_time": { "type": "string" }, "thumbnail_urls": { "type": "array", "items": { "type": "string" } }, "view_count_text": { "type": "string" } }, "additionalProperties": true } }, "channel": { "type": "object", "required": [ "url", "shorts_url" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "handle": { "type": "string" }, "rss_url": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "shorts_url": { "type": "string" }, "videos_url": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-channel-shorts", "task_name": "YouTube channel shorts", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeChannelShortsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "YouTube channel URL or tab URL. Handles like https://www.youtube.com/@MrBeast and channel IDs are normalized to the requested tab. Preferred name; channel_url remains supported." }, "sort": { "enum": [ "latest", "popular", "oldest" ], "type": "string", "default": "latest", "description": "Shorts ordering: latest, popular, or oldest." }, "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of pages to fetch (1-20)." }, "handle": { "type": "string", "description": "YouTube channel handle, with or without the leading @." }, "channel_id": { "type": "string", "description": "YouTube channel ID (for example UCX6OQ3DkcsbYNE6H8uQQuVA)." }, "channel_url": { "type": "string", "x-advanced": true, "description": "YouTube channel URL or tab URL. Handles like https://www.youtube.com/@MrBeast and channel IDs are normalized to the requested tab. You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "channel_url" ] }, { "required": [ "handle" ] }, { "required": [ "channel_id" ] } ] }, "example": { "channel_url": "https://example.com/item-1" } } } }, "x-browsable-website-login-required": false } }, "/v1/youtube/channel/shorts": { "post": { "tags": [ "YouTube" ], "summary": "YouTube channel shorts", "description": "Fetch shorts from a YouTube channel shorts tab using the public web client sort chips and continuations.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "channel", "sort", "pages_requested", "pages_fetched", "count", "shorts", "pagination" ], "properties": { "sort": { "enum": [ "latest", "popular", "oldest" ], "type": "string" }, "count": { "type": "number" }, "shorts": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "thumbnail_urls" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "page": { "type": "number" }, "title": { "type": "string" }, "is_live": { "type": "boolean" }, "duration": { "type": "string" }, "view_count": { "type": "number" }, "description": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_time": { "type": "string" }, "thumbnail_urls": { "type": "array", "items": { "type": "string" } }, "view_count_text": { "type": "string" } }, "additionalProperties": true } }, "channel": { "type": "object", "required": [ "url", "shorts_url" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "handle": { "type": "string" }, "rss_url": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "shorts_url": { "type": "string" }, "videos_url": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-channel-shorts", "task_name": "YouTube channel shorts", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "sort": "latest", "count": 1, "shorts": [ { "id": "id-1", "link": "https://example.com/item-1", "page": 1, "title": "Stylish Shoreditch Loft with Balcony", "is_live": true, "duration": "sample", "view_count": 1, "description": "Sample description 1", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "published_time": "sample", "thumbnail_urls": [ "https://images.example.com/thumbnail_urls-1.jpg" ], "view_count_text": "Sample view_count_text 1" } ], "channel": { "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "handle": "sample", "rss_url": "https://example.com/item-1", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "channel_id": "id-1", "shorts_url": "https://example.com/item-1", "videos_url": "https://example.com/item-1", "description": "Sample description 1" }, "success": true, "pagination": { "has_next_page": true, "next_continuation": "sample" }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "channel", "sort", "pages_requested", "pages_fetched", "count", "shorts", "pagination" ], "properties": { "sort": { "enum": [ "latest", "popular", "oldest" ], "type": "string" }, "count": { "type": "number" }, "shorts": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "thumbnail_urls" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "page": { "type": "number" }, "title": { "type": "string" }, "is_live": { "type": "boolean" }, "duration": { "type": "string" }, "view_count": { "type": "number" }, "description": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_time": { "type": "string" }, "thumbnail_urls": { "type": "array", "items": { "type": "string" } }, "view_count_text": { "type": "string" } }, "additionalProperties": true } }, "channel": { "type": "object", "required": [ "url", "shorts_url" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "handle": { "type": "string" }, "rss_url": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "shorts_url": { "type": "string" }, "videos_url": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-channel-shorts", "task_name": "YouTube channel shorts", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeChannelShortsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "YouTube channel URL or tab URL. Handles like https://www.youtube.com/@MrBeast and channel IDs are normalized to the requested tab. Preferred name; channel_url remains supported." }, "sort": { "enum": [ "latest", "popular", "oldest" ], "type": "string", "default": "latest", "description": "Shorts ordering: latest, popular, or oldest." }, "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of pages to fetch (1-20)." }, "handle": { "type": "string", "description": "YouTube channel handle, with or without the leading @." }, "channel_id": { "type": "string", "description": "YouTube channel ID (for example UCX6OQ3DkcsbYNE6H8uQQuVA)." }, "channel_url": { "type": "string", "x-advanced": true, "description": "YouTube channel URL or tab URL. Handles like https://www.youtube.com/@MrBeast and channel IDs are normalized to the requested tab. You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "channel_url" ] }, { "required": [ "handle" ] }, { "required": [ "channel_id" ] } ] }, "example": { "channel_url": "https://example.com/item-1" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-youtube-channel-shorts" }, "x-browsable-website-login-required": false } }, "/v1/tasks/youtube-channel-videos/runs": { "post": { "tags": [ "YouTube" ], "summary": "YouTube channel videos", "description": "Fetch videos from a YouTube channel videos tab using public web continuations.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "channel", "pages_requested", "pages_fetched", "count", "videos", "pagination" ], "properties": { "count": { "type": "number" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "thumbnail_urls" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "page": { "type": "number" }, "title": { "type": "string" }, "is_live": { "type": "boolean" }, "duration": { "type": "string" }, "view_count": { "type": "number" }, "description": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_time": { "type": "string" }, "thumbnail_urls": { "type": "array", "items": { "type": "string" } }, "view_count_text": { "type": "string" } }, "additionalProperties": true } }, "channel": { "type": "object", "required": [ "url", "videos_url" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "handle": { "type": "string" }, "rss_url": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "shorts_url": { "type": "string" }, "videos_url": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-channel-videos", "task_name": "YouTube channel videos", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "videos": [ { "id": "id-1", "link": "https://example.com/item-1", "page": 1, "title": "Stylish Shoreditch Loft with Balcony", "is_live": true, "duration": "sample", "view_count": 1, "description": "Sample description 1", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "published_time": "sample", "thumbnail_urls": [ "https://images.example.com/thumbnail_urls-1.jpg" ], "view_count_text": "Sample view_count_text 1" } ], "channel": { "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "handle": "sample", "rss_url": "https://example.com/item-1", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "channel_id": "id-1", "shorts_url": "https://example.com/item-1", "videos_url": "https://example.com/item-1", "description": "Sample description 1" }, "success": true, "pagination": { "has_next_page": true, "next_continuation": "sample" }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "channel", "pages_requested", "pages_fetched", "count", "videos", "pagination" ], "properties": { "count": { "type": "number" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "thumbnail_urls" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "page": { "type": "number" }, "title": { "type": "string" }, "is_live": { "type": "boolean" }, "duration": { "type": "string" }, "view_count": { "type": "number" }, "description": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_time": { "type": "string" }, "thumbnail_urls": { "type": "array", "items": { "type": "string" } }, "view_count_text": { "type": "string" } }, "additionalProperties": true } }, "channel": { "type": "object", "required": [ "url", "videos_url" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "handle": { "type": "string" }, "rss_url": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "shorts_url": { "type": "string" }, "videos_url": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-channel-videos", "task_name": "YouTube channel videos", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeChannelVideosCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "YouTube channel URL or tab URL. Handles like https://www.youtube.com/@MrBeast and channel IDs are normalized to the requested tab. Preferred name; channel_url remains supported." }, "pages": { "type": "integer", "default": 1, "minimum": 1, "description": "Number of pages to fetch. Stops earlier when the channel ends." }, "handle": { "type": "string", "description": "YouTube channel handle, with or without the leading @." }, "channel_id": { "type": "string", "description": "YouTube channel ID (for example UCX6OQ3DkcsbYNE6H8uQQuVA)." }, "channel_url": { "type": "string", "x-advanced": true, "description": "YouTube channel URL or tab URL. Handles like https://www.youtube.com/@MrBeast and channel IDs are normalized to the requested tab. You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "channel_url" ] }, { "required": [ "handle" ] }, { "required": [ "channel_id" ] } ] }, "example": { "channel_url": "https://example.com/item-1" } } } }, "x-browsable-website-login-required": false } }, "/v1/youtube/channel/videos": { "post": { "tags": [ "YouTube" ], "summary": "YouTube channel videos", "description": "Fetch videos from a YouTube channel videos tab using public web continuations.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "channel", "pages_requested", "pages_fetched", "count", "videos", "pagination" ], "properties": { "count": { "type": "number" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "thumbnail_urls" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "page": { "type": "number" }, "title": { "type": "string" }, "is_live": { "type": "boolean" }, "duration": { "type": "string" }, "view_count": { "type": "number" }, "description": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_time": { "type": "string" }, "thumbnail_urls": { "type": "array", "items": { "type": "string" } }, "view_count_text": { "type": "string" } }, "additionalProperties": true } }, "channel": { "type": "object", "required": [ "url", "videos_url" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "handle": { "type": "string" }, "rss_url": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "shorts_url": { "type": "string" }, "videos_url": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-channel-videos", "task_name": "YouTube channel videos", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "videos": [ { "id": "id-1", "link": "https://example.com/item-1", "page": 1, "title": "Stylish Shoreditch Loft with Balcony", "is_live": true, "duration": "sample", "view_count": 1, "description": "Sample description 1", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "published_time": "sample", "thumbnail_urls": [ "https://images.example.com/thumbnail_urls-1.jpg" ], "view_count_text": "Sample view_count_text 1" } ], "channel": { "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "handle": "sample", "rss_url": "https://example.com/item-1", "avatar_url": "https://images.example.com/avatar_url-1.jpg", "channel_id": "id-1", "shorts_url": "https://example.com/item-1", "videos_url": "https://example.com/item-1", "description": "Sample description 1" }, "success": true, "pagination": { "has_next_page": true, "next_continuation": "sample" }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "channel", "pages_requested", "pages_fetched", "count", "videos", "pagination" ], "properties": { "count": { "type": "number" }, "videos": { "type": "array", "items": { "type": "object", "required": [ "id", "page", "link", "thumbnail_urls" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "page": { "type": "number" }, "title": { "type": "string" }, "is_live": { "type": "boolean" }, "duration": { "type": "string" }, "view_count": { "type": "number" }, "description": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_time": { "type": "string" }, "thumbnail_urls": { "type": "array", "items": { "type": "string" } }, "view_count_text": { "type": "string" } }, "additionalProperties": true } }, "channel": { "type": "object", "required": [ "url", "videos_url" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "handle": { "type": "string" }, "rss_url": { "type": "string" }, "avatar_url": { "type": "string" }, "channel_id": { "type": "string" }, "shorts_url": { "type": "string" }, "videos_url": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": true }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-channel-videos", "task_name": "YouTube channel videos", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeChannelVideosAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "YouTube channel URL or tab URL. Handles like https://www.youtube.com/@MrBeast and channel IDs are normalized to the requested tab. Preferred name; channel_url remains supported." }, "pages": { "type": "integer", "default": 1, "minimum": 1, "description": "Number of pages to fetch. Stops earlier when the channel ends." }, "handle": { "type": "string", "description": "YouTube channel handle, with or without the leading @." }, "channel_id": { "type": "string", "description": "YouTube channel ID (for example UCX6OQ3DkcsbYNE6H8uQQuVA)." }, "channel_url": { "type": "string", "x-advanced": true, "description": "YouTube channel URL or tab URL. Handles like https://www.youtube.com/@MrBeast and channel IDs are normalized to the requested tab. You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "channel_url" ] }, { "required": [ "handle" ] }, { "required": [ "channel_id" ] } ] }, "example": { "channel_url": "https://example.com/item-1" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-youtube-channel-videos" }, "x-browsable-website-login-required": false } }, "/v1/tasks/youtube-livestreams/runs": { "post": { "tags": [ "YouTube" ], "summary": "YouTube Livestreams API", "description": "Scrape public YouTube live video search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-livestreams", "task_name": "YouTube Livestreams API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-livestreams", "task_name": "YouTube Livestreams API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeLivestreamsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "space launch live", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. space launch live" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "space launch live" } } } }, "x-browsable-website-login-required": false } }, "/v1/youtube/livestreams": { "post": { "tags": [ "YouTube" ], "summary": "YouTube Livestreams API", "description": "Scrape public YouTube live video search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-livestreams", "task_name": "YouTube Livestreams API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-livestreams", "task_name": "YouTube Livestreams API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeLivestreamsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "space launch live", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. space launch live" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "space launch live" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-youtube-livestreams" }, "x-browsable-website-login-required": false } }, "/v1/tasks/youtube-search/runs": { "post": { "tags": [ "YouTube" ], "summary": "YouTube search", "description": "Search YouTube and return normalized mixed results from the default results page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "type", "id", "link" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "type": { "enum": [ "video", "channel", "playlist" ], "type": "string" }, "title": { "type": "string" } }, "additionalProperties": true } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-search", "task_name": "YouTube search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "query": "London", "results": [ { "id": "id-1", "link": "https://example.com/item-1", "type": "video", "title": "Stylish Shoreditch Loft with Balcony" } ], "success": true, "pagination": { "has_next_page": true, "next_continuation": "sample" }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "type", "id", "link" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "type": { "enum": [ "video", "channel", "playlist" ], "type": "string" }, "title": { "type": "string" } }, "additionalProperties": true } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-search", "task_name": "YouTube search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of search result pages to fetch (1-20)." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Search query string." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "x-browsable-website-login-required": false } }, "/v1/youtube/search": { "post": { "tags": [ "YouTube" ], "summary": "YouTube search", "description": "Search YouTube and return normalized mixed results from the default results page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "type", "id", "link" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "type": { "enum": [ "video", "channel", "playlist" ], "type": "string" }, "title": { "type": "string" } }, "additionalProperties": true } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-search", "task_name": "YouTube search", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "query": "London", "results": [ { "id": "id-1", "link": "https://example.com/item-1", "type": "video", "title": "Stylish Shoreditch Loft with Balcony" } ], "success": true, "pagination": { "has_next_page": true, "next_continuation": "sample" }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "query", "pages_requested", "pages_fetched", "count", "results", "pagination" ], "properties": { "count": { "type": "number" }, "query": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "type", "id", "link" ], "properties": { "id": { "type": "string" }, "link": { "type": "string" }, "type": { "enum": [ "video", "channel", "playlist" ], "type": "string" }, "title": { "type": "string" } }, "additionalProperties": true } }, "success": { "type": "boolean" }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-search", "task_name": "YouTube search", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of search result pages to fetch (1-20)." }, "query": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Search query string." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "London" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-youtube-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/youtube-to-mp3/runs": { "post": { "tags": [ "YouTube" ], "summary": "YouTube to MP3", "description": "Convert a public YouTube video to a downloadable MP3 file.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Poll the run until it succeeds for a signed MP3 download URL, expiry and conversion statistics.", "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "export_id": { "type": "string", "description": "Export identifier. Poll the run until it succeeds before downloading." }, "status": { "type": "string", "enum": [ "completed", "pending" ] }, "file_name": { "type": "string" }, "download_url": { "type": "string", "description": "Short-lived signed download URL. It can be a pending:// placeholder before the artifact is ready." }, "download_url_expires_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "video": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "thumbnail_url": { "type": [ "string", "null" ] }, "duration_seconds": { "type": [ "number", "null" ] } }, "required": [ "id", "url", "title", "duration_seconds" ], "additionalProperties": false }, "result_summary": { "type": "object", "properties": { "format": { "const": "mp3", "type": "string" }, "bitrate": { "type": "string", "enum": [ "128k", "192k", "256k", "320k" ] }, "sizeBytes": { "type": "number" }, "sourceBytes": { "type": "number" }, "durationSeconds": { "type": [ "number", "null" ] }, "title": { "type": [ "string", "null" ] }, "ytDlpVersion": { "type": [ "string", "null" ] } }, "required": [ "format", "bitrate", "sizeBytes", "sourceBytes", "durationSeconds", "title", "ytDlpVersion" ], "additionalProperties": false } }, "required": [ "success", "export_id", "status", "file_name", "download_url", "download_url_expires_at", "expires_at", "video", "result_summary" ], "additionalProperties": false }, { "type": "object", "properties": { "export_id": { "type": "string" } }, "required": [ "export_id" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-to-mp3", "task_name": "YouTube to MP3", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "success": true, "export_id": "id-1", "status": "completed", "file_name": "Stylish Shoreditch Loft with Balcony", "download_url": "https://example.com/item-1", "download_url_expires_at": "https://example.com/item-1", "expires_at": "sample", "video": { "id": "id-1", "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "duration_seconds": 1.5 }, "result_summary": { "format": "mp3", "bitrate": "128k", "sizeBytes": 1.5, "sourceBytes": 1.5, "durationSeconds": 1.5, "title": "Stylish Shoreditch Loft with Balcony", "ytDlpVersion": "sample" } }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Poll the run until it succeeds for a signed MP3 download URL, expiry and conversion statistics.", "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "export_id": { "type": "string", "description": "Export identifier. Poll the run until it succeeds before downloading." }, "status": { "type": "string", "enum": [ "completed", "pending" ] }, "file_name": { "type": "string" }, "download_url": { "type": "string", "description": "Short-lived signed download URL. It can be a pending:// placeholder before the artifact is ready." }, "download_url_expires_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "video": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "thumbnail_url": { "type": [ "string", "null" ] }, "duration_seconds": { "type": [ "number", "null" ] } }, "required": [ "id", "url", "title", "duration_seconds" ], "additionalProperties": false }, "result_summary": { "type": "object", "properties": { "format": { "const": "mp3", "type": "string" }, "bitrate": { "type": "string", "enum": [ "128k", "192k", "256k", "320k" ] }, "sizeBytes": { "type": "number" }, "sourceBytes": { "type": "number" }, "durationSeconds": { "type": [ "number", "null" ] }, "title": { "type": [ "string", "null" ] }, "ytDlpVersion": { "type": [ "string", "null" ] } }, "required": [ "format", "bitrate", "sizeBytes", "sourceBytes", "durationSeconds", "title", "ytDlpVersion" ], "additionalProperties": false } }, "required": [ "success", "export_id", "status", "file_name", "download_url", "download_url_expires_at", "expires_at", "video", "result_summary" ], "additionalProperties": false }, { "type": "object", "properties": { "export_id": { "type": "string" } }, "required": [ "export_id" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-to-mp3", "task_name": "YouTube to MP3", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeToMp3Canonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "description": "Regular YouTube video URL, youtu.be URL, shorts URL, or video ID for the video to convert. Preferred name; video_url remains supported.", "x-placeholder": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" }, "bitrate": { "enum": [ "128k", "192k", "256k", "320k" ], "type": "string", "default": "192k", "description": "Target MP3 audio bitrate." }, "video_url": { "type": "string", "x-sample": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "x-advanced": true, "description": "Regular YouTube video URL, youtu.be URL, shorts URL, or video ID for the video to convert. You can also use url.", "x-placeholder": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" }, "include_metadata": { "type": "boolean", "default": true, "description": "Whether to preserve basic video metadata in the conversion workflow." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "url" ] }, { "required": [ "video_url" ] } ] } ] }, "example": { "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" } } } }, "x-browsable-website-login-required": false } }, "/v1/youtube/to-mp3": { "post": { "tags": [ "YouTube" ], "summary": "YouTube to MP3", "description": "Convert a public YouTube video to a downloadable MP3 file.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Poll the run until it succeeds for a signed MP3 download URL, expiry and conversion statistics.", "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "export_id": { "type": "string", "description": "Export identifier. Poll the run until it succeeds before downloading." }, "status": { "type": "string", "enum": [ "completed", "pending" ] }, "file_name": { "type": "string" }, "download_url": { "type": "string", "description": "Short-lived signed download URL. It can be a pending:// placeholder before the artifact is ready." }, "download_url_expires_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "video": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "thumbnail_url": { "type": [ "string", "null" ] }, "duration_seconds": { "type": [ "number", "null" ] } }, "required": [ "id", "url", "title", "duration_seconds" ], "additionalProperties": false }, "result_summary": { "type": "object", "properties": { "format": { "const": "mp3", "type": "string" }, "bitrate": { "type": "string", "enum": [ "128k", "192k", "256k", "320k" ] }, "sizeBytes": { "type": "number" }, "sourceBytes": { "type": "number" }, "durationSeconds": { "type": [ "number", "null" ] }, "title": { "type": [ "string", "null" ] }, "ytDlpVersion": { "type": [ "string", "null" ] } }, "required": [ "format", "bitrate", "sizeBytes", "sourceBytes", "durationSeconds", "title", "ytDlpVersion" ], "additionalProperties": false } }, "required": [ "success", "export_id", "status", "file_name", "download_url", "download_url_expires_at", "expires_at", "video", "result_summary" ], "additionalProperties": false }, { "type": "object", "properties": { "export_id": { "type": "string" } }, "required": [ "export_id" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-to-mp3", "task_name": "YouTube to MP3", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "success": true, "export_id": "id-1", "status": "completed", "file_name": "Stylish Shoreditch Loft with Balcony", "download_url": "https://example.com/item-1", "download_url_expires_at": "https://example.com/item-1", "expires_at": "sample", "video": { "id": "id-1", "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "duration_seconds": 1.5 }, "result_summary": { "format": "mp3", "bitrate": "128k", "sizeBytes": 1.5, "sourceBytes": 1.5, "durationSeconds": 1.5, "title": "Stylish Shoreditch Loft with Balcony", "ytDlpVersion": "sample" } }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Poll the run until it succeeds for a signed MP3 download URL, expiry and conversion statistics.", "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "const": true }, "export_id": { "type": "string", "description": "Export identifier. Poll the run until it succeeds before downloading." }, "status": { "type": "string", "enum": [ "completed", "pending" ] }, "file_name": { "type": "string" }, "download_url": { "type": "string", "description": "Short-lived signed download URL. It can be a pending:// placeholder before the artifact is ready." }, "download_url_expires_at": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "video": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "thumbnail_url": { "type": [ "string", "null" ] }, "duration_seconds": { "type": [ "number", "null" ] } }, "required": [ "id", "url", "title", "duration_seconds" ], "additionalProperties": false }, "result_summary": { "type": "object", "properties": { "format": { "const": "mp3", "type": "string" }, "bitrate": { "type": "string", "enum": [ "128k", "192k", "256k", "320k" ] }, "sizeBytes": { "type": "number" }, "sourceBytes": { "type": "number" }, "durationSeconds": { "type": [ "number", "null" ] }, "title": { "type": [ "string", "null" ] }, "ytDlpVersion": { "type": [ "string", "null" ] } }, "required": [ "format", "bitrate", "sizeBytes", "sourceBytes", "durationSeconds", "title", "ytDlpVersion" ], "additionalProperties": false } }, "required": [ "success", "export_id", "status", "file_name", "download_url", "download_url_expires_at", "expires_at", "video", "result_summary" ], "additionalProperties": false }, { "type": "object", "properties": { "export_id": { "type": "string" } }, "required": [ "export_id" ], "additionalProperties": false } ] }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-to-mp3", "task_name": "YouTube to MP3", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeToMp3Alias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "x-sample": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "description": "Regular YouTube video URL, youtu.be URL, shorts URL, or video ID for the video to convert. Preferred name; video_url remains supported.", "x-placeholder": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" }, "bitrate": { "enum": [ "128k", "192k", "256k", "320k" ], "type": "string", "default": "192k", "description": "Target MP3 audio bitrate." }, "video_url": { "type": "string", "x-sample": "https://www.youtube.com/watch?v=dQw4w9WgXcQ", "x-advanced": true, "description": "Regular YouTube video URL, youtu.be URL, shorts URL, or video ID for the video to convert. You can also use url.", "x-placeholder": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" }, "include_metadata": { "type": "boolean", "default": true, "description": "Whether to preserve basic video metadata in the conversion workflow." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "url" ] }, { "required": [ "video_url" ] } ] } ] }, "example": { "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-youtube-to-mp3" }, "x-browsable-website-login-required": false } }, "/v1/tasks/youtube-transcript/runs": { "post": { "tags": [ "YouTube" ], "summary": "YouTube Transcript API", "description": "Fetch public YouTube caption transcript segments for a video.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-transcript", "task_name": "YouTube Transcript API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-transcript", "task_name": "YouTube Transcript API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeTranscriptCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "YouTube video URL.", "x-placeholder": "e.g. https://www.youtube.com/watch?v=dQw4w9WgXcQ" }, "video_id": { "type": "string", "description": "YouTube video id.", "x-placeholder": "e.g. dQw4w9WgXcQ" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "video_id" ] } ] }, "example": { "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" } } } }, "x-browsable-website-login-required": false } }, "/v1/youtube/transcript": { "post": { "tags": [ "YouTube" ], "summary": "YouTube Transcript API", "description": "Fetch public YouTube caption transcript segments for a video.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-transcript", "task_name": "YouTube Transcript API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-transcript", "task_name": "YouTube Transcript API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeTranscriptAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "YouTube video URL.", "x-placeholder": "e.g. https://www.youtube.com/watch?v=dQw4w9WgXcQ" }, "video_id": { "type": "string", "description": "YouTube video id.", "x-placeholder": "e.g. dQw4w9WgXcQ" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "url" ] }, { "required": [ "video_id" ] } ] }, "example": { "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-youtube-transcript" }, "x-browsable-website-login-required": false } }, "/v1/tasks/youtube-video/runs": { "post": { "tags": [ "YouTube" ], "summary": "YouTube video", "description": "Fetch a YouTube video page with normalized metadata and top-level comments.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "video", "pages_requested", "pages_fetched", "count", "comments", "pagination" ], "properties": { "count": { "type": "number" }, "video": { "type": "object", "required": [ "id", "url", "thumbnail_urls" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "channel": { "type": "object", "additionalProperties": true }, "duration": { "type": "string" }, "view_count": { "type": "number" }, "description": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_time": { "type": "string" }, "thumbnail_urls": { "type": "array", "items": { "type": "string" } }, "view_count_text": { "type": "string" } }, "additionalProperties": true }, "success": { "type": "boolean" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "page" ], "properties": { "id": { "type": "string" }, "page": { "type": "number" }, "text": { "type": "string" }, "is_pinned": { "type": "boolean" }, "author_url": { "type": "string" }, "is_hearted": { "type": "boolean" }, "like_count": { "type": "number" }, "author_name": { "type": "string" }, "reply_count": { "type": "number" }, "published_time": { "type": "string" }, "like_count_text": { "type": "string" }, "author_thumbnail_url": { "type": "string" } }, "additionalProperties": true } }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-video", "task_name": "YouTube video", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "video": { "id": "id-1", "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "channel": {}, "duration": "sample", "view_count": 1, "description": "Sample description 1", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "published_time": "sample", "thumbnail_urls": [ "https://images.example.com/thumbnail_urls-1.jpg" ], "view_count_text": "Sample view_count_text 1" }, "success": true, "comments": [ { "id": "id-1", "page": 1, "text": "Sample text 1", "is_pinned": true, "author_url": "https://example.com/item-1", "is_hearted": true, "like_count": 1, "author_name": "Stylish Shoreditch Loft with Balcony", "reply_count": 1, "published_time": "sample", "like_count_text": "Sample like_count_text 1", "author_thumbnail_url": "https://images.example.com/author_thumbnail_url-1.jpg" } ], "pagination": { "has_next_page": true, "next_continuation": "sample" }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "video", "pages_requested", "pages_fetched", "count", "comments", "pagination" ], "properties": { "count": { "type": "number" }, "video": { "type": "object", "required": [ "id", "url", "thumbnail_urls" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "channel": { "type": "object", "additionalProperties": true }, "duration": { "type": "string" }, "view_count": { "type": "number" }, "description": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_time": { "type": "string" }, "thumbnail_urls": { "type": "array", "items": { "type": "string" } }, "view_count_text": { "type": "string" } }, "additionalProperties": true }, "success": { "type": "boolean" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "page" ], "properties": { "id": { "type": "string" }, "page": { "type": "number" }, "text": { "type": "string" }, "is_pinned": { "type": "boolean" }, "author_url": { "type": "string" }, "is_hearted": { "type": "boolean" }, "like_count": { "type": "number" }, "author_name": { "type": "string" }, "reply_count": { "type": "number" }, "published_time": { "type": "string" }, "like_count_text": { "type": "string" }, "author_thumbnail_url": { "type": "string" } }, "additionalProperties": true } }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-video", "task_name": "YouTube video", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeVideoCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "YouTube video URL, short URL, or shorts URL. Preferred name; video_url remains supported." }, "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of comment pages to fetch (1-20)." }, "video_id": { "type": "string", "description": "YouTube video ID." }, "video_url": { "type": "string", "x-advanced": true, "description": "YouTube video URL, short URL, or shorts URL. You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "video_url" ] }, { "required": [ "video_id" ] } ] }, "example": { "video_url": "https://example.com/item-1" } } } }, "x-browsable-website-login-required": false } }, "/v1/youtube/video": { "post": { "tags": [ "YouTube" ], "summary": "YouTube video", "description": "Fetch a YouTube video page with normalized metadata and top-level comments.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "video", "pages_requested", "pages_fetched", "count", "comments", "pagination" ], "properties": { "count": { "type": "number" }, "video": { "type": "object", "required": [ "id", "url", "thumbnail_urls" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "channel": { "type": "object", "additionalProperties": true }, "duration": { "type": "string" }, "view_count": { "type": "number" }, "description": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_time": { "type": "string" }, "thumbnail_urls": { "type": "array", "items": { "type": "string" } }, "view_count_text": { "type": "string" } }, "additionalProperties": true }, "success": { "type": "boolean" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "page" ], "properties": { "id": { "type": "string" }, "page": { "type": "number" }, "text": { "type": "string" }, "is_pinned": { "type": "boolean" }, "author_url": { "type": "string" }, "is_hearted": { "type": "boolean" }, "like_count": { "type": "number" }, "author_name": { "type": "string" }, "reply_count": { "type": "number" }, "published_time": { "type": "string" }, "like_count_text": { "type": "string" }, "author_thumbnail_url": { "type": "string" } }, "additionalProperties": true } }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-video", "task_name": "YouTube video", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "video": { "id": "id-1", "url": "https://example.com/item-1", "title": "Stylish Shoreditch Loft with Balcony", "channel": {}, "duration": "sample", "view_count": 1, "description": "Sample description 1", "thumbnail_url": "https://images.example.com/thumbnail_url-1.jpg", "published_time": "sample", "thumbnail_urls": [ "https://images.example.com/thumbnail_urls-1.jpg" ], "view_count_text": "Sample view_count_text 1" }, "success": true, "comments": [ { "id": "id-1", "page": 1, "text": "Sample text 1", "is_pinned": true, "author_url": "https://example.com/item-1", "is_hearted": true, "like_count": 1, "author_name": "Stylish Shoreditch Loft with Balcony", "reply_count": 1, "published_time": "sample", "like_count_text": "Sample like_count_text 1", "author_thumbnail_url": "https://images.example.com/author_thumbnail_url-1.jpg" } ], "pagination": { "has_next_page": true, "next_continuation": "sample" }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "video", "pages_requested", "pages_fetched", "count", "comments", "pagination" ], "properties": { "count": { "type": "number" }, "video": { "type": "object", "required": [ "id", "url", "thumbnail_urls" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "channel": { "type": "object", "additionalProperties": true }, "duration": { "type": "string" }, "view_count": { "type": "number" }, "description": { "type": "string" }, "thumbnail_url": { "type": "string" }, "published_time": { "type": "string" }, "thumbnail_urls": { "type": "array", "items": { "type": "string" } }, "view_count_text": { "type": "string" } }, "additionalProperties": true }, "success": { "type": "boolean" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "page" ], "properties": { "id": { "type": "string" }, "page": { "type": "number" }, "text": { "type": "string" }, "is_pinned": { "type": "boolean" }, "author_url": { "type": "string" }, "is_hearted": { "type": "boolean" }, "like_count": { "type": "number" }, "author_name": { "type": "string" }, "reply_count": { "type": "number" }, "published_time": { "type": "string" }, "like_count_text": { "type": "string" }, "author_thumbnail_url": { "type": "string" } }, "additionalProperties": true } }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-video", "task_name": "YouTube video", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeVideoAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "YouTube video URL, short URL, or shorts URL. Preferred name; video_url remains supported." }, "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of comment pages to fetch (1-20)." }, "video_id": { "type": "string", "description": "YouTube video ID." }, "video_url": { "type": "string", "x-advanced": true, "description": "YouTube video URL, short URL, or shorts URL. You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "video_url" ] }, { "required": [ "video_id" ] } ] }, "example": { "video_url": "https://example.com/item-1" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-youtube-video" }, "x-browsable-website-login-required": false } }, "/v1/tasks/youtube-video-comments/runs": { "post": { "tags": [ "YouTube" ], "summary": "YouTube video comments", "description": "Fetch top-level comments for a YouTube video using the public watch page and comments continuations.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "pages_requested", "pages_fetched", "count", "comments", "pagination" ], "properties": { "count": { "type": "number" }, "success": { "type": "boolean" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "page" ], "properties": { "id": { "type": "string" }, "page": { "type": "number" }, "text": { "type": "string" }, "is_pinned": { "type": "boolean" }, "author_url": { "type": "string" }, "is_hearted": { "type": "boolean" }, "like_count": { "type": "number" }, "author_name": { "type": "string" }, "reply_count": { "type": "number" }, "published_time": { "type": "string" }, "like_count_text": { "type": "string" }, "author_thumbnail_url": { "type": "string" } }, "additionalProperties": true } }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-video-comments", "task_name": "YouTube video comments", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "success": true, "comments": [ { "id": "id-1", "page": 1, "text": "Sample text 1", "is_pinned": true, "author_url": "https://example.com/item-1", "is_hearted": true, "like_count": 1, "author_name": "Stylish Shoreditch Loft with Balcony", "reply_count": 1, "published_time": "sample", "like_count_text": "Sample like_count_text 1", "author_thumbnail_url": "https://images.example.com/author_thumbnail_url-1.jpg" } ], "pagination": { "has_next_page": true, "next_continuation": "sample" }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "pages_requested", "pages_fetched", "count", "comments", "pagination" ], "properties": { "count": { "type": "number" }, "success": { "type": "boolean" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "page" ], "properties": { "id": { "type": "string" }, "page": { "type": "number" }, "text": { "type": "string" }, "is_pinned": { "type": "boolean" }, "author_url": { "type": "string" }, "is_hearted": { "type": "boolean" }, "like_count": { "type": "number" }, "author_name": { "type": "string" }, "reply_count": { "type": "number" }, "published_time": { "type": "string" }, "like_count_text": { "type": "string" }, "author_thumbnail_url": { "type": "string" } }, "additionalProperties": true } }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-video-comments", "task_name": "YouTube video comments", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeVideoCommentsCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "YouTube video URL, short URL, or shorts URL. Preferred name; video_url remains supported." }, "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of comment pages to fetch (1-20)." }, "video_id": { "type": "string", "description": "YouTube video ID." }, "video_url": { "type": "string", "x-advanced": true, "description": "YouTube video URL, short URL, or shorts URL. You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "video_url" ] }, { "required": [ "video_id" ] } ] }, "example": { "video_url": "https://example.com/item-1" } } } }, "x-browsable-website-login-required": false } }, "/v1/youtube/video/comments": { "post": { "tags": [ "YouTube" ], "summary": "YouTube video comments", "description": "Fetch top-level comments for a YouTube video using the public watch page and comments continuations.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "pages_requested", "pages_fetched", "count", "comments", "pagination" ], "properties": { "count": { "type": "number" }, "success": { "type": "boolean" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "page" ], "properties": { "id": { "type": "string" }, "page": { "type": "number" }, "text": { "type": "string" }, "is_pinned": { "type": "boolean" }, "author_url": { "type": "string" }, "is_hearted": { "type": "boolean" }, "like_count": { "type": "number" }, "author_name": { "type": "string" }, "reply_count": { "type": "number" }, "published_time": { "type": "string" }, "like_count_text": { "type": "string" }, "author_thumbnail_url": { "type": "string" } }, "additionalProperties": true } }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-video-comments", "task_name": "YouTube video comments", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "count": 1, "success": true, "comments": [ { "id": "id-1", "page": 1, "text": "Sample text 1", "is_pinned": true, "author_url": "https://example.com/item-1", "is_hearted": true, "like_count": 1, "author_name": "Stylish Shoreditch Loft with Balcony", "reply_count": 1, "published_time": "sample", "like_count_text": "Sample like_count_text 1", "author_thumbnail_url": "https://images.example.com/author_thumbnail_url-1.jpg" } ], "pagination": { "has_next_page": true, "next_continuation": "sample" }, "pages_fetched": 1, "pages_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "pages_requested", "pages_fetched", "count", "comments", "pagination" ], "properties": { "count": { "type": "number" }, "success": { "type": "boolean" }, "comments": { "type": "array", "items": { "type": "object", "required": [ "id", "page" ], "properties": { "id": { "type": "string" }, "page": { "type": "number" }, "text": { "type": "string" }, "is_pinned": { "type": "boolean" }, "author_url": { "type": "string" }, "is_hearted": { "type": "boolean" }, "like_count": { "type": "number" }, "author_name": { "type": "string" }, "reply_count": { "type": "number" }, "published_time": { "type": "string" }, "like_count_text": { "type": "string" }, "author_thumbnail_url": { "type": "string" } }, "additionalProperties": true } }, "pagination": { "type": "object", "required": [ "has_next_page", "next_continuation" ], "properties": { "has_next_page": { "type": "boolean" }, "next_continuation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "pages_fetched": { "type": "number" }, "pages_requested": { "type": "number" } }, "additionalProperties": true }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "youtube-video-comments", "task_name": "YouTube video comments", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runYoutubeVideoCommentsAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "YouTube video URL, short URL, or shorts URL. Preferred name; video_url remains supported." }, "pages": { "type": "integer", "default": 1, "maximum": 20, "minimum": 1, "description": "Number of comment pages to fetch (1-20)." }, "video_id": { "type": "string", "description": "YouTube video ID." }, "video_url": { "type": "string", "x-advanced": true, "description": "YouTube video URL, short URL, or shorts URL. You can also use url." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "anyOf": [ { "required": [ "video_url" ] }, { "required": [ "video_id" ] } ] }, "example": { "video_url": "https://example.com/item-1" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-youtube-video-comments" }, "x-browsable-website-login-required": false } }, "/v1/tasks/zillow-property/runs": { "post": { "tags": [ "Zillow" ], "summary": "Zillow Property API", "description": "Scrape a public Zillow property detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zillow-property", "task_name": "Zillow Property API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zillow-property", "task_name": "Zillow Property API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runZillowPropertyCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Zillow property URL returned by zillow/search.", "x-placeholder": "e.g. https://www.zillow.com/homedetails/123-Main-St-Seattle-WA-98101/12345_zpid/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.zillow.com/homedetails/123-Main-St-Seattle-WA-98101/12345_zpid/" } } } }, "x-browsable-website-login-required": false } }, "/v1/zillow/property": { "post": { "tags": [ "Zillow" ], "summary": "Zillow Property API", "description": "Scrape a public Zillow property detail page from a search result URL.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zillow-property", "task_name": "Zillow Property API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zillow-property", "task_name": "Zillow Property API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runZillowPropertyAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "Zillow property URL returned by zillow/search.", "x-placeholder": "e.g. https://www.zillow.com/homedetails/123-Main-St-Seattle-WA-98101/12345_zpid/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.zillow.com/homedetails/123-Main-St-Seattle-WA-98101/12345_zpid/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-zillow-property" }, "x-browsable-website-login-required": false } }, "/v1/tasks/zillow-search/runs": { "post": { "tags": [ "Zillow" ], "summary": "Zillow API", "description": "Scrape public Zillow search pages by location query.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zillow-search", "task_name": "Zillow API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zillow-search", "task_name": "Zillow API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runZillowSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Seattle, WA", "maxLength": 2000, "minLength": 1, "description": "City, neighborhood, ZIP code, or address.", "x-placeholder": "e.g. Seattle, WA" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Seattle, WA" } } } }, "x-browsable-website-login-required": false } }, "/v1/zillow/search": { "post": { "tags": [ "Zillow" ], "summary": "Zillow API", "description": "Scrape public Zillow search pages by location query.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zillow-search", "task_name": "Zillow API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zillow-search", "task_name": "Zillow API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runZillowSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Seattle, WA", "maxLength": 2000, "minLength": 1, "description": "City, neighborhood, ZIP code, or address.", "x-placeholder": "e.g. Seattle, WA" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Seattle, WA" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-zillow-search" }, "x-browsable-website-login-required": false } }, "/v1/tasks/zoopla-property/runs": { "post": { "tags": [ "Zoopla" ], "summary": "Zoopla Property API", "description": "Scrape a public Zoopla property page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zoopla-property", "task_name": "Zoopla Property API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zoopla-property", "task_name": "Zoopla Property API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runZooplaPropertyCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.zoopla.co.uk/for-sale/details/12345678/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.zoopla.co.uk/for-sale/details/12345678/" } } } }, "x-browsable-website-login-required": false } }, "/v1/zoopla/property": { "post": { "tags": [ "Zoopla" ], "summary": "Zoopla Property API", "description": "Scrape a public Zoopla property page.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zoopla-property", "task_name": "Zoopla Property API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zoopla-property", "task_name": "Zoopla Property API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runZooplaPropertyAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2000, "minLength": 1, "description": "URL returned by the matching search endpoint.", "x-placeholder": "e.g. https://www.zoopla.co.uk/for-sale/details/12345678/" }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "url" ] }, "example": { "url": "https://www.zoopla.co.uk/for-sale/details/12345678/" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-zoopla-property" }, "x-browsable-website-login-required": false } }, "/v1/tasks/zoopla-search/runs": { "post": { "tags": [ "Zoopla" ], "summary": "Zoopla API", "description": "Scrape public Zoopla property search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zoopla-search", "task_name": "Zoopla API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zoopla-search", "task_name": "Zoopla API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runZooplaSearchCanonical", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Bristol", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Bristol" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Bristol" } } } }, "x-browsable-website-login-required": false } }, "/v1/zoopla/search": { "post": { "tags": [ "Zoopla" ], "summary": "Zoopla API", "description": "Scrape public Zoopla property search results.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Run completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zoopla-search", "task_name": "Zoopla API", "run_status": "succeeded", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": { "url": "https://example.com/item-1", "data": {}, "count": 1, "query": "London", "source": "sample", "results": [ {} ], "success": true, "pagination": { "count": 1, "cursor": "cursor-page-1", "strategy": "sample", "next_cursor": "cursor-page-1", "has_next_page": true }, "max_results_requested": 1 }, "error": null } } } }, "202": { "description": "Run accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "run_id", "task_key", "task_name", "run_status", "status_url", "result", "error" ], "properties": { "run_id": { "type": "string", "format": "uuid" }, "task_key": { "type": "string" }, "task_name": { "type": "string" }, "run_status": { "type": "string", "enum": [ "queued", "waiting_for_auth", "running", "succeeded", "failed" ] }, "status_url": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "$schema": "https://json-schema.org/draft/2020-12/schema", "required": [ "success", "source", "query", "url", "results", "count", "data", "max_results_requested", "pagination" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "count": { "type": "integer" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "success": { "const": true }, "pagination": { "type": "object", "required": [ "cursor", "next_cursor", "has_next_page", "count", "strategy" ], "properties": { "count": { "type": "integer" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "has_next_page": { "type": "boolean" } }, "additionalProperties": false }, "max_results_requested": { "type": "integer" } }, "additionalProperties": false }, { "type": "null" } ] }, "error": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" }, "action": { "type": [ "string", "null" ] } } } } }, "example": { "run_id": "00000000-0000-4000-8000-000000000001", "task_key": "zoopla-search", "task_name": "Zoopla API", "run_status": "queued", "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001", "result": null, "error": null } } } }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "428": { "description": "A connected website account is required. Follow hosted_url to connect it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit reached. Honor Retry-After before retrying.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Service temporarily unavailable. Follow the response retryable and action fields.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "operationId": "runZooplaSearchAlias", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "integer", "default": 1, "maximum": 10000, "minimum": 1, "description": "Page number for sources that support page-based pagination." }, "limit": { "type": "integer", "default": 25, "maximum": 100, "minimum": 1, "description": "Maximum number of results to return." }, "query": { "type": "string", "x-sample": "Bristol", "maxLength": 2000, "minLength": 1, "description": "Search query.", "x-placeholder": "e.g. Bristol" }, "cursor": { "type": "string", "description": "Cursor returned as next_cursor from the previous response." }, "_run": { "type": "object", "description": "Optional execution controls for the run.", "additionalProperties": false, "properties": { "async": { "type": "boolean", "description": "When false, wait for the run to complete before returning. Defaults to true.", "default": true } } } }, "additionalProperties": false, "required": [ "query" ] }, "example": { "query": "Bristol" } } } }, "externalDocs": { "url": "https://browsable-api-ux-staging.pages.dev/docs/api/endpoints/post-zoopla-search" }, "x-browsable-website-login-required": false } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API key" } }, "schemas": { "Problem": { "type": "object", "required": [ "title", "status", "detail", "error", "request_id" ], "properties": { "type": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "error": { "type": "string" }, "request_id": { "type": "string" }, "error_code": { "type": [ "string", "null" ] }, "retryable": { "type": [ "boolean", "null" ] }, "action": { "type": [ "string", "null" ] }, "errors": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } } } } }