Search Cosmos elements
Search for visual references by keyword and retrieve element content, media, product metadata and source attribution. Choose a page size and continue with the returned cursor.
/v1/cosmos/searchx-api-keyHeaders
Get your API keyYour ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.
Required search text, 1 to 300 characters after trimming; control characters are rejected.
min 1 chars · max 300 chars
design referencesOpaque continuation for another page, or null. Supply it as the cursor request parameter with the same endpoint and inputs. Request cursors contain 1 to 4,096 characters and no control characters.
min 1 chars · max 4096 chars
Optional requested page size, 1 to 40; default 40.
20Request correlation UUID.
Source request attempts, decoded bytes and elapsed milliseconds.
Number of upstream request attempts.
≥ 0
Decoded source bytes read during this request.
≥ 0
Elapsed request time in milliseconds.
≥ 0
True when usable data is returned; inspect status and coverage.
success or partial for usable data; failed or challenged for a failure response.
one of: success, partial
Canonical Cosmos URL for the requested profile, element, collection or search.
absolute HTTPS URL
UTC retrieval timestamp.
Returned-result coverage and extraction warnings.
Public Cosmos API data.
Whether the returned result has no reported omissions.
Warnings explaining partial results or truncated fields.
Opaque continuation for another page, or null. Supply it as the cursor request parameter with the same endpoint and inputs. Request cursors contain 1 to 4,096 characters and no control characters.
Whether the returned cursor continues to another result page.
True for the worker’s terminal response when the cursor request parameter is the literal string null; omitted on ordinary source result pages.
Returned records in source order.
up to 40 items
Numeric Cosmos element ID.
≥ 0
Canonical Cosmos element URL.
absolute HTTPS URL
Published creation timestamp, or null.
Published element caption, or null.
Published text content, or null.
Published title, or null.
Published description, or null.
Public identity of the Cosmos account that owns the element, or null when unavailable.
Numeric Cosmos owner ID.
≥ 0
Owner’s Cosmos username.
Original source URL published with the element, or null.
Published original-source author details, or null.
Source author username, or null.
Source author display name, or null.
Source author profile URL, or null.
Source author avatar URL, or null.
Ordered media records attached to the element.
up to 40 items
Published media ID, or null.
Native Cosmos media type.
min 1 chars
Published media URL, or null.
Published media width in pixels, or null.
≥ 0
Published media height in pixels, or null.
≥ 0
Published AI-generated flag, or null.
Published media duration in seconds, or null.
≥ 0
Published thumbnail URL, or null.
Published video URL, or null.
Published playback URL, or null.
Published product price, or null.
Published numeric price value.
Published price currency.
Published product brand, or null.
Published timestamp when this element was saved in the collection, when present.
Published metadata associated with the ordered media records.
up to 40 items
Media ID linking the metadata to a media record, or null.
Published blur hash for a media placeholder, or null.
Published media safety label, or null.
Published source attribution metadata.
Published public-domain flag, or null.
Source-reported result count for the current search retrieval window, or null.
≥ 0
No fields match.
HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.
| HTTP | failure.code | Meaning |
|---|---|---|
| 200 | partial | Usable data with media_incomplete, media_limit, restricted_subcollections_omitted, subcollections_incomplete, subcollection_limit or record_limit coverage warnings. |
| 400 | invalid_request | Missing, duplicate, malformed, unsafe or unsupported request parameters. |
| 401 | unauthorized | Missing or invalid service API key. |
| 403 | restricted_page | The requested Cosmos content is not publicly accessible. |
| 404 | not_found | The requested public profile, element or collection was not found. |
| 429 | upstream_rate_limited | Cosmos temporarily rate-limited retrieval. |
| 502 | upstream_challenged | Cosmos challenged retrieval. |
| 502 | upstream_error | Source retrieval could not complete. |
| 502 | unsupported_page | The source response was incomplete, mismatched or unsupported. |
| 502 | response_too_large payload_too_complex | Source data exceeded the byte or parsing limits. |
| 502 | unsafe_redirect request_limit | The source redirect or request sequence exceeded the accepted contract. |
| 503 | busy | All Cosmos retrieval slots are in use. |
| 504 | timeout | The total operation deadline expired. |