/new-query

Creates a new content writer query for a given keyword, language, and search engine.

• Method: POST
• Endpoint: https://app.neuronwriter.com/neuron-api/0.5/writer/new-query

Parameters

Parameter	Example	Description
project	e95fdd229fd98c10	The ID of your project (from the project URL or /list-projects).
keyword	trail running shoes	The keyword to generate a query and recommendations for.
engine	google.co.uk	Preferred search engine.
language	English	Content language.
additional_keywords	["off-road running shoes", "mountain running shoes"]	(Optional) Additional supporting keywords (list).
competitors_mode	top-intent	(Optional) How competitors are selected. Default top10 (TOP10 Google results). Other values: top30 (TOP30 results), top-intent (up to 10 best-ranking results matching the most popular user intent for the query).

Response

Key	Example	Description
query	32dee2a89374a722	The ID of your new query.
query_url	.../analysis/view/32dee2a89374a722	Browser URL of the query.
share_url	.../analysis/share/...	Shareable URL with edit & save access.
readonly_url	.../analysis/content-preview/...	Shareable read-only preview URL.

After creating a query it usually takes around 60 seconds before recommendations are ready. Poll /get-query and wait for status == "ready".

Example (Python)

import json, requests

API_ENDPOINT = 'https://app.neuronwriter.com/neuron-api/0.5/writer'
API_KEY = '<your-neuron-api-key>'

headers = {
    "X-API-KEY": API_KEY,
    "Accept": "application/json",
    "Content-Type": "application/json",
}

payload = json.dumps({
    "project": "c2fe46bce8019bff",
    "keyword": "trail running shoes",
    "engine": "google.co.uk",
    "language": "English",
    "additional_keywords": ["off-road running shoes", "mountain running shoes"],
    "competitors_mode": "top-intent",  # optional: recommendations based on top-intent URLs
})

response = requests.post(API_ENDPOINT + "/new-query", headers=headers, data=payload)
print(response.text)

Output:

{
  "query": "79ca6b6b45fb9d67",
  "query_url": "https://app.neuronwriter.com/analysis/view/79ca6b6b45fb9d67",
  "share_url": "https://app.neuronwriter.com/analysis/share/79ca6b6b45fb9d67/cceca0...",
  "readonly_url": "https://app.neuronwriter.com/analysis/content-preview/79ca6b6b45fb9d67/96e010..."
}