# SundayPyjamas AI Suite

## Docs

- [Welcome 👋](https://docs.sundaypyjamas.com/user-guide/welcome.md): A friendly, no-jargon guide to the AI Suite platform — centered on Agents that get real work done.
- [Create Your Account](https://docs.sundaypyjamas.com/user-guide/create-account.md): Sign up, log in, and get into your workspace for the first time.
- [A Tour of Your Workspace](https://docs.sundaypyjamas.com/user-guide/workspace-tour.md): A calm walk around the AI Suite platform so you always know where to click.
- [Chat with Your First Agent](https://docs.sundaypyjamas.com/user-guide/first-agent.md): Open the Agents tab and get a real deliverable — a document you can download — in a few minutes.
- [Meet the Agent](https://docs.sundaypyjamas.com/user-guide/agents/what-are-agents.md): The Agents tab is home to your Core Agent — the primary way to get work done on the AI Suite platform.
- [Using the Agents Tab](https://docs.sundaypyjamas.com/user-guide/agents/using-the-agents-tab.md): Find your way around the Agents workspace — sessions, tabs, search, and switching agents.
- [What the Core Agent Can Do](https://docs.sundaypyjamas.com/user-guide/agents/capabilities.md): Chat, tools, multi-step work, and files — documents, spreadsheets, and PDFs — on the AI Suite platform.
- [Create Docs, Sheets & PDFs](https://docs.sundaypyjamas.com/user-guide/agents/create-files.md): Ask the Core Agent for documents, spreadsheets, and PDFs you can preview and download.
- [Configure the Core Agent](https://docs.sundaypyjamas.com/user-guide/agents/configure.md): Adjust how your Core Agent behaves — its instructions, model, tools, and knowledge.
- [Run & Share an Agent](https://docs.sundaypyjamas.com/user-guide/agents/run-and-share.md): Give the Core Agent a task, watch the steps it takes, and share a session with others.
- [Writing Good Prompts](https://docs.sundaypyjamas.com/user-guide/writing-prompts.md): A 'prompt' is just your message to the AI. Here's how to ask so you get great answers.
- [Choosing a Model](https://docs.sundaypyjamas.com/user-guide/choosing-models.md): What an AI 'model' is, and how to pick the right one — explained with a simple analogy.
- [Ask Your Own Documents](https://docs.sundaypyjamas.com/user-guide/knowledge.md): Upload files, then ask the AI questions about what's inside them.
- [Make Images](https://docs.sundaypyjamas.com/user-guide/images.md): Describe a picture in words and the AI draws it for you. No art skills needed.
- [Create a Report](https://docs.sundaypyjamas.com/user-guide/reports.md): Another way to turn information into a clean written summary — Agents can also create docs directly.
- [Plain Chat (Optional)](https://docs.sundaypyjamas.com/user-guide/first-chat.md): Quick Q&A without files or tools — handy, but secondary to Agents on the AI Suite platform.
- [Build an Assistant](https://docs.sundaypyjamas.com/user-guide/assistants.md): Optional: create a custom specialist agent. Most people can stay with the Core Agent.
- [Build Your Own AI App](https://docs.sundaypyjamas.com/user-guide/build-an-app.md): Optional: create a reusable AI helper. Most everyday work belongs in Agents.
- [Connect Your Tools](https://docs.sundaypyjamas.com/user-guide/integrations.md): Let AI Suite work with the other tools you use, like chat apps and calendars.
- [Share Your Work](https://docs.sundaypyjamas.com/user-guide/sharing.md): Send a chat, report, agent, or app to other people with a simple link.
- [Team & Billing](https://docs.sundaypyjamas.com/user-guide/team-and-billing.md): Invite teammates and understand credits and usage — without the stress.
- [Real-World Scenarios](https://docs.sundaypyjamas.com/user-guide/scenarios.md): Copy-me examples centered on Agents — docs, sheets, PDFs, and everyday tasks on the AI Suite platform.
- [FAQ & Troubleshooting](https://docs.sundaypyjamas.com/user-guide/faq.md): Quick answers and simple fixes for the most common questions.
- [Plain-Language Glossary](https://docs.sundaypyjamas.com/user-guide/glossary.md): Every AI Suite word explained in one simple sentence.
- [For Developers](https://docs.sundaypyjamas.com/user-guide/for-developers.md): Ready to go beyond the buttons? Everything in this guide is also available through our API.
- [Managed Agents (Advanced)](https://docs.sundaypyjamas.com/user-guide/managed-agents.md): Optional, more technical custom agents. Most people should use the Core Agent instead.
- [SundayPyjamas AI Suite API](https://docs.sundaypyjamas.com/introduction.md): Powerful AI capabilities for your applications with our comprehensive API platform
- [Quick Start Guide](https://docs.sundaypyjamas.com/quickstart.md): Get up and running with the SundayPyjamas AI Suite API in just a few minutes
- [Authentication](https://docs.sundaypyjamas.com/authentication.md): Learn how to securely authenticate your requests using API keys and best practices
- [Chat API](https://docs.sundaypyjamas.com/chat-api.md): Complete guide to the Chat API for conversational AI, content generation, and text completion
- [Rate Limits & Token Usage](https://docs.sundaypyjamas.com/rate-limits.md): Understand rate limits, token usage, billing, and optimization strategies for cost-effective API usage
- [Error Handling](https://docs.sundaypyjamas.com/errors.md): Comprehensive guide to understanding and handling errors in the SundayPyjamas AI Suite API
- [Code Examples Overview](https://docs.sundaypyjamas.com/examples/overview.md): Ready-to-use implementations for integrating the SundayPyjamas AI Suite API in multiple programming languages
- [JavaScript/TypeScript Examples](https://docs.sundaypyjamas.com/examples/javascript.md): Complete examples for integrating the SundayPyjamas AI Suite API with JavaScript and TypeScript applications
- [Python Examples](https://docs.sundaypyjamas.com/examples/python.md): Complete examples for integrating the SundayPyjamas AI Suite API with Python applications
- [cURL Examples](https://docs.sundaypyjamas.com/examples/curl.md): Complete cURL examples for testing and interacting with the SundayPyjamas AI Suite API
- [Development Setup](https://docs.sundaypyjamas.com/development.md): Set up your local development environment for API integration and testing
- [Chat API Reference](https://docs.sundaypyjamas.com/api-reference/chat/introduction.md): Complete API reference for the SundayPyjamas AI Suite Chat API with interactive examples
- [POST /chat](https://docs.sundaypyjamas.com/api-reference/chat/post-chat.md): Send messages to AI models and receive streaming text responses for conversational AI and content generation
- [Agents API](https://docs.sundaypyjamas.com/api-reference/agents/introduction.md): Create and run autonomous or assist-mode AI agents, manage their sessions, and stream results in real time
- [Manage Agents](https://docs.sundaypyjamas.com/api-reference/agents/agents.md): List, create, retrieve, update, and delete managed agent configurations
- [Runs](https://docs.sundaypyjamas.com/api-reference/agents/runs.md): Submit autonomous tasks to an agent and track their progress
- [Sessions](https://docs.sundaypyjamas.com/api-reference/agents/sessions.md): Manage the conversational or work context an agent operates in
- [Messaging & Events](https://docs.sundaypyjamas.com/api-reference/agents/messaging.md): Stream assist-mode replies, read the session timeline, respond to tool calls, and cancel runs
- [RAG API](https://docs.sundaypyjamas.com/api-reference/rag/introduction.md): Upload documents and query them with retrieval-augmented generation
- [POST /rag/upload](https://docs.sundaypyjamas.com/api-reference/rag/upload.md): Upload and index documents for retrieval-augmented generation
- [POST /rag/query](https://docs.sundaypyjamas.com/api-reference/rag/query.md): Ask a natural-language question grounded in your uploaded documents
- [Artifacts API](https://docs.sundaypyjamas.com/api-reference/artifacts/introduction.md): Generate structured, LLM-authored reports from your own aggregated data
- [POST /artifacts/generate](https://docs.sundaypyjamas.com/api-reference/artifacts/generate.md): Generate a structured insight report from aggregated data
- [Image API](https://docs.sundaypyjamas.com/api-reference/image/introduction.md): Generate and edit images with Gemini image models
- [POST /image](https://docs.sundaypyjamas.com/api-reference/image/generate.md): Generate a new image from a prompt, or edit an existing image
- [Vector Store API](https://docs.sundaypyjamas.com/api-reference/vector-store/introduction.md): Per-app vector collections for similarity search and custom retrieval pipelines
- [Indexes](https://docs.sundaypyjamas.com/api-reference/vector-store/indexes.md): Create, list, inspect, and delete vector collections
- [Vectors](https://docs.sundaypyjamas.com/api-reference/vector-store/vectors.md): Upsert and query vector points
- [Apps API](https://docs.sundaypyjamas.com/api-reference/apps/introduction.md): Drive a deployed AI app: send chat messages, manage conversation memory, and track usage
- [Chat](https://docs.sundaypyjamas.com/api-reference/apps/chat.md): Send a message to an app and receive a reply, non-streaming or streamed
- [Memory](https://docs.sundaypyjamas.com/api-reference/apps/memory.md): Manage an app's conversation threads and messages
- [Usage](https://docs.sundaypyjamas.com/api-reference/apps/usage.md): Retrieve usage statistics for an app
- [Storage API](https://docs.sundaypyjamas.com/api-reference/storage/introduction.md): Browse, organize, and import files in a workspace's file tree
- [Files](https://docs.sundaypyjamas.com/api-reference/storage/files.md): List, move, rename, and read file content
- [Folders & Tree](https://docs.sundaypyjamas.com/api-reference/storage/folders.md): Create and rename folders, and browse the folder tree
- [Import](https://docs.sundaypyjamas.com/api-reference/storage/import.md): Bulk-import a folder, zip archive, or GitHub repository
- [Integrations API](https://docs.sundaypyjamas.com/api-reference/integrations/introduction.md): Browse integration packs and manage a workspace's connected MCP tools
- [Integration Packs](https://docs.sundaypyjamas.com/api-reference/integrations/integration-packs.md): Browse the catalog of available integration packs
- [MCP Connectors](https://docs.sundaypyjamas.com/api-reference/integrations/mcp-connectors.md): Connect, disconnect, and toggle a workspace's MCP integrations
- [Insights API](https://docs.sundaypyjamas.com/api-reference/insights/introduction.md): Query conversation analytics and usage across your workspace's apps
- [Conversations](https://docs.sundaypyjamas.com/api-reference/insights/conversations.md): List and inspect conversation analytics
- [Platform Tools API](https://docs.sundaypyjamas.com/api-reference/platform-tools/introduction.md): Browse the catalog of built-in tools available to agents

## OpenAPI Specs

- [openapi](https://docs.sundaypyjamas.com/api-reference/openapi.json)

## Optional

- [API Platform](https://suite.sundaypyjamas.com)
- [GitHub](https://github.com/sundaypyjamas)