Quickstart
Get up and running with Orsa in under 2 minutes.
1. Get Your API Key
Sign up at orsa.dev/signup (opens in a new tab) and create an API key from the dashboard (opens in a new tab).
2. Install the SDK
TypeScript / Node.js
npm install orsa
# or
pnpm add orsa
# or
yarn add orsaPython
pip install orsa3. Make Your First Request
Using cURL
curl -X GET "https://api.orsa.dev/v1/brand/retrieve?domain=stripe.com" \
-H "Authorization: Bearer YOUR_API_KEY"Using TypeScript
import Orsa from 'orsa';
const client = new Orsa({ apiKey: 'YOUR_API_KEY' });
const brand = await client.brand.retrieve({ domain: 'stripe.com' });
console.log(brand.name); // "Stripe"
console.log(brand.description); // "Financial infrastructure for the internet..."
console.log(brand.colors); // ["#635BFF", "#0A2540", "#00D4AA"]
console.log(brand.logos); // [{ url: "https://...", type: "svg", theme: "light" }]
console.log(brand.socials); // { twitter: "https://twitter.com/stripe", ... }Using Python
from orsa import Orsa
client = Orsa(api_key="YOUR_API_KEY")
brand = client.brand.retrieve(domain="stripe.com")
print(brand.name) # "Stripe"
print(brand.description) # "Financial infrastructure for the internet..."
print(brand.colors) # ["#635BFF", "#0A2540", "#00D4AA"]4. Try More Endpoints
Scrape a page as Markdown
const page = await client.web.scrapeMarkdown({
url: 'https://stripe.com/pricing',
});
console.log(page.markdown); // Clean markdown contentAI-powered data extraction
const data = await client.ai.query({
domain: 'stripe.com',
data_to_extract: 'all pricing plans with features and prices',
});
console.log(data.result); // Structured extractionScreenshot
const screenshot = await client.brand.screenshot({
domain: 'stripe.com',
format: 'png',
width: 1440,
});
console.log(screenshot.url); // CDN URL of the screenshotNext Steps
- Authentication — Learn about API key management
- Core Concepts — Understand credits, caching, and rate limits
- API Reference — Full endpoint documentation
- TypeScript SDK — Complete SDK reference