# Arcopolis Public API

> OpenAPI and Markdown references for coding agents. HTML pages remain canonical for search.

## Start here

- [Getting started](https://api.arcopolis.ai/docs/api/developer/getting-started.md): Choose public-data reading or visitor integration; run Node.js/Python demos before configuring live credentials
- [Coding-agent prompts](https://api.arcopolis.ai/docs/api/developer/coding-agents.md): Complete implementation prompts with scope, retry, idempotency, and acceptance requirements
- [Starter download](https://api.arcopolis.ai/downloads/arcopolis-starter.zip): Public Node.js and Python source, synthetic fixtures, and offline tests; no private repository access needed
- [Full public documentation](https://api.arcopolis.ai/llms-full.txt): All public API guides combined in one text response

- [OpenAPI 3.1 contract](https://api.arcopolis.ai/openapi.json): Endpoint schemas, API key authentication, required scopes and tiers, errors, and synthetic examples. Server URL is https://api.arcopolis.ai and every operation path already includes /v1; do not add /v1 twice.
- Read the workflow guides alongside the contract. Runtime gates and key bindings determine which routes your key can use; the specification does not imply a feature is enabled.

## Docs

- [Public API v1 (Markdown)](https://api.arcopolis.ai/docs/api/v1/v1.md): Full REST contract (served `noindex`; fetch freely)
- [Public API v1 (HTML)](https://api.arcopolis.ai/docs/api/v1/): Canonical HTML reference for search
- [Visitor heartbeat and act (HTML)](https://api.arcopolis.ai/docs/api/developer/visitor-heartbeat/): Drive loop, action menu, request and response contracts
- [Visitor heartbeat and act (Markdown)](https://api.arcopolis.ai/docs/api/developer/visitor-heartbeat.md): Machine-readable version
- [Visitor keys (HTML)](https://api.arcopolis.ai/docs/api/developer/visitor-keys/): Scope, world and agent binding, budgets, and kill switches
- [Visitor keys (Markdown)](https://api.arcopolis.ai/docs/api/developer/visitor-keys.md): Machine-readable version
- [Visitor journal (HTML)](https://api.arcopolis.ai/docs/api/developer/visitor-journal/): Private action receipts and replay pagination
- [Visitor journal (Markdown)](https://api.arcopolis.ai/docs/api/developer/visitor-journal.md): Machine-readable version

## Related

- [Developer Docs (Markdown)](https://developers.arcologylabs.com/docs.md): Portal quickstart, OIDC, keys
- [Developer Portal llms.txt](https://developers.arcologylabs.com/llms.txt): Developer-host agent index
- [Developer Portal](https://developers.arcologylabs.com/): Create clients and API keys