Skip to content
scrapeatlas.Dashboard

Search Cosmos elements

Try in Playground

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.

GET/v1/cosmos/searchx-api-key
x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters
3
querystringrequiredquery

Required search text, 1 to 300 characters after trimming; control characters are rejected.

min 1 chars · max 300 chars

Exampledesign references
cursorstringquery

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.

min 1 chars · max 4096 chars

limitstringquery

Optional requested page size, 1 to 40; default 40.

Example20
Response fields
56
requestIdstring

Request correlation UUID.

Source request attempts, decoded bytes and elapsed milliseconds.

accounting.upstreamRequestsinteger

Number of upstream request attempts.

≥ 0

accounting.responseBytesinteger

Decoded source bytes read during this request.

≥ 0

accounting.durationMsnumber

Elapsed request time in milliseconds.

≥ 0

successboolean

True when usable data is returned; inspect status and coverage.

statusenum

success or partial for usable data; failed or challenged for a failure response.

one of: success, partial

sourceUrlstring

Canonical Cosmos URL for the requested profile, element, collection or search.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Returned-result coverage and extraction warnings.

coverage.sourcestring

Public Cosmos API data.

coverage.completeboolean

Whether the returned result has no reported omissions.

coverage.warningsstring[]

Warnings explaining partial results or truncated fields.

cursorstringnullable

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.

has_moreboolean

Whether the returned cursor continues to another result page.

end_of_paginationbooleanoptional

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

items.idinteger

Numeric Cosmos element ID.

≥ 0

items.urlstring

Canonical Cosmos element URL.

absolute HTTPS URL

items.created_atstringnullable

Published creation timestamp, or null.

items.captionstringnullable

Published element caption, or null.

items.textstringnullable

Published text content, or null.

items.titlestringnullable

Published title, or null.

items.descriptionstringnullable

Published description, or null.

Public identity of the Cosmos account that owns the element, or null when unavailable.

items.owner.idinteger

Numeric Cosmos owner ID.

≥ 0

items.owner.usernamestring

Owner’s Cosmos username.

items.source_urlstringnullable

Original source URL published with the element, or null.

Published original-source author details, or null.

items.source_author.usernamestringnullable

Source author username, or null.

items.source_author.full_namestringnullable

Source author display name, or null.

items.source_author.profile_urlstringnullable

Source author profile URL, or null.

items.source_author.avatar_urlstringnullable

Source author avatar URL, or null.

Ordered media records attached to the element.

up to 40 items

items.media.idstringnullable

Published media ID, or null.

items.media.typestring

Native Cosmos media type.

min 1 chars

items.media.urlstringnullable

Published media URL, or null.

items.media.widthnumbernullable

Published media width in pixels, or null.

≥ 0

items.media.heightnumbernullable

Published media height in pixels, or null.

≥ 0

items.media.ai_generatedbooleannullable

Published AI-generated flag, or null.

items.media.durationnumbernullable

Published media duration in seconds, or null.

≥ 0

items.media.thumbnail_urlstringnullable

Published thumbnail URL, or null.

items.media.video_urlstringnullable

Published video URL, or null.

items.media.playback_urlstringnullable

Published playback URL, or null.

Published product price, or null.

items.price.valuenumber

Published numeric price value.

items.price.currencystring

Published price currency.

items.brandstringnullable

Published product brand, or null.

items.saved_atstringnullableoptional

Published timestamp when this element was saved in the collection, when present.

Published metadata associated with the ordered media records.

up to 40 items

items.mediaMetadata.idstringnullable

Media ID linking the metadata to a media record, or null.

items.mediaMetadata.blurHashstringnullable

Published blur hash for a media placeholder, or null.

items.mediaMetadata.safetyStatusstringnullable

Published media safety label, or null.

Published source attribution metadata.

items.sourceMetadata.isPublicDomainbooleannullable

Published public-domain flag, or null.

result_countintegernullable

Source-reported result count for the current search retrieval window, or null.

≥ 0

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.

Error codes
13
HTTPfailure.codeMeaning
200partialUsable data with media_incomplete, media_limit, restricted_subcollections_omitted, subcollections_incomplete, subcollection_limit or record_limit coverage warnings.
400invalid_requestMissing, duplicate, malformed, unsafe or unsupported request parameters.
401unauthorizedMissing or invalid service API key.
403restricted_pageThe requested Cosmos content is not publicly accessible.
404not_foundThe requested public profile, element or collection was not found.
429upstream_rate_limitedCosmos temporarily rate-limited retrieval.
502upstream_challengedCosmos challenged retrieval.
502upstream_errorSource retrieval could not complete.
502unsupported_pageThe source response was incomplete, mismatched or unsupported.
502response_too_large payload_too_complexSource data exceeded the byte or parsing limits.
502unsafe_redirect request_limitThe source redirect or request sequence exceeded the accepted contract.
503busyAll Cosmos retrieval slots are in use.
504timeoutThe total operation deadline expired.