Skip to main content
GET
/
v1
/
scrapes
/
{scrape_id}
Retrieve scrape result
curl --request GET \
  --url https://api.olostep.com/v1/scrapes/{scrape_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "created": 123,
  "metadata": {},
  "url_to_scrape": "<string>",
  "result": {
    "html_content": "<string>",
    "markdown_content": "<string>",
    "json_content": "<string>",
    "screenshot_hosted_url": "<string>",
    "html_hosted_url": "<string>",
    "markdown_hosted_url": "<string>",
    "links_on_page": [
      "<string>"
    ],
    "page_metadata": {
      "status_code": 123,
      "title": "<string>"
    },
    "size_exceeded": true
  },
  "credits_consumed": 123,
  "cost_usd": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.olostep.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Path Parameters

scrape_id
string
required

Unique identifier for the scrape to be retrieved.

Response

Successful response with the scrape result.

id
string

Scrape ID

object
string

The kind of object. "scrape" for this endpoint.

created
number

Created epoch

metadata
object

User-defined metadata.

url_to_scrape
string

The URL that was scraped.

result
object
credits_consumed
integer | null

Number of credits consumed by this request. Populated after execution completes. Credits are the source of truth for billing.

cost_usd
number | null

Estimated cost in USD for this request. Populated after execution completes. Calculated from credits consumed and your plan rate — 99% accurate, but credits_consumed is the authoritative value.