Skip to API content
Birdor API v1

API reference · v1

Generate TypeScript and Zod types from JSON

Infer TypeScript types and/or a Zod schema from a JSON sample. Array elements are merged, so fields missing from some elements become optional and mixed values become unions; keys that are not identifiers are quoted. Date-like strings stay string, because JSON.parse returns strings. Set samples to merge a root array of example payloads into one type. Nesting deeper than 50 levels becomes unknown. Requires a credential with tools.run; every accepted call consumes one monthly unit, including business 4xx/5xx.

POST/v1/run/json/types

Access requirements

Health, metadata, changelog and waitlist routes are public. Catalog reads (GET /v1/tools, /v1/tools/{id}, /v1/colors/*) and POST /v1/tools/query require a tools.read credential; POST /v1/run/* requires tools.run. There is no anonymous access to these routes: send an API key (Bearer OR X-API-Key) from your server, or use the HttpOnly main-site session plus workspace selection and same-origin Origin. Never combine credentials. Every admitted call is metered. Ingress and workspace/actor minute/month limits are separate; waitlist has its own policy.

Implemented interfaces and development screens do not imply public production availability, paid access or a completed payment integration. Confirm access with Birdor before connecting an application. No paid Pro service, activation or cross-device sync is currently delivered. We are validating one repeatable task before building a paid offer.

Parameters

FieldDescription
AuthorizationstringOptionalBearer API key with tools.run; alternatively X-API-Key. One of the credentials is required.
X-API-KeystringOptionalAlternative to Authorization; never send both.
X-Birdor-Workspace-IDstringOptionalRequired with the site session; optional and matching with an API key.
X-Birdor-Project-IDstringOptionalOptional owned project; a project-bound key cannot select another project.

Request body

Send JSON with Content-Type: application/json.

FieldDescription
jsonstringRequiredJSON sample as text, at most 30000 characters (the whole request body is capped at 32768 bytes).
rootNamestringOptionalName of the root type (a TypeScript identifier); default Root. The Zod schema is named after it with a Schema suffix (Order → OrderSchema).
targetsarrayOptionalOutputs to generate: typescript and/or zod; default ["typescript"].
declarationinterface | typeOptionalRoot declaration for objects: interface (default) or type alias.
nullsnullable-union | optionalOptionalHow null-valued fields are typed: nullable-union (T | null, default) or optional (field?: …).
samplesbooleanOptionalTreat a root array as a list of samples and merge them into one type (fields missing from some samples become optional); default false.
indentunknownOptionalIndent width: 2 (default) or 4.

Request example

1. Set the base URL

Request example
curl --request POST "$BIRDOR_API_BASE_URL/v1/run/json/types" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $BIRDOR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "json": "{\"id\":42,\"email\":\"ada@example.com\",\"tags\":[\"pro\"],\"plan\":null,\"items\":[{\"sku\":\"A1\",\"qty\":2},{\"sku\":\"B2\",\"price\":9.5}]}",
  "rootName": "Order",
  "targets": [
    "typescript",
    "zod"
  ]
}'

Examples are copied only; this page does not send API requests.

Responses

Illustrative response. Values vary by environment and time.

200Success
HTTP 200
{
  "ok": true,
  "data": {
    "rootKind": "object",
    "typescript": "export interface Order {\n  id: number;\n  email: string;\n  tags: string[];\n  plan: null;\n  items: ({\n    sku: string;\n    qty?: number;\n    price?: number;\n  })[];\n}\n",
    "zod": "import { z } from \"zod\";\n\nexport const OrderSchema = z.object({ \"id\": z.number(), \"email\": z.string(), \"tags\": z.array(z.string()), \"plan\": z.null(), \"items\": z.array(z.object({ \"sku\": z.string(), \"qty\": z.number().optional(), \"price\": z.number().optional() })) });\n"
  },
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
400Invalid JSON, schema validation failure (field paths/codes only, never input values) or ambiguous credentials
HTTP 400
{
  "ok": false,
  "code": "VALIDATION_ERROR",
  "message": "Invalid request parameters",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
401Missing, expired, rotated, revoked or invalid credential; there is no anonymous access
HTTP 401
{
  "ok": false,
  "code": "UNAUTHENTICATED",
  "message": "API access denied",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
403Key lacks tools.run, or workspace/project/member policy or site Origin denied
HTTP 403
{
  "ok": false,
  "code": "FORBIDDEN",
  "message": "API access denied",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
405Only POST is supported; rejected before admission
HTTP 405
{
  "ok": false,
  "code": "METHOD_NOT_ALLOWED",
  "message": "Method not allowed",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
408Body read exceeds five seconds; before admission
HTTP 408
{
  "ok": false,
  "code": "REQUEST_TIMEOUT",
  "message": "Request body timeout or aborted",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
413Body exceeds 32768 bytes; before admission
HTTP 413
{
  "ok": false,
  "code": "PAYLOAD_TOO_LARGE",
  "message": "Request body too large",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
415Content-Type must be application/json; before admission
HTTP 415
{
  "ok": false,
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "message": "JSON content type required",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
429Ingress, workspace/actor minute or monthly quota exceeded; inspect code and Retry-After
HTTP 429
{
  "ok": false,
  "code": "QUOTA_EXCEEDED",
  "message": "API request limit exceeded",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
500Unexpected operation failure; details are never echoed
HTTP 500
{
  "ok": false,
  "code": "OPERATION_FAILED",
  "message": "Operation failed",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
503Authentication/metering dependency unavailable
HTTP 503
{
  "ok": false,
  "code": "API_GATEWAY_UNAVAILABLE",
  "message": "API access denied",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
422INVALID_JSON: json is not valid JSON; details.reason gives the parser message
HTTP 422
{
  "ok": false,
  "code": "INVALID_JSON",
  "message": "json is not valid JSON; details.reason gives the parser message",
  "request_id": "req_example",
  "timestamp": "2026-10-11T00:00:00.000Z"
}
Error handling

Example response fields

Fields shown in this example; optional fields can be omitted. Array rows describe the first example element.

okboolean
Application success flag.
dataobject
Endpoint-specific result.
data.rootKindstring
Endpoint-specific example value.
data.typescriptstring
Endpoint-specific example value.
data.zodstring
Endpoint-specific example value.
request_idstring
Origin-response identifier matching X-Request-ID; a shared HTTP cache may replay the original trace.
timestampstring
Response creation timestamp.