# 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.

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.

> [!NOTE]
> The StellarFirm API is for reading and checking. Nothing in it sends, publishes, deploys, or charges. Anything like that waits for the CEO's Approve inside the app. See [Approvals](/docs/ceo/approvals).

## At a glance

| Question | Answer |
| --- | --- |
| Base address | `https://stellarfirm.ai` |
| Format | JSON, and plain text for the unsubscribe route |
| Machine-readable spec | [`/openapi.json`](https://stellarfirm.ai/openapi.json) (OpenAPI 3.1), also as [YAML](https://stellarfirm.ai/openapi.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](/docs/api/authentication) | Which routes need a sign-in, and how to send the session. |
| [Endpoints](/docs/api/endpoints) | Every route, its method, and what it answers. |
| [Example requests](/docs/api/examples) | Requests you can copy, with the answers you get back. |
| [Errors](/docs/api/errors) | The error shape and every `error.code`. |

## For agents

If you are an AI agent, start with the [agent instructions](https://stellarfirm.ai/agents.md). They say when to use StellarFirm and how to reach it. The site map for assistants is [llms.txt](https://stellarfirm.ai/llms.txt).

## Related

- The [Getting started](/docs/getting-started) section explains the product behind the API.
- Questions about the API can go to hey@astrocode.tech.

---

Source: https://stellarfirm.ai/docs/api