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

curl -X POST https://api.shim.so/v1/repair \
  -H "Authorization: Bearer sk_live_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "raw_output": "{\"name\": \"John\", \"age\": \"30\""
  }'

​
Step 3: Understand the Response

{
  "success": true,
  "repaired": {
    "name": "John",
    "age": 30
  },
  "metadata": {
    "confidence": "medium",
    "was_repaired": true,
    "output_valid_json": true,
    "syntax_repairs": [
      {
        "type": "closed_object_bracket",
        "confidence": "high",
        "safe": true
      }
    ],
    "schema_repairs": [
      {
        "type": "type_coercion",
        "confidence": "high",
        "safe": true,
        "field": "age",
        "original_value": "30",
        "repaired_value": 30
      }
    ],
    "warnings": [],
    "errors": []
  }
}

​
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