Quickstart

Create an API key, try it from your agent, then make pages for 3 leads with curl.

Get your API key

  1. Open the app and go to Settings, API & MCP (https://neuropage.io/home/{workspace}/settings/api).
  2. Click Create key, give it a name, and copy the key. It starts with np_live_ and is shown once.

Good to know:

  • One key belongs to one workspace, and one workspace is one client. An agency makes one key per client workspace.
  • Workspaces are created in the app at https://neuropage.io/home. Signed in to the MCP server with your NeuroPage account (OAuth), an agent can also create one with create_workspace.
  • Reading works on any workspace. Changing anything (creating or editing brands, generating pages) needs a paid plan or a trial with a card on file; without one those calls return 403 plan_required with the billing link, and GET /workspace shows it in plan.
  • Treat the key like a password. Anyone with it can spend the workspace's credits.
  • Give a key a monthly credit cap when you create it (or later). A job that would pass the cap is refused with 402 spend_cap_reached.

Try it from your agent

This needs an agent connected to the MCP server; see Connect your AI agent. Then ask your agent, in this order:

  1. "Set up a NeuroPage brand from acme.com and show me the logo and colours it found."
  2. "Make NeuroPage landing pages for these 3 LinkedIn profiles with that brand: <3 profile URLs>."
  3. "Which of those leads have viewed their page?"

The agent checks your workspace, tells you what the pages will cost before it spends anything, waits for the pages, and gives you a table of leads and page URLs.

REST quickstart

Check the key and see your credits, brands and templates:

bash
curl https://neuropage.io/api/v1/workspace -H "Authorization: Bearer np_live_YOUR_KEY"

Make pages for 3 leads. Only linkedin_url is required; a name and company make nicer page URLs.

bash
curl -X POST https://neuropage.io/api/v1/jobs \
  -H "Authorization: Bearer np_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: my-first-job" \
  -d '{
    "type": "landing_page",
    "leads": [
      { "linkedin_url": "https://www.linkedin.com/in/jane-doe", "first_name": "Jane", "last_name": "Doe", "company": "Acme", "external_ref": "row-1" },
      { "linkedin_url": "https://www.linkedin.com/in/john-roe", "external_ref": "row-2" },
      { "linkedin_url": "https://www.linkedin.com/in/ana-lima", "external_ref": "row-3" }
    ]
  }'

The answer is a job with status running. Wait for it (the call returns as soon as something changes, or after 50 seconds):

bash
curl "https://neuropage.io/api/v1/jobs/job_...?wait=50" -H "Authorization: Bearer np_live_YOUR_KEY"

When the status is completed, list the pages:

bash
curl "https://neuropage.io/api/v1/assets?job_id=job_..." -H "Authorization: Bearer np_live_YOUR_KEY"

A few pages take about 1.5 to 3 minutes. 25 take longer.

What the objects are and how waiting, credits and limits work: Concepts. What each action costs: Credits and limits. Every endpoint: the API reference.