Guides

Documentation

SegmentationAPI is a hosted SAM 3 pipeline. Upload media, submit text prompts, and download masks through a few authenticated REST calls. The production origin is https://api.segmentationapi.com. Keys come from the dashboard.

Three-step flow

  1. Upload. POST /v1/uploads/presign, then PUT the file to the returned URL. Keep the taskId.
  2. Segment. client.jobs.createJob() (or POST /v1/jobs) with that task ID and one or more prompts.
  3. Download. Poll until the job succeeds, then client.jobs.retrieveJobResult() or the archive download endpoints.

Field-level request and response shapes live in the API reference. Do not copy endpoint tables out of this guide; the OpenAPI file is the source of truth.

Playground and SDKs

Use the dashboard as the playground: create a key, run a trial job, and inspect results. For application code, start with @segmentationapi/sdk:

1import { SegmentationAPIClient } from "@segmentationapi/sdk";
2
3const apiKey = process.env.SEGMENTATION_API_KEY;
4if (!apiKey) {
5  throw new Error("SEGMENTATION_API_KEY is required");
6}
7
8const client = new SegmentationAPIClient({ token: apiKey });
9const upload = await client.uploads.createUploadPresign({ contentType: "image/png" });

See SDKs for the full upload → job → download sample.

Next