readiness-docs
Shardwright Connect
Public REST API readiness. Base URL: /api/v1. Scoped API key issuance is deferred until the credential lifecycle is implemented.
GET
/api/v1/guilds
List guilds the API key can access.
GET
/api/v1/guilds/{guildId}
Get a single guild.
GET
/api/v1/guilds/{guildId}/config
Read guild config.
PUT
/api/v1/guilds/{guildId}/config
Replace guild config.
POST
/api/v1/guilds/{guildId}/moderation/cases
Create a moderation case.
GET
/api/v1/guilds/{guildId}/moderation/cases
List moderation cases.
POST
/api/v1/guilds/{guildId}/announcements
Send a guild announcement.
POST
/api/v1/guilds/{guildId}/scheduler/jobs
Schedule a job.
GET
/api/v1/guilds/{guildId}/scheduler/jobs
List scheduled jobs.
GET
/api/v1/guilds/{guildId}/audit-log
Read audit log entries.
GET
/api/v1/guilds/{guildId}/webhook-deliveries
List webhook deliveries.Authentication
Future external requests will require a scoped guild credential. The Portal does not issue, display, or render key-shaped samples until API key storage, scopes, hashing and audit events exist.
# Future scoped credential header intentionally omitted.
X-Shardwright-Correlation-Id: 5b9a...
X-Shardwright-Idempotency-Key: 01HZ...Example: create moderation case
POST /api/guilds/{guildId}/moderation/warnings
Content-Type: application/json