NeuroViz
IntroductionQuickstartAuthenticationMCP ServerNEWAPI ReferenceAvailable Apps
n8n Guide

Quickstart Guide

Get up and running with the Neuroviz API in just a few minutes.

1

Get Your API Key

First, you'll need an API key to authenticate your requests. Sign up or log in at app.neuroviz.ai and navigate to the API Portal to create your key.

Keep your API key secret!
Never share your API key or commit it to public code repositories. Treat it like a password.
2

Choose an App

Browse the to find the one that fits your needs. Each app has a unique app_id you'll use in your requests.

3

Make Your First Request

Send a POST request to our API endpoint with your image and parameters.

cURL
curl -X POST 'https://app.neuroviz.ai/api/v1/run' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "app_id": "your-app-id",
  "parameters": {
    "image": "https://example.com/your-image.jpg"
  },
  "webhook_url": "https://your-server.com/webhook"
}'
4

Handle the Response

When you submit a request, you'll immediately receive a run_id:

Response
{
  "run_id": "abc123-def456-ghi789"
}

Image generation takes time (usually 10-60 seconds depending on the app). When processing completes, we'll send the result to your webhook URL.

5

Receive the Result

Your webhook endpoint will receive a POST request with the generation result:

Webhook Payload
{
  "run_id": "abc123-def456-ghi789",
  "status": "SUCCESS",
  "output_url": "https://cdn.neuroviz.ai/outputs/result.png",
  "thumbnail": "https://cdn.neuroviz.ai/outputs/result_thumb.png"
}
What's a webhook?
A webhook is a URL on your server that can receive data. When our processing finishes, we send the results to your webhook URL automatically. You'll need to set up an endpoint on your server to receive this data.

Next Steps