API Reference
REST API, WebSocket, and Python SDK documentation
API Overview
Introduction to the MatCraft REST API, authentication, and request conventions.
6 min read
api
rest
overview
Campaigns API
Create, manage, and query optimization campaigns via the REST API.
8 min read
api
campaigns
crud
Jobs API
Monitor and control background optimization jobs.
6 min read
api
jobs
background
Datasets API
Upload and manage evaluation datasets for warm-starting campaigns.
6 min read
api
datasets
data
Templates API
Browse and retrieve pre-built MDL templates via the API.
5 min read
api
templates
mdl
WebSocket API
Real-time campaign progress streaming via WebSocket connections.
6 min read
api
websocket
real-time
Authentication
API key management, scopes, and security best practices.
6 min read
api
authentication
security
Error Handling
API error codes, response format, and handling strategies.
5 min read
api
errors
error-handling
Rate Limits
API rate limiting policies, headers, and strategies for staying within limits.
5 min read
api
rate-limits
throttling
Python SDK
Programmatic access to MatCraft via the official Python client library.
8 min read
api
sdk
python