Generate a package

Server URLloading...

POST

/generate

Send

Authorization

Header

Body

Returns one generated package without creating a Project.

Supports idempotent retries; keyed responses include generated files in the replay cache.

Use download.url to save the complete ZIP, verify download.sha256, and extract it into an empty directory. The link expires at download.expires_at and grants access to anyone who has it. CLI, MCP, and SDK calls supply an idempotency key automatically. Agents should request fields=["download","coverage","warnings","claim"] to keep the MCP result compact; files can exceed the response limit. Download the ZIP instead of repeating generation to retrieve omitted files.

Anonymous and Free requests include the first 25 operations. Paid plans include all operations. Anonymous requests are rate limited by IP address. Check coverage for omitted operations; an invalid API key returns 401.

An anonymous URL request without source headers may return claim.url. Sign in through that link within seven days to save the recipe as a Project.

Header Parameters

Response Body

curl -X POST "https://example.com/generate" \  -H "Content-Type: application/json" \  -d '{    "spec": {      "url": "https://typeship.dev/examples/petstore/openapi.yaml"    },    "target": {      "type": "cli"    }  }'

{  "object": "package",  "files": [    {      "path": "README.md",      "content": "# petstore-cli\n\nCLI for Petstore. [API reference](./api.md)\n"    }  ],  "warnings": [],  "coverage": {    "generated": 20,    "omitted": 0,    "total": 20,    "omitted_operations": []  },  "request_id": "req_3k8m1v6q9p2d7h4c"}