API Reference

Developer API

Integrate ShellPilot into your own applications and workflows.

Authentication

All API requests require authentication using an API key. Include your key in the Authorization header:

Authorization: Bearer your_api_key_here

Base URL

https://api.shellpilot.pro/v1

Endpoints

POST/api/v1/generate

Generate a shell command from natural language input.

Request Body

{
  "prompt": "list all files larger than 100MB",
  "shell": "bash",
  "context": {
    "cwd": "/home/user/projects",
    "os": "linux"
  }
}

Response

{
  "command": "find . -type f -size +100M",
  "explanation": "Searches recursively for files larger than 100MB",
  "safety": "safe"
}
POST/api/v1/explain

Get a detailed explanation of a shell command.

Request Body

{
  "command": "find . -name '*.log' -mtime +7 -delete"
}

Response

{
  "explanation": "Finds and deletes all .log files older than 7 days",
  "breakdown": [
    { "part": "find .", "meaning": "Search from current directory" },
    { "part": "-name '*.log'", "meaning": "Match files ending in .log" },
    { "part": "-mtime +7", "meaning": "Modified more than 7 days ago" },
    { "part": "-delete", "meaning": "Delete matched files" }
  ],
  "safety": "destructive"
}
GET/api/v1/history

Retrieve command history for the authenticated user.

Response

{
  "commands": [
    {
      "id": "cmd_123",
      "prompt": "find large files",
      "command": "find . -size +100M",
      "timestamp": "2026-05-20T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "total": 42
  }
}

Rate Limits

PlanRequests/minRequests/day
Free1050
Pro60Unlimited
Team120Unlimited