# Pi API

## Docs

- [Avatars](https://piii.mintlify.app/api/avatars.md): Generate, save, and retrieve marketing-style avatar images.
- [Extract Brand](https://piii.mintlify.app/api/brands/extract.md): Queue an async brand DNA extraction job from a URL, logo, or reference images.
- [Get Brand](https://piii.mintlify.app/api/brands/get.md): Retrieve a single brand record by its UUID.
- [List Brands](https://piii.mintlify.app/api/brands/list.md): Retrieve all brand records in your organization with optional search and pagination.
- [Project Brand](https://piii.mintlify.app/api/brands/project.md): Project stored brand DNA into a compact, use-case-specific payload.
- [Edit Campaign](https://piii.mintlify.app/api/campaigns/edit.md): Edit a generated or existing campaign ad image with new instructions.
- [Generate Campaign](https://piii.mintlify.app/api/campaigns/generate.md): Campaign-grade static ad generation with mandatory corpus retrieval and multi-step quality orchestration.
- [Localize Ad](https://piii.mintlify.app/api/campaigns/localize.md): Localize a campaign ad image for a new market while preserving the original compositional layout.
- [Decision Suite](https://piii.mintlify.app/api/health/decision-suite.md): Seven async health decision endpoints for risk, adherence, notes structuring, decision support, medication checks, scan analysis, and research acceleration.
- [Health Triage](https://piii.mintlify.app/api/health/triage.md): Submit medical images or EEG data for async point-of-care triage support.
- [Cognitive Wellness](https://piii.mintlify.app/api/health/wellness.md): Async EEG-based cognitive wellness coaching with optional vision input for focus tracking, burnout check-ins, and cognitive game sessions.
- [Image Generations](https://piii.mintlify.app/api/images/generations.md): OpenAI-compatible async image generation for static marketing ads.
- [Jobs](https://piii.mintlify.app/api/jobs.md): Retrieve the status and result of any async Pi job by ID, with optional long-polling and result expansion.
- [Neuro Decode](https://piii.mintlify.app/api/neuro/decode.md): Async BCI/EEG intent decoding for mobility assistance, mind-to-speech, and accessibility applications.
- [Robotics](https://piii.mintlify.app/api/robotics.md): Async agentic robot runs, direct command dispatch, status polling, and real-time event streaming via SSE.
- [Runs](https://piii.mintlify.app/api/runs.md): Execute multi-step pipeline jobs in a single request with DAG dependencies and per-step status tracking.
- [Surveillance](https://piii.mintlify.app/api/surveillance.md): Submit video frames for intelligence analysis, manage behavior detection policies, and stream real-time incident events via SSE.
- [Voice Agents](https://piii.mintlify.app/api/voice/agents.md): Create and manage reusable voice agent configurations for LiveKit + Gemini Live sessions.
- [Voice Sessions](https://piii.mintlify.app/api/voice/sessions.md): Start LiveKit + Gemini Live voice sessions, complete with transcript, and receive LiveKit webhook events.
- [Webhooks](https://piii.mintlify.app/api/webhooks.md): Register HTTPS endpoints to receive Pi job completion and failure events without polling.
- [Async Jobs](https://piii.mintlify.app/concepts/async-jobs.md): Understand the Pi job lifecycle, how to poll for completion, and how to handle failures.
- [Authentication](https://piii.mintlify.app/concepts/authentication.md): How to obtain and use Pi API keys, understand rate-limit headers, and handle authentication errors.
- [Response Format](https://piii.mintlify.app/concepts/response-format.md): Pi's consistent response envelope, expansion convention, error structure, and HTTP status codes.
- [Webhooks](https://piii.mintlify.app/concepts/webhooks.md): Register HTTPS endpoints to receive Pi job completion and failure events without polling.
- [Brand Pipeline](https://piii.mintlify.app/guides/brand-pipeline.md): Extract brand DNA from a URL, poll for the result, then project identity into a compact use-case payload — and reuse brand_id across every downstream campaign.
- [Health APIs](https://piii.mintlify.app/guides/health-apis.md): Async job APIs for point-of-care triage, clinical decision support, wellness coaching, and neuro decode — all following the same POST → 202 job_id → poll pattern.
- [Surveillance & Robotics](https://piii.mintlify.app/guides/surveillance-robotics.md): Programmable video intelligence with SSE incident streams, and agentic robot runs with real-time event subscriptions.
- [Visual Commerce](https://piii.mintlify.app/guides/visual-commerce.md): Generate campaign-grade static ads, edit images, localize for markets, and create brand avatars — all via async jobs.
- [Voice Sessions](https://piii.mintlify.app/guides/voice-sessions.md): Create voice agents, start LiveKit + Gemini Live sessions, enforce call duration limits, and complete sessions with transcripts for structured extraction.
- [Introduction](https://piii.mintlify.app/introduction.md): Pi is an enterprise-grade, OpenAI-compatible agentic intelligence platform. This page covers the fundamentals you need before making your first request.
- [Quick Start](https://piii.mintlify.app/quickstart.md): Run the full Pi extract → poll → project flow in under five minutes using curl, TypeScript, or Python.
- [Installation](https://piii.mintlify.app/sdk/installation.md): Install @pi-api/sdk and initialize the typed TypeScript client for Pi API.
- [Namespaces](https://piii.mintlify.app/sdk/namespaces.md): Complete method reference for every namespace exposed by the @pi-api/sdk client.
- [SDK Overview](https://piii.mintlify.app/sdk/overview.md): A TypeScript SDK that wraps every Pi API endpoint with full type safety and built-in async job helpers.