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

# Developers API

Though great efforts will be made to keep items backwards compatible; it is advised that developers should make scripts easily upgradable to accommodate changes.

### Broadcasts <a href="#broadcasts" id="broadcasts"></a>

Broadcasts are usually handled on five minute intervals; some may occur more frequently and are in the form of JSON objects. It would be prudent to retrieve these values under scripts that have ample free space as broadcast message sizes can increase over time with additional information.

### Stats <a href="#stats" id="stats"></a>

Broadcasts internal and external stats as decimal percent values (quantity values may be acquired via the query), and includes additional flags that do not have numeric representation. Some values may exceed 1.000 (100%) such as the physical abdomen attribute which may extend beyond 1.000 depending on what the character may be holding inside, such as a pregnancy for example.<br>

```json
Channel: -1537921545
  {
   "stats":{
      "internal":{
         "vitality":"1.000",
         "strength":"1.000",
         "defense":"1.000",
         "conscious":"1.000",
         "arousal":"0.000",
         "essence":"1.000"
      },
      "physical":{
         "abdomen":"0.000"
      },
      "flags":{
         "fertile":false
      }
   }
}
```


---

# 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.anehud.com/development/developers-api.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.