Skip to content

README.md

Latest commit

 

History

History
176 lines (130 loc) · 4.4 KB

README.md

File metadata and controls

176 lines (130 loc) · 4.4 KB
Raw

pre.dev API Client Libraries

Official client libraries for the Pre.dev Architect API in Python and Node.js/TypeScript.

Generate comprehensive software specifications using AI-powered analysis with a simple, consistent API across both languages.

📦 Packages

This repository contains two client libraries with matching APIs:

Python Package (predev-api-python/)

Python client for the Pre.dev Architect API with full type hints support.

Quick Start:

from predev_api import PredevAPI

predev = PredevAPI(api_key="your_api_key")
result = predev.fast_spec("Build a task management app")

📖 Python Documentation

Node.js/TypeScript Package (predev-api-node/)

Modern TypeScript/Node.js client using ES6+ modules with full type definitions.

Quick Start:

import { PredevAPI } from 'predev-api';

const predev = new PredevAPI({ apiKey: 'your_api_key' });
const result = await predev.fastSpec({ input: 'Build a task management app' });

📖 Node.js Documentation

🚀 Features

Both libraries provide:

  • Fast Spec Generation: Comprehensive specifications quickly - perfect for MVPs and prototypes
  • Deep Spec Generation: Ultra-detailed specifications for complex systems with enterprise-grade depth
  • Async Spec Generation: Non-blocking async methods for long-running requests
  • Status Tracking: Check the status of async specification generation requests
  • Enterprise Support: Both solo and enterprise authentication methods
  • Type Safety: Full type hints (Python) and TypeScript definitions (Node.js)
  • Direct Spec Data: JSON + markdown payloads returned inline alongside S3 URLs
  • Error Handling: Custom exceptions for different error scenarios
  • Modern Conventions: Latest language features and best practices

🔑 Authentication

Get your API key from the pre.dev dashboard

📚 API Endpoints

Fast Spec

Generate comprehensive specifications quickly with balanced depth and speed.

Python:

result = predev.fast_spec(
    input_text="Your project description"
)

TypeScript:

const result = await predev.fastSpec({
  input: "Your project description"
});

Deep Spec

Generate ultra-detailed specifications for complex systems with comprehensive analysis.

Python:

result = predev.deep_spec(
    input_text="Your complex project description"
)

TypeScript:

const result = await predev.deepSpec({
  input: "Your complex project description"
});

Async Spec Generation

Generate specifications asynchronously for long-running requests.

Python:

# Fast spec async
result = predev.fast_spec_async(
    input_text="Your project description"
)
# Returns: AsyncResponse with specId

# Deep spec async
result = predev.deep_spec_async(
    input_text="Your complex project description"
)
# Returns: AsyncResponse with specId

TypeScript:

// Fast spec async
const result = await predev.fastSpecAsync({
  input: "Your project description"
});
// Returns: AsyncResponse with specId

// Deep spec async
const result = await predev.deepSpecAsync({
  input: "Your complex project description"
});
// Returns: AsyncResponse with specId

Get Spec Status

Check the status of an async specification generation request.

Python:

status = predev.get_spec_status("spec_id")

TypeScript:

const status = await predev.getSpecStatus("spec_id");

📖 Documentation

💡 Examples

Both packages include comprehensive examples in their respective examples/ directories:

Python Examples

cd predev-api-python
export PREDEV_API_KEY="your_api_key"
python examples/fast_spec_example.py
python examples/deep_spec_example.py
python examples/get_status_example.py

TypeScript Examples

cd predev-api-node
export PREDEV_API_KEY="your_api_key"
npm run build
npx tsx examples/fastSpecExample.ts
npx tsx examples/deepSpecExample.ts
npx tsx examples/getStatusExample.ts

🔗 Links