MaritimemaritimeDocumentation
Dashboard

API Reference

RESTful API for managing agents programmatically.

Base URL: https://api.maritime.sh

Two auth methods: Dashboard endpoints use session cookies (automatic). The Provisioning API uses API keys via the X-API-Key header. See the Provisioning API docs for the full enterprise workflow.

List Agents

GET /api/agents

Response:
{
  "agents": [
    {
      "id": "agent_abc123",
      "name": "support-bot",
      "framework": "crewai",
      "tier": "smart",
      "status": "sleeping",
      "invocation_count": 847
    }
  ]
}

Create Agent

POST /api/agents

Body:
{
  "name": "my-agent",
  "framework": "crewai",
  "tier": "smart",
  "github_repo": "owner/repo"
}

Response: 201 Created
{ "id": "agent_abc123", "name": "my-agent", ... }

Deploy Agent

POST /api/deploy

Body:
{
  "agent_id": "agent_abc123",
  "source": "github",
  "branch": "main"
}

Response: 202 Accepted
{ "deployment_id": "deploy_xyz789", "status": "pending" }

Invoke Agent (Webhook)

POST /api/webhooks/{agent_id}

Body: (any JSON payload)
{
  "message": "Hello, agent!"
}

Response: 200 OK
{ "result": "...", "wake_time_ms": 230 }

Enterprise Provisioning API

Need to programmatically provision agents, manage encrypted secrets, and inject custom build files? See the full Provisioning API reference.