# Documentation

- Get started: Make your first request, learn the platform, get an API key.
  - [Overview](/docs/get-started): Make your first Segmind API request in a few minutes. Get an API key, call a model from cURL, Python, or JavaScript, and find your next steps.
  - [Home](/)
  - [Overview](/docs/get-started): Make your first Segmind API request in a few minutes. Get an API key, call a model from cURL, Python, or JavaScript, and find your next steps.
  - [Quickstart](/docs/get-started/quickstart): Make your first Segmind API request in minutes. Learn the basics of the platform.
  - [Key Concepts](/docs/get-started/key-concepts): Definitions for the terms used across Segmind: models, latency, prompts, tokens, weights, base models, modality, fine-tuning, and the PixelFlow GUI.
  - [Authentication](/docs/get-started/authentication): How to authenticate with Segmind: sign in with Google, Microsoft, Discord or a one-time email link, which host serves the account API, JWT bearer tokens, and API keys for server-to-server calls.
  - [Models](/docs/get-started/models): Browse the Segmind model catalogue, filter by modality and price, and open any model to run it or read its API reference.
  - [Playground](/docs/get-started/playground): Run any Segmind model in the browser: the compose dock, one-click settings, up to three generations at once, the session strip, and editing the raw request as JSON.
  - [Support](/docs/get-started/support): How to get support from Segmind team and community.
- AI Gateway: Serverless models and 3rd-party models via a unified API.
  - [API Reference](/docs/serverless-api): Authenticate with an x-api-key header and call any model on the Segmind AI Gateway over REST, with cURL and Python examples.
  - [Model Catalog](/docs/serverless-api/model-catalog): Every model currently on the Segmind AI Gateway — 672 models with their API slugs, grouped by task. Regenerated automatically from the live catalog.
  - [Async Inference (V2)](/docs/serverless-api/async-inference): Submit inference requests asynchronously and poll for results. Ideal for long-running models like video generation, image upscaling, and LLMs.
  - [Model Status](/docs/serverless-api/model-status): Why a Segmind model responds slowly on its first call: how cold boots and warm boots work, and what each means for request latency.
  - [Webhooks](/docs/serverless-api/webhooks): Receive real-time HTTP POST callbacks from Segmind when a PixelFlow run changes state, so you can react to node and graph events without polling.
  - [Rate Limits](/docs/serverless-api/rate-limits): Segmind implements rate limiting to safeguard the integrity and performance of our API.
  - [Random Seed](/docs/serverless-api/random-seed): Use the seed parameter to control randomness in Segmind model output. Pass -1 for a random seed, or any positive integer for reproducible results.
  - [Structured Outputs](/docs/serverless-api/structured-outputs): Constrain a chat model's reply to JSON — or to a JSON Schema you supply — with response_format, and know where the JSON arrives for each provider.
  - [Web Search Grounding](/docs/serverless-api/web-search-grounding): Ground Gemini text and image generations in live Google Search results with web_search: true, and read back the queries and sources behind the answer.
  - [Video Editing](/docs/serverless-api/video-editing): Compose multi-track video with /v2/timeline, split a video into clips with /v2/video-split, and run thumbnail, GIF and format-conversion jobs — all on the same async contract as the models.
  - [Monitoring](/docs/serverless-api/monitoring): Track Segmind API usage from the console: Generations for individual requests, Cost Analytics for spend, and API Health for latency percentiles, success rate and error breakdown.
  - [Logging](/docs/serverless-api/logging): What Segmind logs for usage and billing, the data we never store, and how long files are held temporarily during model fine-tuning.
  - [Segmind Storage](/docs/serverless-api/segmind-storage): Upload files to Segmind Storage and get a reusable URL to pass as an image input to any model, instead of re-uploading the same file.
  - Dedicated Endpoints: Scale-from-zero managed endpoints with autoscaling.
    - [Dedicated Endpoints](/docs/serverless-api/dedicated-endpoints): Endpoints are GPU instances enabling AI models to be deployed on dedicated hardware . This enables private inferences that automatically scale up or down based on traffic.
    - [Getting started](/docs/serverless-api/dedicated-endpoints/getting-started): Find the Endpoints page in the Segmind console, deploy a model onto your own GPUs, and manage the endpoints you have running.
    - [Endpoint APIs](/docs/serverless-api/dedicated-endpoints/endpoint-apis): Endpoints can be managed via APIs as well as UI. Use the APIs to create/delete endpoints, update capacity or other configuration parameters for each endpoint.
