Getting Started

Get up and running with the Spindle extraction API in minutes.

1. Create Your Account

Sign up at /register to create your Spindle workspace. You will be assigned a default team automatically.

2. Get Your API Key

Navigate to Settings → API Keys in your dashboard and generate a new key. Copy it immediately — it won't be shown again.

All keys are prefixed with sk_live_ and stored as SHA-256 hashes on the server.

3. Find Your Team ID

Most API endpoints require an x-team-id header identifying which workspace the request belongs to. Find your Team ID under Settings → Team.

4. Make Your First Extraction

Send a POST request to /v1/extract with your URL:

curl -X POST "https://api.yourdomain.com/v1/extract" \
	-H "Authorization: Bearer sk_live_your_api_key" \
	-H "x-team-id: your_team_id" \
	-H "Content-Type: application/json" \
	-d '{ "url": "https://example.com/article", "format": "markdown" }'

5. Response

Spindle returns the extracted content in your chosen format:

{
	"success": true,
	"data": {
		"url": "https://example.com/article",
		"title": "Example Article",
		"content": "# Example Article\n\nThis is the extracted content...",
		"format": "markdown",
		"adapter": "readability",
		"extractedAt": "2025-01-01T00:00:00.000Z"
	}
}

Output Formats

Next Steps

• Learn how Spindle handles different page types in the Extraction Adapters guide.
• Set up team access controls in the Multitenancy & RBAC guide.
• Review the full endpoint list in the API Reference.