Urbit

Urbit Ship HTTP API (Eyre)

The HTTP interface of every Urbit ship, served by the Eyre kernel vane. Clients authenticate by POSTing the ship's web login code to /~/login for an urbauth session cookie, then interact through channels (PUT JSON action arrays — poke, subscribe, ack, unsubscribe, delete — to /~/channel/{uid}, with responses as Server-Sent Events), read-only scries (GET /~/scry/{app}{path}.{mark}), and Spider threads. Self-hosted: every ship serves its own endpoint; there is no central production host.

GitHub

Documentation

📖
Documentation
https://docs.urbit.org/urbit-os/kernel/eyre
📖
APIReference
https://docs.urbit.org/urbit-os/kernel/eyre/external-api-ref

Other Resources

🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/urbit/refs/heads/main/apis.yml

API entry from apis.yml

apis.yml Raw ↑ 
name: Urbit Ship HTTP API (Eyre)
description: 'The HTTP interface of every Urbit ship, served by the Eyre kernel vane. Clients authenticate
  by POSTing the ship''s web login code to /~/login for an urbauth session cookie, then interact through
  channels (PUT JSON action arrays — poke, subscribe, ack, unsubscribe, delete — to /~/channel/{uid},
  with responses as Server-Sent Events), read-only scries (GET /~/scry/{app}{path}.{mark}), and Spider
  threads. Self-hosted: every ship serves its own endpoint; there is no central production host.'
humanURL: https://docs.urbit.org/urbit-os/kernel/eyre/external-api-ref
baseURL: https://{ship-host}
tags:
- HTTP
- Server-Sent Events
- Channels
- Self-Hosted
properties:
- type: Documentation
  url: https://docs.urbit.org/urbit-os/kernel/eyre
- type: APIReference
  url: https://docs.urbit.org/urbit-os/kernel/eyre/external-api-ref