- PixelFlow: Visual AI workflow builder. Chain image, video, audio, and LLM models and publish them as an API.
  - [PixelFlow: Visual AI Workflow Builder](/docs/pixelflow): Build AI workflows on a visual canvas — chain image, video, audio, and LLM models without code, then publish any workflow as a production-ready API.
  - [Getting Started](/docs/pixelflow/getting-started): Create your first AI workflow in PixelFlow: open the library, add input, model, and output nodes, connect them, and run — all in under ten minutes.
  - [Key Concepts](/docs/pixelflow/key-concepts): The PixelFlow mental model: workflows, nodes, edges, runs, templates, published versions, pinned outputs, credits, and teams — defined in one place.
  - [The Editor](/docs/pixelflow/the-editor): Tour the PixelFlow editor: the canvas, model search, asset gallery, logs panel, node configuration, run controls, auto-save, and undo/redo.
  - Node Types
    - [Node Types](/docs/pixelflow/nodes): The five node types in PixelFlow — input, model, output, utility, and notes — and how data flows between them through ports and edges.
    - [Model Nodes](/docs/pixelflow/nodes/model-nodes): Add any Segmind model to a workflow: search the catalog, configure parameters from the model's schema, see cost estimates, and send images to vision LLMs.
    - [Input Nodes](/docs/pixelflow/nodes/input-nodes): Feed data into PixelFlow workflows: text, number, dropdown, multi-select, JSON, and boolean inputs, plus file uploads with an inline inpainting mask tool.
    - [Output Nodes](/docs/pixelflow/nodes/output-nodes): Display workflow results with output nodes — automatic rendering for images, video, audio, text, and 3D — and name them to define your API's response fields.
    - [Utility Nodes](/docs/pixelflow/nodes/utility-nodes): Text concatenation, image resize, text split, and array join are implemented in the PixelFlow engine but cannot yet be added from the editor. What they will do, and what to use instead.
    - [Notes](/docs/pixelflow/nodes/notes-nodes): Document workflows on the canvas with resizable, color-coded sticky notes. Notes never execute and are stripped from published APIs.
  - Guides
    - [Build Your First Workflow](/docs/pixelflow/guides/build-your-first-workflow): A step-by-step PixelFlow tutorial: build a text-to-image workflow from a blank canvas, run it, iterate with pinning, and get it ready to publish as an API.
    - [Pinning and Caching](/docs/pixelflow/guides/pinning-and-caching): Pin nodes in PixelFlow to cache their output across runs — skip expensive re-execution, iterate faster, and save credits while you refine a workflow.
    - [LLM Chat History](/docs/pixelflow/guides/llm-chat-history): The Chat History input on PixelFlow's LLM nodes is not yet carrying conversation context between turns. What the connection does today, and what to use instead.
    - [Fan-Out and Parallel Runs](/docs/pixelflow/guides/fan-out-and-parallel): Run a model once per item with fan-out edges in PixelFlow, then gather results with collect — visual map/reduce for AI: batch images, compare models, scale prompts.
    - [The Asset Library](/docs/pixelflow/guides/asset-library): Every file you upload or generate is kept in one library — searchable, filterable by type, tagged by project and category, and reusable across workflows without re-uploading.
    - [AI Assistant](/docs/pixelflow/guides/ai-agent-assistant): PixelFlow's in-editor AI assistant is in beta and not yet answering questions. The per-node Refine with AI tools work today.
    - [Sharing and Collaboration](/docs/pixelflow/guides/sharing-and-collaboration): Share PixelFlow workflows with teammates by email or team, duplicate workflows, and export them as reusable templates for your organization.
  - [Templates](/docs/pixelflow/templates): Start from working AI workflow templates: browse the PixelFlow gallery, clone any template into your workspace, and customize it — no blank-canvas problem.
  - [Publish a Workflow as an API](/docs/pixelflow/publish-as-api): Turn any PixelFlow workflow into a production REST API: name your inputs and outputs, publish a version, test it in the console, and call it from your code.
  - [Workflow API Reference](/docs/pixelflow/api-reference): Call a published PixelFlow workflow over REST: submit to POST /workflows/v2/{slug}, poll the status URL, and fetch results — with cURL, Python, and JavaScript examples.
  - Use Cases
    - [PixelFlow as a ComfyUI Alternative](/docs/pixelflow/use-cases/comfyui-alternative): A cloud ComfyUI alternative with no GPU, no install, and no Python: build node-based AI workflows in the browser and publish them as production REST APIs.
    - [Build a Text-to-Image API](/docs/pixelflow/use-cases/text-to-image-api-workflow): Build a text-to-image API without writing model code: wire a prompt input to an image model in PixelFlow, publish it, and call your endpoint from any app.
    - [No-Code AI Pipelines](/docs/pixelflow/use-cases/no-code-ai-pipeline): Build no-code AI pipelines that chain image, video, audio, and language models on a visual canvas — then ship each pipeline as a REST API your team can call.
