Skip to main content

Quick Start

Get Shim running in 5 minutes. No signup required for the demo.

Step 1: Get an API Key

1

Sign up

Visit console.shim.so/signup and create a free account.
2

Generate API key

Navigate to Console -> API Keys -> Create Your First Key
3

Copy your key

Format: sk_live_xxxxx (keep this secret)

Step 2: Make Your First Request


Step 3: Understand the Response

Key Fields

  • success: true if repair succeeded, false if unrecoverable
  • repaired: The fixed JSON object (or null if failed)
  • metadata.confidence: high, medium, or low
  • metadata.syntax_repairs: Structural fixes (brackets, commas)
  • metadata.schema_repairs: Type coercion, field validation
  • metadata.warnings: Non-critical issues (review these)
  • metadata.errors: Critical failures (repair failed)

Next Steps

Streaming Repair

Repair JSON token-by-token (no buffering)

Schema Validation

Add type checking and field validation

Error Handling

Handle failures gracefully

Rate Limits

Understand tier limits and overage