Welcome to the Pika Platform technical reference. This section provides detailed specifications, schemas, and API documentation for quick lookup of syntax, parameters, and configuration options.
Quick Navigation
Section titled “Quick Navigation”Configuration Reference
Section titled “Configuration Reference”Complete reference for all configuration options:
- Agent Configuration - Agent definition schema with all required and optional fields
- Chat App Configuration - Chat application configuration schema
- Platform Settings - Global platform configuration (pika-config.ts)
- Site Features - Site-wide feature configuration reference
- Environment Variables - All environment variables and their usage
API Reference
Section titled “API Reference”REST API and SDK documentation:
- REST API - Core REST API endpoints for chat, users, and admin functions
- Tag Definitions API - API for managing custom UI tags and widgets
CLI Reference
Section titled “CLI Reference”Command-line interface documentation:
- CLI Commands - Complete reference for all Pika CLI commands
TypeScript Types
Section titled “TypeScript Types”Type definitions and interfaces:
- Types Overview - Introduction to pika-shared type library
- Agent & Tool Types - Agent, tool, and Bedrock type definitions
- Session & User Types - Session management and user type definitions
UI Components
Section titled “UI Components”Component libraries and interfaces:
- pika-ux Module - shadcn/ui components and Pika custom components
- Widget System - Tag definitions and custom widget reference
- Custom Components - Interface for building custom components
Reference vs. How-To Guides
Section titled “Reference vs. How-To Guides”Type-Safe Development
Section titled “Type-Safe Development”Most configuration and API interactions in Pika are fully typed with TypeScript. Install the pika-shared package for type safety in your projects:
npm install -D pika-sharedThis gives you IntelliSense, compile-time validation, and inline documentation throughout your development workflow.
Contributing to Reference Docs
Section titled “Contributing to Reference Docs”Notice an error or missing information? Reference documentation is generated from both code and manual documentation. To contribute:
- Type definitions - Submit PRs to the main codebase
- Documentation content - Follow our Contributing Guide
Looking for something specific? Use the search at the top of the page or browse the navigation on the left.