Skip to main content
The Atomscale API provides programmatic access to your materials science data, analysis results, and platform features. Use it to integrate Atomscale into your existing workflows, automate data uploads, or build custom applications.

​
Base URL

All API requests should be made to: 
https://api.atomscale.ai

​
Request Format

The API accepts JSON-encoded request bodies and returns JSON responses. Include the Content-Type header for requests with a body: 
Content-Type: application/json

​
Response Format

All responses return JSON with consistent structure. Successful responses include the requested data directly, while errors follow a standard format: 
{
  "detail": "Error message describing what went wrong"
}

​
HTTP Status Codes

CodeDescription
200Success
201Resource created
400Bad request - check your parameters
401Unauthorized - invalid or missing credentials
403Forbidden - insufficient permissions
404Resource not found
422Validation error - check field requirements
500Server error - contact support

​
Rate Limiting

API requests are rate-limited to ensure platform stability. If you receive a 429 status code, wait before retrying. Contact support if you need higher limits for production workloads.

​
Versioning

The API is versioned through the URL path. The current version is v1, which is the default when no version is specified. Breaking changes will be introduced in new versions with advance notice.

Authentication

Learn how to authenticate your API requests