Build with Vsyble search

The Vsyble API gives scripts, services, and command-line workflows direct access to people search, company search, and enrichment. Every request uses a revocable API key and your Vsyble search allowances.

API origin

https://api.vsyble.comOpenAPI specification

Quick start

Create an API key in Vsyble, store it outside your source code, and send it in the X-Vsyble-Api-Key header.

curl https://api.vsyble.com/v1/people/search \
  --request POST \
  --header "Content-Type: application/json" \
  --header "X-Vsyble-Api-Key: $VSYBLE_API_KEY" \
  --data '{
    "query": "Revenue leaders at B2B software companies",
    "limit": 5,
    "search_type": "fast",
    "filters": {
      "seniority": "executive",
      "requireLinkedIn": true
    }
  }'
Manage API keys

Endpoints

POST /v1/people/search

Find professionals by role, company, location, experience, seniority, and LinkedIn availability.

POST /v1/companies/search

Find companies using firmographic, funding, hiring, and technology filters.

POST /v1/enrich

Enrich selected result numbers from the latest search made with the same API key.

Company search

Every search requires an exact limit from 1 to 25. Use search_type when you need to trade research depth for latency; auto is the default.

curl https://api.vsyble.com/v1/companies/search \
  --request POST \
  --header "Content-Type: application/json" \
  --header "X-Vsyble-Api-Key: $VSYBLE_API_KEY" \
  --data '{
    "query": "AI infrastructure companies hiring sales leaders",
    "limit": 10,
    "filters": {
      "employeeRange": "51-200",
      "hiringOnly": true
    }
  }'

Enrichment

Search first, then pass the 1-based result numbers you want to enrich. People enrichment requires one field: email, phone, or university. Company enrichment omits the field. Repeat the same request to continue work that is still running.

curl https://api.vsyble.com/v1/enrich \
  --request POST \
  --header "Content-Type: application/json" \
  --header "X-Vsyble-Api-Key: $VSYBLE_API_KEY" \
  --data '{
    "result_numbers": [1, 3],
    "field": "email"
  }'

Errors and limits

Errors use a JSON error object with a stable code and a concise message. Responses may also include a request ID and retry delay.

The edge allows up to 60 requests per minute per API key and 120 requests per minute per client address. Account quotas, credential spend limits, and enrichment allowances are enforced separately.

Keep API keys server-side. Revoke a key immediately if it is exposed, and use a separate key for each application or environment.

MCP and CLI access

Use the hosted MCP endpoint when an AI client supports browser OAuth. For terminal workflows, install the Vsyble package and run npx vsyble setup.

MCP documentationVsyble on npm