SegmentationAPI logo
Start Building

Documentation

SegmentationAPI provides a simple upload-then-segment workflow powered by Meta's SAM 3. Upload media, submit segmentation jobs with text prompts, and retrieve high-quality masks through a handful of REST endpoints.

Quick Start

The integration flow consists of three steps:

  • Upload — Request a presigned URL from POST /v1/uploads/presign, then PUT your file directly to S3.
  • Segment — Submit the returned task ID(s) with text prompts to POST /v1/jobs to queue a segmentation job.
  • Retrieve — Poll GET /v1/jobs/{jobId} until the job succeeds, then request a results archive via POST /v1/jobs/{jobId}/download and read output_manifest.json from the downloaded zip.

Endpoints

POST/v1/uploads/presign

Request a short-lived presigned upload URL and receive a task ID.

POST/v1/jobs

Queue an async image or video segmentation job.

GET/v1/jobs

List paginated jobs for the authenticated account.

GET/v1/jobs/{jobId}

Retrieve per-item status for a specific job.

POST/v1/jobs/{jobId}/download

Request a downloadable results archive once a job has succeeded.

GET/v1/jobs/{jobId}/download

Poll archive readiness and get the presigned download URL.

Explore

Authentication

API key management, request headers, and rate limits for all endpoints.

Upload Flow

Presigned URL generation, direct S3 upload, and task ID lifecycle.

Jobs

Create segmentation jobs, track status, and list job history.

Results

Request the results archive, poll until ready, and read the output manifest.

SAM3 Alternatives

Benchmark comparisons, capability matrices, and deployment trade-offs across leading models.