- SDKs: Official client libraries for the Segmind platform.
  - [SDKs](/docs/sdks): Official client libraries for the Segmind platform. Submit inference, poll for results, chat with LLMs, and upload files — without hand-rolling HTTP and polling loops.
  - [Python SDK](/docs/sdks/python): Run any Segmind model from Python. Async-by-default run(), explicit sync run_sync(), submit/poll handles for long jobs, and a normalized LLM chat() — all over the v2 async gateway.
- Platform: Billing, teams, settings, and product updates.
  - [Platform](/docs/platform): Manage your plan, billing, teams, and developer settings.
  - [Pricing and Billing](/docs/platform/pricing-and-billing): How Segmind charges for model APIs: per GPU-second or per generation, how GPU type affects cost, plus subscription plans and how billing works.
  - [Account and Billing APIs](/docs/platform/account-and-billing-apis): Check your Segmind credit balance programmatically with the get-user-credits endpoint, authenticated by your API key.
  - [Teams](/docs/platform/teams): Group work into Segmind teams, switch between workspaces, invite members with Admin or Member roles, and track team usage.
  - [Account and Developer Settings](/docs/platform/settings): Find your account and developer settings in the Segmind console: profile, API keys, webhooks, and how to request account deletion.
  - [Referrals and Affiliates](/docs/platform/referrals): Earn $10 in credits for every person you refer who spends $10 or more on Segmind, up to $100, plus details of the Segmind Affiliate Program.
  - [Refund Policy](/docs/platform/refund-policy): We understand that circumstances can change, and we aim to keep our refund process clear, fair, and transparent.
  - Changelog: Platform updates and feature releases.
    - [Release Notes](/docs/platform/release-notes): New models, API features, and platform improvements on Segmind — summarized every week.
    - [Segmind Release Notes (September 7–13, 2026)](/docs/platform/release-notes/2026-09-13-weekly): Segmind updates for September 7 to 13, 2026: new GPT Image 2.5 Flare and Sunburst models, Pruna p-video-2 with native audio, the Imagen slugs moved to Gemini 2.5 Flash Image, a Seedance 2.0 Mini price cut, parsed structured output for LLM calls, the hosted MCP server landing page, Pixelflow copy and paste across workflows, clearer moderation errors, and console improvements.
    - [Segmind Release Notes (August 31–September 6, 2026)](/docs/platform/release-notes/2026-09-06-weekly): Segmind updates for August 31 to September 6, 2026: three new models (Sarvam Bulbul v3 TTS, Pruna video editing, MiniMax H3 Max Turbo), structured output for LLMs, named and model-scoped API keys, a Developer team role with team spending caps, OAuth connected apps, playground and Pixelflow improvements, and reliability fixes.
    - [Segmind Release Notes (August 24–30, 2026)](/docs/platform/release-notes/2026-08-30-weekly): Segmind updates for August 24 to 30, 2026: restored availability across the Kling and Ideogram 3 families, a Wan 3.0 Video contract update, in-playground mask drawing and a raw JSON response view, more forgiving uploads and dimensions, API key attribution in request history, working dedicated-endpoint controls, and a batch of Pixelflow reliability fixes.
    - [Segmind Release Notes (August 17–23, 2026)](/docs/platform/release-notes/2026-08-23-weekly): Segmind updates for August 17 to 23, 2026: Google Lyria 3 music generation with timed lyrics, Seedance 2.5 at 1080p, audio on by default and forgiving Seedance inputs, clearer 401 and async errors, a Cost Analytics member filter, restored team model access controls, and a batch of Pixelflow reliability fixes.
    - [Segmind Release Notes (August 10–16, 2026)](/docs/platform/release-notes/2026-08-16-weekly): Segmind updates for August 10 to 16, 2026: object extraction and layer decomposition models, LTX 2.5, Grok Imagine Image 2, an annotatable playground with shot chaining, clearer API errors, x-api-key code samples, per-team-member usage visibility, and Pixelflow partner publishing.
    - [Segmind Release Notes (August 3–9, 2026)](/docs/platform/release-notes/2026-08-09-weekly): Segmind updates for August 3 to 9, 2026: Sonilo audio models, the FLUX 3 video family with draft enhance, Seedance 2.5 and new video controls, magic-link sign-in for everyone, Bundles, and a more persistent playground.
    - [Segmind Release Notes (July 27–August 2, 2026)](/docs/platform/release-notes/2026-08-02-weekly): Segmind updates for July 27 to August 2, 2026: two new image models, full multi-image responses, portrait reference-to-video, a resizable playground, and clearer team model access.
    - [Segmind Release Notes (July 20–26, 2026)](/docs/platform/release-notes/2026-07-26-weekly): Segmind updates for July 20 to 26, 2026: opt-in web search grounding for Gemini models, source citations, and a redesigned model playground.
    - [Segmind Release Notes (July 13–19, 2026)](/docs/platform/release-notes/2026-07-19-weekly): Segmind updates for July 13 to 19, 2026: the glm-5.2, nemotron-3-ultra, and minimax-m3 chat models, plus veed-2-lipsync and a multi-clip gallery.
    - [Segmind Release Notes (July 6–12, 2026)](/docs/platform/release-notes/2026-07-12-weekly): Segmind updates for July 6 to 12, 2026: Seedream 5.0 Pro, new VEED video models, HeyGen avatar looks, and auto-clipping for long-form video.
    - [Segmind Release Notes (June 29–July 5, 2026)](/docs/platform/release-notes/2026-07-05-weekly): Segmind updates for June 29 to July 5, 2026: gemini-omni-flash text and image-to-video, nano-banana-2-lite, and full p-image-upscale controls.
    - [Segmind Release Notes (June 22–28, 2026)](/docs/platform/release-notes/2026-06-28-weekly): Segmind updates for June 22 to 28, 2026: HappyHorse 1.1 video, the cheaper Seedance 2.0 Mini, and a p-image-try-on virtual try-on model.
    - [Segmind Release Notes (June 15–21, 2026)](/docs/platform/release-notes/2026-06-21-weekly): Segmind updates for June 15 to 21, 2026: an OAuth 2.1 server for connecting third-party apps without sharing an API key, and Grok Imagine controls.
    - [Segmind Release Notes (June 8–14, 2026)](/docs/platform/release-notes/2026-06-14-weekly): Segmind updates for June 8 to 14, 2026: Grok Imagine text-to-image, Bria Video Background Removal 3.0, and more reliable async inference.
    - [Segmind Release Notes (June 1–7, 2026)](/docs/platform/release-notes/2026-06-07-weekly): Segmind updates for June 1 to 7, 2026: Ideogram 4, MAI Image 2.5, and TripoSPLAT image-to-3D, plus dynamic fan-out in the PixelFlow editor.
    - [Segmind Release Notes (May 25–31, 2026)](/docs/platform/release-notes/2026-05-31-weekly): Segmind updates for May 25 to 31, 2026: PDF, audio, and video inputs for Claude and other LLMs, an editable JSON playground, and a 2 GB upload limit.
    - [Segmind Release Notes (May 19–25, 2026)](/docs/platform/release-notes/2026-05-24-weekly): Segmind updates for May 19 to 25, 2026: a new Observability dashboard for API health and cost, a team usage summary API, and auto-recharge changes.
    - [Segmind Website Release Notes (April 5-19, 2025)](/docs/platform/release-notes/2025-04-19-website): Segmind website updates through April 19, 2025: a redesigned video model explorer, shareable playground URLs, an examples manager, and new navigation.
    - [Segmind Website Release Notes (April 5-18, 2025)](/docs/platform/release-notes/2025-04-18-segmind-website): Segmind website updates for April 5 to 18, 2025: rebuilt Algolia search, partner integrations, dynamic pricing, and model playground improvements.
    - [Console Release Notes (April 7-11, 2025)](/docs/platform/release-notes/2025-04-18-console): Segmind console updates for April 7 to 11, 2025: a reworked date picker across the app, a branded 404 page, and fixes to team switching inside workflows.