> For the complete documentation index, see [llms.txt](https://docs.axobug.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.axobug.com/api-reference.md).

# API reference

The endpoints, parameters and response formats you need to build with Neuro API v1.

## POST /api/v1/run

Send a JSON object with Content-Type: application/json. Every request starts an isolated experiment. All four fields are optional; an empty object uses the defaults below.

| Body field   | Type / accepted values              | Default |
| ------------ | ----------------------------------- | ------- |
| stimulus     | One of the ten stimulus IDs or none | sugar   |
| duration\_ms | Integer: 50, 100, 150, 200          | 100     |
| intensity    | Number: 0–2                         | 1       |
| seed         | Integer: 0–4294967295               | 42      |

| Query | Value          | Result                                             |
| ----- | -------------- | -------------------------------------------------- |
| view  | full (default) | Complete response, including frames and top\_types |
| view  | drive          | Same simulation; frames and top\_types omitted     |

```json
{
  "stimulus": "food",
  "duration_ms": 100,
  "intensity": 1,
  "seed": 42
}
```

## GET /api/v1/model

Returns the model ID, neuron and connection counts, supported stimuli, parameter limits and model limitations. Useful for populating a stimulus selector or checking compatibility. The endpoint supports cross-origin reads.

## GET /api/v1/openapi

Returns the machine-readable OpenAPI 3.1 description of the public endpoints and request parameters. Use it alongside these human-readable pages. It is a JSON resource, not an interactive documentation page.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>OpenAPI JSON</strong></td><td>Open the machine-readable API description.</td><td><a href="https://axobug.com/api/v1/openapi">https://axobug.com/api/v1/openapi</a></td></tr><tr><td><strong>Response guide</strong></td><td>Field meanings, units and how to map outputs into your project.</td><td></td></tr></tbody></table>

## Browser & transport support

POST /api/v1/run supports cross-origin requests and OPTIONS preflight with Content-Type. No credentials are needed. Full responses use gzip when the client accepts it; browsers decode that automatically. Keep requests event-driven and allow time for network latency.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.axobug.com/api-reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.