canonical: https://jentic.com/apis/neuronwriter.com/neuronwriter # NeuronWriter API The NeuronWriter API automates SEO content optimisation by giving programmatic access to projects, content analysis queries, on-page recommendations, and content scoring. Teams can create new keyword analysis queries, list and retrieve projects, pull recommended terms and outlines, push draft content into the editor, and evaluate content scores without saving the result. Access requires a Gold-tier subscription or higher and is gated by an X-API-KEY header. ## For AI agents Run SEO content analyses, fetch keyword recommendations, and score draft content against target keywords inside NeuronWriter projects. ## Scope Does not handle backlink analysis, keyword volume research, or rank tracking - use for on-page SEO content analysis and scoring only. ## Capabilities - List all NeuronWriter projects available to the authenticated workspace - Create a new content analysis query for a target keyword and language inside a project - Retrieve content recommendations including target terms, outline, and competitor data for an existing query - List queries within a project filtered by status, language, or creation date - Pull saved draft content for a query so an external editor can sync the latest version - Import draft content into the NeuronWriter editor and persist it against a query - Evaluate the content score for a draft against a query's recommendations without saving the draft ## Use cases ### Automated Brief Generation Content teams call POST /new-query to spawn a NeuronWriter analysis the moment a new keyword is approved in their editorial calendar, then call POST /get-query to retrieve the resulting target terms, suggested outline, and competitor signals. The brief lands in the writer's queue without any manual setup inside the NeuronWriter UI. Example prompt: Call POST /new-query with the keyword and language, poll POST /get-query until status is completed, and write the recommended terms and outline to the team's content management system. ### Pre-Publish Content Scoring Editors gate publication on a minimum NeuronWriter content score by calling POST /evaluate-content with the draft body and the target query identifier. The endpoint returns the score without persisting the draft, so authors can iterate locally until they hit the threshold before pushing through POST /import-content. Example prompt: POST /evaluate-content with the draft markdown and query_id, parse the score, and block publication if the score is below 70 by raising a workflow error. ### CMS Sync of Optimisation State Marketing operations teams keep their CMS aligned with NeuronWriter by listing queries through POST /list-queries on a schedule, retrieving each query's recommendations, and updating the corresponding CMS entry with the latest target terms and score. This avoids drift between the SEO tool and the publishing surface. Example prompt: Run POST /list-queries nightly, iterate the returned queries, fetch each via POST /get-query, and upsert the recommendations into the CMS post record keyed by query_id. ### AI Agent SEO Editor An AI writing agent uses Jentic to discover NeuronWriter operations, drafts an article in its own loop, calls POST /evaluate-content to check the score, and iterates the draft until it clears the threshold. Once the score is acceptable, the agent calls POST /import-content to persist the final draft into NeuronWriter. Example prompt: Use Jentic to search 'evaluate seo content score', load POST /evaluate-content, run it after each draft revision, and call POST /import-content once the score crosses the configured threshold. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/list-projects` | List all projects | | POST | `/new-query` | Create a content analysis query | | POST | `/get-query` | Get content recommendations for a query | | POST | `/list-queries` | List queries matching criteria | | POST | `/get-content` | Get saved content for a query | | POST | `/import-content` | Import content into the editor | | POST | `/evaluate-content` | Evaluate content score without saving | ## Key resources - **Projects** — List NeuronWriter projects available in the workspace - **Queries** — Create, list, and retrieve content analysis queries inside a project - **Content** — Retrieve, import, and evaluate draft content against a query's recommendations ## Why Jentic - **Setup:** Wiring the NeuronWriter API by hand means setting its X-API-KEY header, targeting the app.neuronwriter.com/neuron-api/0.5/writer host, and shaping project, query, and content-evaluation payloads yourself. Through Jentic you install once, import NeuronWriter from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** NeuronWriter takes its project and query ids in the request body, so limit the agent to the operations it needs, such as evaluating content or creating a new query, and leave out the ones it should not run. - **Credential handling:** Your NeuronWriter X-API-KEY is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'evaluate an SEO content score' or 'create a new content query', and Jentic returns the matching NeuronWriter operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Semrush API** — Broader SEO platform covering keyword research, backlinks, and rankings - **Ahrefs API** — SEO data API focused on backlinks, keywords, and site audits - **OpenAI API** — Generate the article drafts that NeuronWriter then scores ## FAQ ### What authentication does the NeuronWriter API use? NeuronWriter authenticates via an API key sent in the X-API-KEY header. The key requires a Gold-tier plan or higher. Through Jentic, the API key is stored in the encrypted Jentic One instance and injected at request time so it never reaches the agent's context. ### Can I create a content analysis query through the NeuronWriter API? Yes. POST /new-query accepts a project identifier, target keyword, and language, then queues an analysis. Once the analysis is ready, POST /get-query returns the recommended terms, outline, and competitor data for that query. ### How do I score draft content against a target keyword through Jentic? Search Jentic for 'evaluate neuronwriter content score', load POST /evaluate-content, and execute it with the draft body and query_id. The endpoint returns the content score without saving the draft, so it is safe to call repeatedly while iterating. ### What are the rate limits for the NeuronWriter API? The spec does not publish explicit numeric rate limits. NeuronWriter throttles by plan tier - Gold and above include the API. Treat /new-query and /evaluate-content as the heaviest calls and back off on 429 responses. ### Can I import a finished article back into NeuronWriter? Yes. POST /import-content accepts the query identifier and the draft body and saves the content against that query. This is the endpoint to call once an external editor or AI agent has finished a draft. ### Is the NeuronWriter API free? API access requires a NeuronWriter subscription at the Gold tier or higher. The free trial does not include API access. ### Can I limit what my agent is allowed to do with the NeuronWriter API? Yes. Because you run Jentic One yourself, your own rules decide which NeuronWriter operations the agent can call and which credentials it may use. You can allow it to evaluate a draft with POST /evaluate-content and read recommendations via POST /get-query while withholding write operations like POST /import-content or POST /new-query. Since project and query ids travel in the request body, you scope access at the operation level, granting only the calls each agent needs.