> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atomscale.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Programmatic access to the Atomscale platform

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:

```bash theme={null}
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:

```json theme={null}
{
  "detail": "Error message describing what went wrong"
}
```

## HTTP Status Codes

| Code | Description                                   |
| ---- | --------------------------------------------- |
| 200  | Success                                       |
| 201  | Resource created                              |
| 400  | Bad request - check your parameters           |
| 401  | Unauthorized - invalid or missing credentials |
| 403  | Forbidden - insufficient permissions          |
| 404  | Resource not found                            |
| 422  | Validation error - check field requirements   |
| 500  | Server 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.

<Card title="Authentication" icon="key" href="/api-reference/authentication">
  Learn how to authenticate your API requests
</Card>