SDKs & Developer Tools

4. Developer SDKs

The KnowCode SDKs provide developers with programmatic access to the platform’s full capabilities — from automated code generation to on-chain deployment. SDKs are designed for seamless integration into modern workflows, whether you’re building a dApp, automating CI/CD pipelines, or extending KnowCode with plugins.

---

4.1 Available SDKs

• Node.js / TypeScript – official SDK for JavaScript-based environments.

• Python – API wrapper for data-driven workflows and ML integrations.

• Future SDKs – planned support for Go, Rust, and Java for enterprise adoption.

---

4.2 Installation

Node.js (npm):

npm install @knowcode/sdk

TypeScript Usage:

import { KnowCodeSDK } from "@knowcode/sdk";

const sdk = new KnowCodeSDK({ apiKey: process.env.KNOWCODE_API_KEY });

async function run() {
  const code = await sdk.generateFromDesign("https://figma.com/design/123", {
    framework: "react",
    responsive: true,
  });
  console.log(code);
}

run();

Python (pip):

pip install knowcode-sdk

Python Usage:

from knowcode_sdk import KnowCodeSDK

sdk = KnowCodeSDK(api_key="your-api-key")

code = sdk.generate_from_design(
    "https://figma.com/design/123",
    framework="react",
    options={"responsive": True, "accessibility": "wcag"}
)

print(code)

---

4.3 Core Methods

• generateFromDesign(designUrl, options) Converts a design into production-ready code.

  • Parameters: framework (react, html, tailwind), responsive (true/false), accessibility (wcag).

• deploy(domain, code) Deploys generated code with a registered domain.

• preview(id) Returns a live preview URL for rapid iteration.

• listProjects() Retrieves all projects linked to your API key.

---

4.4 CI/CD Integration

The SDKs can be integrated directly into DevOps workflows, enabling automation from design to deployment.

GitHub Actions Workflow:

name: Generate KnowCode Build
on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - run: npm install @knowcode/sdk
      - run: node scripts/generate.js

---

4.5 Error Handling & Rate Limits

• Error Codes: Standardized responses (400 – invalid design, 401 – invalid API key, 429 – rate limit).

• Rate Limits: 100 requests/minute per API key.

• Retries: Exponential backoff recommended for heavy integrations.

---

4.6 Security & Best Practices

• Store API keys securely (use .env files or secret managers).

• Validate input before sending requests.

• Rotate keys periodically for enhanced security.

---

The KnowCode SDKs transform the platform into a programmable layer that can power startups, enterprises, and open-source projects alike. By abstracting away complexity, developers gain speed without sacrificing flexibility or control.