Documentation

Quickstart

Last updated: 25 September 2026

Run your first Ask Xverum query in under a minute.

Try it first — no API key required

Xverum serves a small, fixed synthetic demo catalogue with no key and no credits, so you can see the exact response shapes before you sign up. Every demo person is fictional — note the Demo surnames; no id is a real person.

# List the synthetic demo catalogue
curl "https://search-api.xverum.com/v1/demo/profiles"

# Fetch one synthetic profile — 9990000001 is "Maya Demo", an AI Engineer
curl "https://search-api.xverum.com/v1/demo/profiles/9990000001"

# Predict a job change for the same synthetic profile
curl "https://search-api.xverum.com/v1/demo/profiles/9990000001/job-change"

When you're ready for real data, get an API key and use the authenticated flow below.

1. Get your API key

Your API key is available in your Xverum dashboard — no need to contact support. Treat it like a password — don't commit it to version control. See Authentication.

2. Make a request

curl -X POST https://search-api.xverum.com/v1/search \
  -H "x-api-key: XVERUM-API-KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "senior Python developers with Kubernetes in Seattle"
  }'

3. Read the response

{
  "result_type": "people",
  "results": [
    {
      "id": "a1b2c3d4",
      "social_url": "https://www.linkedin.com/in/jane-doe-sea",
      "full_name": "Jane Doe",
      "headline": "Senior Python Engineer at Acme",
      "location": "Seattle, WA",
      "company_name": "Acme",
      "position": "Senior Python Engineer",
      "industry": "software",
      "evidence_summary": "Verified last 30 days"
    },
    …
  ],
  "total_count": 128,
  "page": 1,
  "page_size": 10,
  "credits_used": 10,
  "credits_remaining": 4990,
  "request_id": "8b1d4f0c12a44b7a"
}

4. Fetch a full profile

Take any id from the results and pull that person's complete profile — employment history, education and profile summary. One shape, 4 credits:

curl "https://search-api.xverum.com/v1/profiles/a1b2c3d4" \
  -H "x-api-key: XVERUM-API-KEY"

Next steps

See the full /v1/search reference for pagination and response fields.
Fetch profiles directly with /v1/profiles/{id}.
Understand the error model and rate limits before going to production.