Skip to main content

Infrastructure API

Persistent state. Incidents, evidence (IPFS), blockchain anchoring, AI analysis, and Solana airspace and delivery operations.

Coordination API

Real-time fleet ops. Telemetry batches, predictive alerts, IPFS uploads, fault injection, HITL mission approval, and SSE event streams.

​
Base URLs

Self-hosted deployments substitute their own hostnames; request and response shapes are identical.

​
Authentication

Both APIs use bearer JWTs.
See Authentication for the token lifecycle, scope handling, and rotation guidance.

​
Conventions

​
Content type

All requests and responses use application/json unless an endpoint explicitly documents a different media type (for example, multipart uploads on POST /storage).

​
Time

Timestamps are ISO-8601 UTC strings (2026-05-04T06:01:27Z) on resource payloads. Token expiry on /login is the exception — it is a Unix timestamp in seconds for ease of arithmetic.

​
IDs

Resource IDs are opaque strings. Do not parse them; treat them as identifiers only. IPFS evidence is referenced by its CID (content identifier), which is content-addressed and stable.

​
Pagination

List endpoints accept limit (default 50, max 200) and cursor query parameters. The response carries a next_cursor field when more pages are available.

​
Idempotency

Mutating endpoints accept an Idempotency-Key header. ResQ caches the response for 24 hours so retries return the original result rather than duplicating the side effect.

​
Request IDs

Every response carries an X-Request-Id header. Include it in any support or incident report so we can correlate logs.

​
Errors

Failures use standard HTTP status codes with a small JSON envelope. See Errors for the full status-code table, retry guidance, and a backoff sketch.

​
Infrastructure API

Built with Rust and Axum. Persistent state, blockchain interactions, and AI-assisted analysis. Base URL: https://api.resq.software.

​
Coordination API

Built with TypeScript and Elysia. Real-time fleet ops; designed to keep operating when upstream infrastructure is degraded. Base URL: https://coordination.resq.software.

​
SDKs

Skip writing a client — install one of the official SDKs.

TypeScript

@resq-systems/http, @resq-systems/security, UI components.

Python

resq-mcp (FastMCP server) and resq-dsa.

Rust

Unified resq CLI plus seven TUI tools.

.NET

Typed clients, Protobuf contracts, sim harnesses.