Module 09 · API
StellarFirm API
The public StellarFirm API for developers and agents. Authentication, every route, example requests, and every error, with an OpenAPI 3.1 file you can load into a tool.
On this page
StellarFirm has a small public HTTP API. It lets a developer or an agent check that the site is up, read the site notice, and ask about the signed-in account. Every answer is JSON, and every failure has the same shape, so a program can tell what went wrong without reading a web page.
At a glance#
| Question | Answer |
|---|---|
| Base address | https://stellarfirm.ai |
| Format | JSON, and plain text for the unsubscribe route |
| Machine-readable spec | /openapi.json (OpenAPI 3.1), also as YAML |
| Sign-in | Public routes need none. Account routes need the session of a signed-in account. |
| Errors | One shape for every failure, with a stable error.code |
In this section#
| Page | What it covers |
|---|---|
| Authentication | Which routes need a sign-in, and how to send the session. |
| Endpoints | Every route, its method, and what it answers. |
| Example requests | Requests you can copy, with the answers you get back. |
| Errors | The error shape and every error.code. |
For agents#
If you are an AI agent, start with the agent instructions. They say when to use StellarFirm and how to reach it. The site map for assistants is llms.txt.
Related#
- The Getting started section explains the product behind the API.
- Questions about the API can go to hey@astrocode.tech.