MetaSAM 3 VideoVideo → Video
Segment and track objects through a video from a text prompt — name several objects separated by commas and SAM 3 keeps each one masked across every frame.
Overview
Alongside the unified model APIs, we expose compatibility APIs that take each vendor's original parameters exactly as the vendor defines them — nothing renamed, nothing reshaped on the way through.
That makes them the shortest path onto Picsart if you already work with the vendor directly: the request bodies you've already written keep working as they are. You keep their parameter names and defaults, and you get the vendor's full parameter set rather than the subset that is shared across every model.
The cost is that a request is written for one vendor — switching models later means rewriting it, and results come back in the vendor's own shape. When you'd rather write once and change models freely, use the unified API.
Make a request
Call the workflow with ai.apis.run() in TypeScript, or hit /workflows/{workflow}/execute directly — params is passed through untouched either way.
These endpoints are addressed by workflow name rather than model id: the one in this model's header, since one model runs as one workflow. Authentication is unchanged — your Picsart API key as a bearer token (see Authentication).
import { createClient, ApiRunMode } from '@picsart/ai-sdk';
const ai = createClient({
apiKey: process.env.PICSART_API_KEY,
apiUrl: 'https://api.picsart.com',
});
// Calls the 'sam-3/video' workflow directly — params are sent as-is.
const { result, usage } = await ai.apis.run('sam-3/video', {
prompt: "person",
video_url: "https://cdn.example.com/input.mp4"
}, {
mode: ApiRunMode.SYNC,
});
console.log(result); // workflow-specific output
console.log(usage?.credits); // amount charged, in $Async (submit & poll)
This model can run longer than the sync limit (~20s). In TypeScript, ai.apis.run(…, { mode: ApiRunMode.ASYNC }) polls for you; over HTTP, submit and poll yourself.
import { createClient, ApiRunMode } from '@picsart/ai-sdk';
const ai = createClient({
apiKey: process.env.PICSART_API_KEY,
apiUrl: 'https://api.picsart.com',
});
// mode: ASYNC submits the job and polls under the hood — you just await.
const { result } = await ai.apis.run('sam-3/video', {
prompt: "person",
video_url: "https://cdn.example.com/input.mp4"
}, {
mode: ApiRunMode.ASYNC,
});
console.log(result);Parameters
9 parameters, sent inside params. These are the vendor's own names, so they line up one-for-one with the vendor's documentation. Required ones must be supplied; the rest fall back to their defaults.
| Parameter | Type | Required | Default | Details |
|---|---|---|---|---|
promptText prompt for segmentation. Use commas to track multiple objects (e.g., 'person, cloth'). | string | no | | e.g. person |
apply_maskApply the mask on the video. | boolean | no | true | — |
text_promptdeprecated[DEPRECATED] Use 'prompt' instead. Kept for backward compatibility. | string | no | — | — |
video_urlThe URL of the video to be segmented. | string | yes | — | — |
box_promptsList of box prompt coordinates (x_min, y_min, x_max, y_max). | BoxPromptBase[] | no | [] | — |
└ x_maxX Max Coordinate of the box | integer | no | — | — |
└ y_minY Min Coordinate of the box | integer | no | — | — |
└ y_maxY Max Coordinate of the box | integer | no | — | — |
└ x_minX Min Coordinate of the box | integer | no | — | — |
└ object_idOptional object identifier. Boxes sharing an object id refine the same object. | integer | no | — | — |
video_output_typeThe output type of the generated video. | string | no | X264 (.mp4) | X264 (.mp4)VP9 (.webm) |
detection_thresholdDetection confidence threshold (0.0-1.0). Lower = more detections but less precise. | number | no | 0.5 | 0.1–1 |
point_promptsList of point prompts | PointPromptBase[] | no | [] | — |
└ yY Coordinate of the prompt | integer | no | — | — |
└ xX Coordinate of the prompt | integer | no | — | — |
└ object_idOptional object identifier. Prompts sharing an object id refine the same object. When a text prompt is also given, the id selects which detected object the points refine. | integer | no | — | — |
└ label1 for foreground, 0 for background | integer | no | — | 01 |
optionsPlatform-specific options for safety checks and Picsart Drive integration. | object | no | — | — |
└ safety_checksSafety check configuration. | object | no | — | — |
└ enabledEnable or disable text safety checks. Defaults to true. | boolean | no | true | — |
└ drivePicsart Drive storage options. When provided, the result will be saved to the user's Drive. | object | no | — | — |
└ nameFilename to save the result as in Picsart Drive. | string | yes | — | — |
└ attributesAdditional file metadata attributes. | object | no | — | — |
└ folderDestination folder in Picsart Drive. | object | no | — | — |
Response
Over HTTP the output arrives inside a status envelope, at response.result. ai.apis.run() unwraps that envelope for you and resolves to { result, usage } instead. Either way the result itself is the vendor's own shape.
{
"result": {
"boundingbox_frames_zip": {
"file_name": "z9RV14K95DvU.png",
"url": "https://cdn.picsart.com/…/result.mp4",
"content_type": "image/png",
"file_size": 4404019
},
"video": {
"file_name": "z9RV14K95DvU.png",
"url": "https://cdn.picsart.com/…/result.mp4",
"content_type": "image/png",
"file_size": 4404019
}
}
}