Documentation Index
Fetch the complete documentation index at: https://docs.archetypeai.app/llms.txt
Use this file to discover all available pages before exploring further.
Authentication
Common Patterns
Create and Use a Session
Upload and Process Files
API Endpoints Summary
Lens API
| Method | Endpoint | Description |
|---|---|---|
POST | /lens/sessions/create | Create new lens session |
POST | /lens/sessions/destroy | Destroy lens session |
GET | /lens/sessions/info | Get sessions summary |
GET | /lens/sessions/metadata | Get active sessions metadata |
POST | /lens/register | Register lens |
POST | /lens/clone | Clone lens |
POST | /lens/modify | Modify lens |
POST | /lens/delete | Delete lens |
GET | /lens/info | Get lens summary info |
GET | /lens/metadata | Get detailed lens metadata |
Files API
| Method | Endpoint | Description |
|---|---|---|
POST | /files | Upload file |
POST | /files/base64 | Upload base64 file |
DELETE | /files/delete/{file_id} | Delete file |
GET | /files/download/{file_id} | Download file |
GET | /files/info | Get files info |
GET | /files/metadata | List all files and their metadata |
GET | /files/metadata/{file_id} | Get a file’s metadata |
POST | /files/uploads/initiate | Initiate a direct-to-cloud upload |
POST | /files/uploads/{upload_id}/parts/urls | Generate presigned URLs for upload parts |
POST | /files/uploads/{upload_id}/parts/checkpoint | Checkpoint completed upload parts |
POST | /files/uploads/{upload_id}/complete | Complete a direct-to-cloud upload |
POST | /files/uploads/{upload_id}/abort | Abort a direct-to-cloud upload |
Batch Processing API
| Method | Endpoint | Description |
|---|---|---|
| Jobs | ||
POST | /batch/jobs | Create job |
GET | /batch/jobs | List jobs |
GET | /batch/jobs/{id} | Get job info |
POST | /batch/jobs/{id}/retry | Retry job |
DELETE | /batch/jobs/{id} | Delete job |
POST | /batch/jobs/{id}/cancel | Cancel job |
GET | /batch/jobs/queue | Get global queue depths grouped by pipeline type |
| Events | ||
GET | /batch/jobs/{id}/events | List job events |
| I/O | ||
GET | /batch/jobs/{id}/inputs | List job inputs |
GET | /batch/jobs/{id}/outputs | List job outputs |
| Progress | ||
GET | /batch/jobs/{id}/progress | List job progress |
| Registry: Pipelines | ||
GET | /batch/registry/pipelines | List pipelines |
GET | /batch/registry/pipelines/{id} | Get pipeline info |
GET | /batch/registry/pipelines/{id}/schema | Get pipeline schema |
Fine-Tuning Node
| Method | Endpoint | Description |
|---|---|---|
POST | /fine-tune/jobs | Create fine-tuning job |
GET | /fine-tune/jobs | List fine-tuning jobs |
GET | /fine-tune/jobs/{job_id} | Get fine-tuning job info |
GET | /fine-tune/jobs/{job_id}/metrics | Get fine-tuning job metrics |
PUT | /fine-tune/jobs/{job_id}/stop | Stop running fine-tuning job |
DELETE | /fine-tune/jobs/{job_id} | Delete fine-tuning job |
PUT | /fine-tune/jobs/{job_id}/cancel | Cancel fine-tuning job |
GET | /fine-tune/status | Get node status |
Error Handling
Common Error Codes
| Code | HTTP Status | Description | Solution |
|---|---|---|---|
UNAUTHORIZED | 401 | Invalid API key | Check API key format: Bearer YOUR_KEY |
INVALID_LENS_ID | 400 | Lens doesn’t exist | Get valid IDs from /lens/metadata |
SESSION_NOT_FOUND | 404 | Session destroyed/expired | Create new session |
RATE_LIMIT_EXCEEDED | 429 | Too many requests | Implement exponential backoff |
FILE_TOO_LARGE | 413 | File > 1GB | Compress or split file |
WebSocket Usage
Rate Limits
- Default: 100 requests per minute
- Burst: Up to 20 requests per second
- Sessions: 10 concurrent sessions per organization
- Files: 1GB max size, 100 files per hour
Quick Troubleshooting
Resources
Live Monitor
View real-time API usage and active sessions
Newton Console
Manage API keys and organization settings
System Status
Check API health and service status
Support
Get help from our technical team