5 minutes

Quick Start Guide

Get up and running with Venym Search APIs in under 5 minutes. From API key generation to your first successful request.

What you'll learn

Get your API key
Make your first search request
Scrape a webpage
Handle responses and errors

Get Your API Key

Create Account & Generate Key

Navigate to your dashboard

Click "Generate API Key" → Copy your key (starts with sk_live_YOUR_API_KEY_API_KEY)

You get

5,000 free credits

to start

Keep your API key secure

Never expose your API key in client-side code. Store it as an environment variable and use it only in your backend services.

Authentication

All API requests require authentication using your API key in the request header.

Header Format

Required Authentication Header

cURL

Authorization: Bearer your_api_key_here

Alternative header formats

You can also use Authorization: Bearer your_key_here if your HTTP client doesn't support custom headers easily.

Your First API Call

Let's start with Search - our real-time web search API.

POST

https://www.search.venym.io/api/v1/search

Search the web in real-time and get structured results

Search the web for current information

# Replace with your actual API key from the dashboard
API_KEY="sk_live_YOUR_API_KEY_API_KEY_key_here"

curl -X POST https://www.search.venym.io/api/v1/search   -H "Authorization: Bearer $API_KEY"   -H "Content-Type: application/json" \
  -d '{
    "query": "latest AI developments 2025",
    "max_results": 5
  }' | jq '.'

Expected Response:

{
  "query": "latest AI developments 2025",
  "search_results": [
    {
      "title": "AI Breakthrough: New Language Model Achieves Human-Level Reasoning",
      "link": "https://example.com/ai-news",
      "snippet": "Researchers announce significant advancement in AI reasoning capabilities...",
      "position": 1,
      "date": "2025-07-20"
    }
  ],
  "credits_used": 1,
  "remaining_credits": 4999,
  "results_count": 5
}

Try Our Other APIs

Scrape - Web Scraping

POST

https://www.search.venym.io/api/v1/scrape

Extract content from any webpage, bypass protections

Research a topic across multiple sources

curl -X POST https://www.search.venym.io/api/v1/scrape   -H "Authorization: Bearer $API_KEY"   -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/article",
    "extract_options": ["title", "text", "metadata"]
  }' | jq '.primary_content.title'

Next Steps

Explore Full API Reference

Learn about all parameters, response formats, and advanced features.

Build Real Applications

Follow step-by-step guides to build complete applications.

Use SDKs & Integrations

Speed up development with official SDKs and integrations.

Monitor Usage

Track your API usage, credits, and performance metrics.

Need Help?

Stuck on something? Our developer support team is here to help.

# Replace with your actual API key from the dashboard API_KEY="sk_live_YOUR_API_KEY_API_KEY_key_here" curl -X POST https://www.search.venym.io/api/v1/search -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" \ -d '{ "query": "latest AI developments 2025", "max_results": 5 }' | jq '.'

{ "query": "latest AI developments 2025", "search_results": [ { "title": "AI Breakthrough: New Language Model Achieves Human-Level Reasoning", "link": "https://example.com/ai-news", "snippet": "Researchers announce significant advancement in AI reasoning capabilities...", "position": 1, "date": "2025-07-20" } ], "credits_used": 1, "remaining_credits": 4999, "results_count": 5 }

curl -X POST https://www.search.venym.io/api/v1/scrape -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/json" \ -d '{ "url": "https://example.com/article", "extract_options": ["title", "text", "metadata"] }' | jq '.primary_content.title'