Sam V2.1 Hiera Large Serverless API

SAM v2, the next-gen segmentation model from Meta AI, revolutionizes computer vision. Building on SAM's success, it excels at accurately segmenting objects in images, offering robust and efficient solutions for various visual contexts.

~24.97s
~$0.037
PlaygroundAPI
Pricing
 1import requests
 2import json
 3
 4url = "https://api.segmind.com/v1/sam-v21-hiera-large"
 5headers = {
 6    "x-api-key": "YOUR_API_KEY",
 7    "Content-Type": "application/json"
 8}
 9
10data = {
11    "image": "https://huggingface.co/datasets/hf-internal-testing/sam2-fixtures/resolve/main/truck.jpg",
12    "make_overlay": true,
13    "save_polygons": true,
14    "save_rle": true,
15    "save_pngs": true,
16    "points_per_side": 32,
17    "points_per_batch": 64,
18    "pred_iou_thresh": 0.86,
19    "stability_score_thresh": 0,
20    "min_mask_region_area": 0,
21    "nms_iou_thresh": 0.7,
22    "max_masks": 0,
23    "polygon_epsilon": 0,
24    "tile_size": 0,
25    "tile_stride": 0
26}
27
28response = requests.post(url, headers=headers, json=data)
29
30if response.status_code == 200:
31    result = response.json()
32    print(json.dumps(result, indent=2))
33else:
34    print(f"Error: {response.status_code}")
35    print(response.text)

API Endpoint

POSThttps://api.segmind.com/v1/sam-v21-hiera-large

Parameters

imagerequired
string (uri)

Input image URL or base64 encoded image

Default: "https://huggingface.co/datasets/hf-internal-testing/sam2-fixtures/resolve/main/truck.jpg"
make_overlayoptional
boolean

Generate overlay image with masks

Default: true
max_masksoptional
integer

Maximum number of masks to return (0 = no limit)

Default: 0Range: 0 - 100
min_mask_region_areaoptional
integer

Minimum mask area in pixels

Default: 0Range: 0 - 10000
nms_iou_threshoptional
number

Non-Maximum Suppression IoU threshold

Default: 0.7Range: 0 - 1
points_per_batchoptional
integer

Number of points per batch for processing

Default: 64Range: 16 - 128
points_per_sideoptional
integer

Number of points per side for mask generation

Default: 32Range: 8 - 64
polygon_epsilonoptional
number

Epsilon for polygon simplification

Default: 0Range: 0 - 10
pred_iou_threshoptional
number

Prediction IoU threshold for mask filtering

Default: 0.86Range: 0.5 - 1
save_pngsoptional
boolean

Generate individual PNG masks in ZIP

Default: true
save_polygonsoptional
boolean

Include polygon coordinates in output

Default: true
save_rleoptional
boolean

Include COCO RLE format in output

Default: true
stability_score_threshoptional
number

Stability score threshold for mask filtering

Default: 0Range: 0 - 1
tile_sizeoptional
integer

Tile size for large images (0 = disabled)

Default: 0Range: 0 - 2048
tile_strideoptional
integer

Tile stride for large images (0 = use tile_size)

Default: 0Range: 0 - 2048

Response Type

Returns: Text/JSON

Common Error Codes

The API returns standard HTTP status codes. Detailed error messages are provided in the response body.

400

Bad Request

Invalid parameters or request format

401

Unauthorized

Missing or invalid API key

403

Forbidden

Insufficient permissions

404

Not Found

Model or endpoint not found

406

Insufficient Credits

Not enough credits to process request

429

Rate Limited

Too many requests

500

Server Error

Internal server error

502

Bad Gateway

Service temporarily unavailable

504

Timeout

Request timed out