API Reference

Comprehensive API reference is in progress. Full examples and patterns are in the developer guides.

Quick Start

Authentication

All requests need your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Base URL

All endpoints:

https://api.swarmient.com/v1

Rate Limits

  • • 100 job submissions/minute
  • • 1,000 status checks/minute
  • • Contact support for higher

Format

All requests and responses are JSON. Use Content-Type: application/json.

Main Endpoints

POST /jobs/submit

Submit a new compute job.

View full job submission guide →

GET /jobs/:id

Get job status and results.

View full monitoring guide →

GET /jobs/:id/stream

Stream results as they complete.

View streaming examples →

GET /account

Get your account info and credit balance.

View account setup guide →

Error Handling

Errors return standard HTTP status codes with JSON details.

400 Bad Request

Malformed job structure or invalid parameters

401 Unauthorized

Missing or invalid API key

402 Payment Required

Insufficient credits to submit job

429 Too Many Requests

Rate limit exceeded

500 Internal Server Error

Server error (contact support)

Ready to Build?

See examples, patterns, and detailed explanations. All the resources you need to get started.

Sign Up as Developer