Developers
This section is for everyone integrating against Skynet programmatically — researchers automating observation submission, alert subscribers wiring up triggers, dashboards consuming live telemetry, third-party tools that need read access to data.
Where to start
Section titled “Where to start”New to the API? Begin with Getting started for environments, Auth for OAuth, and Conventions for the wire format rules that apply across endpoints.
Already authenticated? Jump to the REST API reference for the domain you’re working in:
- Observation — observations, requests, tasks, targets.
- Observatory — observatories, telescopes, sites, instruments, devices, constraints.
- Organization — organizations, groups, memberships, roles.
- User and Me — user resources.
- OAuth — OAuth flow endpoints.
Realtime? See WebSocket protocol for the subscribe/publish model — snapshots, events, and commands.
Schemas? The generated API reference documents every endpoint and every request and response schema.
Typed models? Generate them from the OpenAPI document at https://docs.skynetgo.org/openapi.json; the Python and TypeScript quickstarts show how. Official Python and TypeScript SDKs are in the works and will be released soon.
What you should know up front
Section titled “What you should know up front”- Wire format is camelCase JSON. Field names are camelCase on the wire; enum values stay snake_case (
optical_imaging). - Polymorphic resources carry discriminators.
DevicehasdeviceType,InstrumenthasinstrumentType,ObservationTaskhastaskType, etc. See Conventions. - Pagination uses
Page<T>envelopes. Standarditems,total,page,size,pagesshape. - Errors are
{detail: "..."}on REST (the OAuth token endpoint mostly uses the RFC 6749{error}shape), with a richer{code, message, details, id}envelope on the WebSocket.
Integrations use the public API
Section titled “Integrations use the public API”Everything here is the public API at https://api.skynetgo.org. SkyNode, the software at each telescope, talks to Skynet through a separate internal gateway; it isn’t an integration surface, so don’t build against it.