Skip to main content

API Reference

Complete REST API documentation with working examples, endpoint reference, and SDK information.

Documentation​

Basic Examples

Simple object generation with structured schemas. Start here to learn the fundamentals.

Decision Trees

Score and route generation based on quality criteria. Perfect for quality control workflows.

Array Generation

Generate lists of structured objects. Build books, catalogs, and sequential content with nested arrays.

Recursive Generation

Create deeply nested structures like org charts, file systems, and hierarchical data.

Epistemic Uncertainty

Model confidence and uncertainty in generated content with probabilistic information.

Code Assessment

Automated code reviews, compliance checks, and quality assessments with structured feedback.

Quick Start

Overview and getting started guide for the ObjectWeaver API.

REST API Overview​

ObjectWeaver exposes a RESTful API for generating structured JSON objects and lists.

Base URL: http://localhost:8080 (configure for production)

Authentication: Include API key in request headers:

-H "Authorization: Bearer YOUR_API_KEY"

Core Endpoints​

EndpointMethodDescription
/api/objectGenPOSTGenerate a structured JSON object
/healthGETHealth check

Best Practices​

  • Clear Instructions: Write specific, actionable field instructions
  • Model Selection: Use gpt-3.5-turbo for simple fields, gpt-4 for complex reasoning
  • Error Handling: Implement retry logic for transient failures
  • Schema Validation: Validate definitions before sending

Learn More​

See cURL Examples for working code, or explore Core Concepts and Features for advanced capabilities.