Ruby

The Ruby SDK requires Ruby 3.2 or newer.

Install the SDK

gem install context.dev

Set your API key

Get a secret API key from the dashboard. Set it in the terminal where you will run the example:

export CONTEXT_DEV_API_KEY="ctxt_secret_..."

Keep the key in server-side code. Do not expose it in a browser or commit it to source control.

Scrape a webpage

Save this as scrape.rb:

scrape.rb

require "cgi/core"
require "context_dev"

client = ContextDev::Client.new(
  api_key: ENV.fetch("CONTEXT_DEV_API_KEY")
)

response = client.web.web_scrape_md(
  url: "https://example.com",
  use_main_content_only: true,
)

puts response.markdown

Run it with the Ruby installation used above:

ruby scrape.rb

If your project has a Gemfile, add gem "context.dev", run bundle install, and use bundle exec ruby scrape.rb.

Check the result

The example prints the page content as Markdown. Look for the Example Domain heading; the remaining text and formatting may vary.

Expected heading

# Example Domain

If you receive an error, check the key and request details in Troubleshooting. See the Markdown API reference for all parameters and response fields.

Retrieve brand data

Replace the request and final puts with this lookup. It prints the matched company name.

response = client.brand.retrieve(
  body: { type: :by_domain, domain: "stripe.com" }
)

puts response.brand.title

Get started

Web data

Brand data

Automation

Production

Install the SDK

Set your API key

Scrape a webpage

Check the result

Retrieve brand data

Next steps

Scrape a webpage

Retrieve brand data

​Install the SDK

​Set your API key

​Scrape a webpage

​Check the result

​Retrieve brand data

​Next steps

Scrape a webpage

Retrieve brand data

Install the SDK

Set your API key

Scrape a webpage

Check the result

Retrieve brand data

Next steps