JSON to TypeScript API

Generates a TypeScript interface (or type alias) from a sample JSON value, unioning heterogeneous array element types. Answers 'What TypeScript type matches this JSON?', 'How do I generate a TS interface from an API response?'.

Price$0.02per request

MethodPOST

Route/v1/data-transform/json-to-typescript

StatusLive

MIME typeapplication/json

Rate limit120/minute

Cache0s public

data-transformtypescripttypescodegenjsoninterfacewrangle

API URLhttps://x402.hexl.dev/v1/data-transform/json-to-typescript

Integration docs

Example request

{
  "sample": {
    "id": 1,
    "name": "x",
    "tags": [
      "a"
    ]
  },
  "name": "User"
}

Example response

{
  "typescript": "interface User {\n  id: number;\n  name: string;\n  tags: string[];\n}"
}

Input schema

{
  "type": "object",
  "required": [
    "sample"
  ],
  "properties": {
    "sample": {
      "type": "object",
      "examples": [
        {
          "id": 1,
          "name": "x",
          "tags": [
            "a"
          ]
        }
      ]
    },
    "name": {
      "type": "string",
      "examples": [
        "User"
      ]
    }
  }
}

Output schema

{
  "type": "object",
  "additionalProperties": true
}