API Reference

Welcome to the Spondulix Search API documentation. This API allows you to interact with the Spondulix Search platform programmatically.

Available Endpoints

Service Status

• Ping - Check service status

Data Management

• Libraries - Manage libraries
• PROs - View PRO information
• Composers - Manage composer information
• Publishers - Manage publisher information
• Metadata Types - Manage metadata types and tags
• Metadata Tags - Manage metadata tags
• Tracks - Manage tracks
• Searches - Search

Authentication

All API endpoints require authentication using an API key. Make sure to include your API key in the header of each request:

Authorization: Bearer your-api-key-here

Response Format

All responses are returned in JSON format. Successful responses will include a data field containing the requested information. Error responses will include an error field with details about what went wrong.

Pagination

List endpoints support pagination using the following query parameters:

• page: The page number to retrieve (default: 1)
• per_page: Number of items per page (default varies by endpoint)

Any endpoint that returns a list will include a pagination object in the response.

"pagination": {
  "total_entries": 10523,
  "per_page": 5,
  "current_page": 1,
  "total_pages": 421,
  "next_page": 2,
  "next_page_url": "http://127.0.0.1:3000/api/v1/libraries/2/composers?page=2"
}

Note that next_page_url will be null if there are no more pages.