Skip to main content

​
Overview

Station provides a REST API for programmatic access to all features. Base URL: http://localhost:8585/api/v1

​
Authentication

​
Local Mode

No authentication required when local_mode: true.

​
CloudShip Mode

Use bearer token authentication: 
curl -H "Authorization: Bearer your-token" \
  http://localhost:8585/api/v1/agents

​
Endpoints

​
Health

GET /api/v1/health
Returns server health status.

​
Agents

MethodEndpointDescription
GET/api/v1/agentsList all agents
GET/api/v1/agents/:idGet agent details
POST/api/v1/agentsCreate agent
PUT/api/v1/agents/:idUpdate agent
DELETE/api/v1/agents/:idDelete agent
POST/api/v1/agents/:id/runExecute agent

​
Environments

MethodEndpointDescription
GET/api/v1/environmentsList environments
GET/api/v1/environments/:nameGet environment
POST/api/v1/environments/:name/syncSync environment

​
MCP Servers

MethodEndpointDescription
GET/api/v1/mcp-serversList MCP servers
GET/api/v1/toolsList available tools

​
Runs

MethodEndpointDescription
GET/api/v1/runsList agent runs
GET/api/v1/runs/:idGet run details

​
Response Format

All responses follow this format: 
{
  "success": true,
  "data": { ... },
  "error": null
}
Error response: 
{
  "success": false,
  "data": null,
  "error": {
    "code": "AGENT_NOT_FOUND",
    "message": "Agent with ID 123 not found"
  }
}

​
Pagination

List endpoints support pagination: 
GET /api/v1/agents?page=1&limit=20
Response includes pagination metadata: 
{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45,
    "pages": 3
  }
}

​
Rate Limiting

ModeLimit
LocalNone
CloudShip100 req/min

​
SDKs

Official SDKs coming soon:
  • Python
  • TypeScript
  • Go

​
OpenAPI Spec

Download the OpenAPI specification: 
curl http://localhost:8585/api/v1/openapi.json -o openapi.json