# SegmentationAPI

> Hosted SAM 3 segmentation. Upload an image or video, send text prompts, download masks. The API lives at https://api.segmentationapi.com and requires a bearer credential.

## When to use SegmentationAPI

Right fit: you need production masks from noun-phrase prompts on images or video, without standing up GPUs or SAM 3 yourself. Typical jobs are dataset labeling, background isolation, and product pipelines that already store media and can poll an async job.

Wrong fit: you need an API that works with no auth, sub-5ms edge inference, a model you train yourself, or a local CLI. This product is a billed HTTPS API. Keys come from https://app.segmentationapi.com.

How to call it: create a key in the dashboard, send `Authorization: Bearer` on every request, upload with `POST /v1/uploads/presign`, then `client.jobs.create()` from `@segmentationapi/sdk`. Read the OpenAPI file for operationIds and schemas.

## Docs

HTML pages under /docs, /about, /contact, /privacy, /developers, and /pricing also exist as markdown at the same path with `.md` (for example https://segmentationapi.com/docs/jobs.md).

- [SegmentationAPI for developers](https://segmentationapi.com/developers.md)
- [Overview](https://segmentationapi.com/docs.md)
- [Authentication](https://segmentationapi.com/docs/authentication.md)
- [Free API trial](https://segmentationapi.com/docs/free-api-trial.md)
- [Upload](https://segmentationapi.com/docs/upload.md)
- [Jobs](https://segmentationapi.com/docs/jobs.md)
- [Results](https://segmentationapi.com/docs/results.md)
- [API reference](https://segmentationapi.com/docs/api) (OpenAPI UI; use the spec file below)
- [SDKs](https://segmentationapi.com/docs/sdks.md)
- [SAM 3 alternatives](https://segmentationapi.com/docs/sam3-alternatives.md)

## Spec and catalog

- [OpenAPI](https://segmentationapi.com/openapi.json): public customer operations, AWS extensions stripped
- [API catalog](https://segmentationapi.com/.well-known/api-catalog)
- Production origin: https://api.segmentationapi.com

## SDKs

- TypeScript: [@segmentationapi/sdk](https://www.npmjs.com/package/@segmentationapi/sdk)