Skip to main content

​
API Reference

The Roboticks API provides programmatic access to manage your robot fleet, deployments, sessions, and more.

​
Base URL

https://api.roboticks.io/api/v1

​
Authentication

All API requests require authentication. See Authentication for details. 
curl -H "Authorization: Bearer YOUR_TOKEN" \
     https://api.roboticks.io/api/v1/organizations/acme/devices

​
API Categories

Fleet

Manage devices, groups, and fleet operations

Sessions

Session data, logs, and artifacts

Tests

Test suites and test run management

Deployments

Capsules, packages, configurations, and rollouts

Integrations

Configure external integrations

​
Response Format

All responses are JSON: 
{
  "id": 123,
  "name": "warehouse-robot-01",
  "status": "online",
  "created_at": "2025-01-10T10:00:00Z"
}

​
List Responses

List endpoints return paginated results: 
{
  "items": [...],
  "total": 100,
  "page": 1,
  "page_size": 20,
  "has_more": true
}

​
Error Responses

Errors include a status code and message: 
{
  "detail": "Device not found",
  "status_code": 404
}

​
Common HTTP Status Codes

CodeDescription
200Success
201Created
204No content (successful delete)
400Bad request (validation error)
401Unauthorized (invalid/missing token)
403Forbidden (insufficient permissions)
404Not found
422Unprocessable entity
429Rate limited
500Internal server error

​
Rate Limiting

API requests are rate limited per organization:
TierRequests/minute
Free60
Personal300
Team1000
EnterpriseCustom
Rate limit headers are included in responses: 
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 295
X-RateLimit-Reset: 1704890400

​
Pagination

Use page and page_size query parameters: 
GET /devices?page=2&page_size=50

​
Filtering

Many endpoints support filtering: 
GET /devices?status=online&type=robot
GET /sessions?device_id=123&status=completed

​
SDKs and Tools

ToolDescription
Roboticks CLICommand-line interface
Python SDKComing soon
TypeScript SDKComing soon

​
Next Steps

Authentication

Learn how to authenticate API requests