Introduction
NeuronWriter API gives you programatic access to our recommendations. With it you can for instance:
- Add new queries in bulk and retrieve the share URLs
- Integrate NeuronWriter recommendations in your content generation process
(This is a beta version of our API. If you face any issues or have any thoughts on how we can improve our API, please add your feedback. Thank you!)
The quickest way to start might be to jump straight to the usage examples at the end of these docs.
Requirements / costs
This feature requires Gold plan or higher.
API requests consume your monthly limits (there is no difference whether you create a new query via NeuronWriter interface or API, the cost is the same)
It is advised to have a basic understanding of how APIs/HTTP requests work and a bit of experience in your favorite programming language (Python, PHP, Java, …)
How to obtain your API key?
Open your profile, visit the “Neuron API access” tab and copy your API key:
API access:
API endpoint:
Please use the following API endpoint:
https://app.neuronwriter.com/neuron-api/0.5/writer (+ API method)
Authentication:
Each request to the API has to include the X-API-KEY HTTP header with your Neuron API key.
API methods
The methods have been described below. Unless specified otherwise, each of these methods is requested via POST request.
/list-projects
Retrieves a list of projects within the used account.
Parameters:
None required
Response:
A list of projects:
[{"project": "ed0b47151fb35b02", "name": "adidas.com", "language": "English", "engine": "google.co.uk"}, {"project": "e6a3198027aa1b96", "name": "asics.com", "language": "English", "engine": "google.co.uk"}, {"project": "688b8de5e6774060", "name": "nike.com", "language": "English", "engine": "google.co.uk"}]/new-query
Creates a new content writer query for a given keyword, language and search engine.
Parameters:
| parameter | example value | description |
|---|---|---|
| project | e95fdd229fd98c10 | The ID of your project taken from project’s URL: https://app.neuronwriter.com/project/view/75a454f6ae5976e8 -> e95fdd229fd98c10 |
| keyword | trail running shoes | The keyword you want to generate a query (and recommendations) for. |
| engine | google.co.uk | Preferred search engine. |
| language | English | Content language. |
Response:
| key | example value | description |
|---|---|---|
| query | 32dee2a89374a722 | The ID of your new query. |
| query_url | https://app.neuronwriter.com/analysis/view/32dee2a89374a722 | The URL of your query (accessible from browser) |
| share_url | https://app.neuronwriter.com/analysis/share/32dee2a89374a722/c63b64f6b13a064c12b78dac7dc3410c1 | URL for sharing the query (with edit&save access) |
| readonly_url | https://app.neuronwriter.com/analysis/content-preview/32dee2a89374a722/02db6ba3e78557302723220bdef73c771 | URL for sharing the query (readonly preview) |
/get-query
Retrieves content recommendations for a given query. Any query, doesn’t have to be created via API.
After creating a new query with /new-query request it usually takes around 60 seconds until we prepare the recommendations.
With /get-query request you can check whether we’ve finished the analysis (status==’ready’) and if we did, the recommendations are available in the response.
Parameters:
| parameter | example value | description |
|---|---|---|
| query | 32dee2a89374a722 | The ID of your query. |
Response:
| key | example value | description |
|---|---|---|
| status | ready | Whether your query has already been processed. Possible values include: not found, waiting, in progress, ready If status==’ready’, keys below are added too. |
| metrics | {‘word_count’: {‘median’: 1864, ‘target’: 1864}, ‘readability’: {‘median’: 40, ‘target’: 40}} | General recommendations such as typical content length. |
| terms_txt | {‘title’: ‘running shoenwinter running shoenbest winter running shoenwinter running shoes of 2024’, ‘desc_title’: ‘running shoenwinter running shoenbest winter running shoentractionnbest pairsnwinter running shoes of 2024n2024ntrail runningnshoes for runningnrunning in the winternfeet warmnwinter shoes’, ‘h1’: ‘running shoe… | Content term suggestions (title, desc, h1, h2, content_basic, content_extended) in text format. Good to be used for Chat GPT prompts, etc. |
| terms | {‘title’: [{‘t’: ‘running shoe’, ‘usage_pc’: 88}, {‘t’: ‘winter running shoe’, ‘usage_pc’: 75}, {‘t’: ‘best winter running shoe’, ‘usage_pc’: 62}, {‘t’: ‘winter running shoes of 2024’, ‘usage_pc’: 50}], ‘desc’: [{‘t’: ‘running shoe’, ‘usage_pc’: 25}, {‘t’: ‘winter running shoe’, ‘usage_pc’: 25}, {‘t’: ‘best winter running shoe’, ‘usage_pc’: 25}, … ‘content_basic’: [{‘t’: ‘running shoe’, ‘usage_pc’: 88, ‘sugg_usage’: [1, 32]}, {‘t’: ‘winter running shoe’, ‘usage_pc’: 88, ‘sugg_usage’: [1, 9]}, {‘t’: ‘best winter running shoe’, ‘usage_pc’: 75, ‘sugg_usage’: [1, 2]}, {‘t’: ‘winter running shoes of 2024’, ‘usage_pc’: 50, ‘sugg_usage’: [1, 1]}, {‘t’: ‘2024’, ‘usage_pc’: 75, ‘sugg_usage’: [1, 2]}, {‘t’: ‘traction’, ‘usage_pc’: 62, ‘sugg_usage’: [1, 16]}, {‘t’: ‘outsole’, ‘usage_pc’: 62, ‘sugg_usage’: [1, 19]}, …], ‘entities’: [{‘t’: ‘Trail running’, ‘importance’: 27.31264, ‘relevance’: 0.42676, ‘confidence’: 3.2872, ‘links’: [[‘wikipedia’, ”]]}, …]} | Detailed information about the content terms. |
| ideas | {‘suggest_questions’: [{‘q’: ‘where to buy trail running shoes’}, {‘q’: ‘are trail running shoes comfortable’}, …], ‘people_also_ask’: [{‘q’: ‘What is the difference between a running shoe and a trail running shoe?’}, {‘q’: ‘Can running shoes be used for trail?’}, …], ‘content_questions’: [{‘q’: ‘Can I use road running shoes for trail running?’}, {‘q’: ‘How many miles do trail running shoes last?’}, …]} | Questions related to the topic (suggest questions, People Also Ask, questions extracted from content) |
| competitors | [{‘rank’: 1, ‘url’: ‘https://www.runnersworld.com/gear/a22115120/best-trail-running-shoes/‘, ‘title’: ‘The 11 Best Trail Running Shoes of 2024 – Best Off-Road Running Shoes’, ‘desc’: ‘Check out the Runner’s World editors’ picks for the 11 best trail and off-road running shoes so far in 2024. ‘}, …], | Basic information about the SERP competitors. |
/list-queries
Retrieves queries within a project matching your criteria and provides information about their status (whether they’re ready, etc.).
Parameters:
| parameter | example value | description |
|---|---|---|
| project | 0c30b6a4f8b2b412 | The ID of your project. |
| status | ready | Query status – possible values: waiting, in progress, ready |
| source | neuron-api | How was the query created – possible values: neuron, neuron-api |
| created | 2024-01-19T14:48:31+00:00 | Creation date for a query |
| updated | 2024-01-19T14:49:52+00:00 | Query update (when the query is ready) |
| keyword | trail running shoes | Main keyword for the query |
| language | English | Language used during analysis. |
| engine | google.com | Search engine used during analysis. |
| tags | Done | You can limit the results to queries with one or more tags. You can either provide a single tag as a string, e.g.: Done or a list of tags such as (all have to be present): [‘MyNewTag’, ‘Done’,] |
Response:
A list of queries:
[{'query': 'a6d0fb2bf9a7a2be', 'created': '2024-01-19T14:48:31+00:00', 'updated': '2024-01-19T14:49:52+00:00', 'keyword': 'how should running shoes fit', 'language': 'English', 'engine': 'google.co.uk', 'source': 'neuron-api', 'tags': ['Done']}, {'query': 'bdc73d8e0057ed8f', 'created': '2024-01-19T14:48:31+00:00', 'updated': '2024-01-19T14:49:52+00:00', 'keyword': 'trail running shoes for winter', 'language': 'English', 'engine': 'google.co.uk', 'source': 'neuron-api', 'tags': ['Done']}]/get-content
Retrieves the last content revision saved for a given query. Any query, doesn’t have to be created via API.
You can choose between manually saved revisions (default) or all (including autosave revisions)
Parameters:
| parameter | example value | description |
|---|---|---|
| query | 32dee2a89374a722 | The ID of your query. |
| revision_type | all | Whether autosave revisions should be considered or not |
Response:
| key | example value | description |
|---|---|---|
| content |
Top 10 Best Winter Running Shoes of 2024 – Find the Perfect Pair for Cold Weather Runs Winter running shoes are designed to provide the necessary support, comfort, and protection for running in cold and icy conditions. The top winter running shoes of 2024 not only keep your feet warm and dry but also offer traction and stability on slippery surfaces…. |
Content in HTML format |
| title | Top 10 Best Winter Running Shoes of 2024 – Find the Perfect Pair for Cold Weather Runs | Title |
| description | Discover the top 10 best winter running shoes of 2024 for staying warm and steady on your cold weather runs. Find the perfect pair with great traction! | Meta description |
| created | 2024-01-19T14:49:52+00:00 | Revision date |
| type | manual | Revision type (manual or autosave) |
/import-content
Allows you to update the editor content via API for a given query. Any query, doesn’t have to be created via API.
You can either import the HTML or send the URL that we will try to auto-import and parse content from. One of these two has to be provided.
Parameters:
| parameter | example value | description |
|---|---|---|
| query | 32dee2a89374a722 | The ID of your query. |
| html |
Best Trail Running Shoes in 2024: A Complete Guide As a trail runner, choosing the right pair of trail running shoes… |
HTML content to import |
| title | “Best Trail Running Shoes in 2024: A Complete Guide” | [optional] |