General Information - Spell Docs

API Basics

API Endpoint: https://api.spell.im
Versioned APIs
- Usage: https://api.spell.im/v1
- Documentation: Please switch to the corresponding API version in the top-left corner.

Constructing a Request

Some API calls may require a user’s API Key or signature. If you haven’t created one yet, please create an API Key first.

Request Headers: Both X-API-Key: <ApiToken> and X-Signature: <SIGNATURE> are required.
GET Requests: Parameters for query operations are sent in the URL as Query Parameters.
POST Requests: Parameters for create operations are sent in the request body with the application/json format. The request header must include the signature X-Signature: <SIGNATURE>. For more details, please refer to: API Keys.

Getting a Response

All API responses are in JSON format.

Response Status Codes

HTTP 200: Success
HTTP 400: Bad Request
HTTP 401: Unauthorized
HTTP 403: Forbidden
HTTP 404: Not Found
HTTP 500: Internal Server Error

For successful requests, common response formats are as follows:

Single Result Data (e.g., a successful creation):

{
    "code": 200,
    "data": { 
        // Single data object
    }
}

Multiple Result Data (e.g., a list query):

{
    "code": 200,
    "items": [
        {
            // Single data object
        },
        {
            // Single data object
        },
        ...
    ]
}