HTTP API reference

This section describes SoulFire's HTTP-accessible unary operations. The checked-in OpenAPI schema reports version 2.11.0. Fumadocs generates operation pages from that schema and groups them by service in the sidebar.

Choose the right contractCopy Anchor Link

The schema does not describe streaming RPCs, gRPC-Web framing, reflection, or every non-HTTP transport. An absent streaming operation is not evidence that the server lacks it.

Authenticate a requestCopy Anchor Link

Generate a token with generate-token api in the SoulFire console. Send it in the HTTP header:

Authorization: Bearer YOUR_API_TOKEN

The schema also describes Basic compatibility with username:api-jwt as its encoded credential. Use an API-audience token. A WebDAV token has a different audience. LoginService is public. Other operations require an accepted API token and the relevant permissions.

Use your own backend URL and HTTPS for remote requests. The schema's loopback server address is an example, not a hosted public SoulFire API.

Read an operationCopy Anchor Link

Each page shows its method, path, request body, response, and generated schemas. Check the required permission and failure conditions in the service description. A successful API request does not necessarily mean a Minecraft action completed.

Compare your backend version with the documentation baseline before copying a contract. The page's copy-for-AI text includes request, response, authentication, and referenced schemas.