API Reference
IDAH's backend services expose RESTful APIs that follow the JSON:API specification, providing a standardized approach to building and consuming APIs.
JSON:API Format
JSON:API is a specification for building APIs in JSON. It provides conventions for:
Resource Structure
Consistent format for resources, attributes, and relationships
Fetching Data
Filtering, sorting, pagination, and sparse fieldsets
Creating & Updating
Standard format for POST, PATCH, and DELETE operations
Error Handling
Standardized error format with detailed information
Learn more about the JSON:API specification at jsonapi.org
API Endpoints
IDAH provides APIs across different services:
Dataset
Project, batches and annotation management service
Available Resources:
Iam
User, role, team management service
Available Resources:
Setting
Setting and Plugins Management Service
Available Resources:
Additional Resources
- JSON:API Specification - Official specification
- JSON:API Examples - Real-world examples
- verse-jsonapi - Ruby gem used by IDAH
📖 Ready to explore? Click on any resource tag above to see detailed endpoint documentation.