QUICKSTART5 minutes

Quick Start Guide

Create a key, validate it without a charge, run Search, and scrape a page using the live Venym Search API.

Create account Authentication

Canonical production origin

All examples use https://search.venym.io.

Create an API key

Create a Venym Search account.

Open Dashboard

Go to API Keys after signing in.

Keep it server-side

Store the key in VENYM_SEARCH_API_KEY.

Validate the key

Validation is free and returns the active state, plan, and current credit balance.

GET /api/v1/validatecURL

curl https://search.venym.io/api/v1/validate \
  -H "Authorization: Bearer $VENYM_SEARCH_API_KEY"

Run your first Search

POSThttps://search.venym.io/api/v1/search

Search uses a 2-credit base charge. Set auto_scrape_top only when you need page content.

First Search request

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

Scrape a page

POSThttps://search.venym.io/api/v1/scrape

Scrape accepts one URL and returns structured primary_content.

First Scrape requestcURL

curl -X POST https://search.venym.io/api/v1/scrape \
  -H "Authorization: Bearer $VENYM_SEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"url":"https://example.com","extract_options":["title","text"]}'

Handle responses

200

Read the response body and credits_used.

401 / 403

Fix the key or upgrade for a gated feature.

429 / 500

Honor Retry-After or use request_id for support.

Search reference Scrape reference Errors

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

curl -X POST https://search.venym.io/api/v1/scrape \ -H "Authorization: Bearer $VENYM_SEARCH_API_KEY" \ -H "Content-Type: application/json" \ --data '{"url":"https://example.com","extract_options":["title","text"]}'