- Category: ai models
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 17
- Triggers: 0
- Slug:
BYTE_PLUS_ARK - Version: 20261101_00
Tools
Cancel or Delete Video Task
Cancel or Delete Video Task
Slug:
BYTE_PLUS_ARK_CANCEL_OR_DELETE_VIDEO_TASKIrreversibly cancel a video generation task when it is queued, or permanently delete its task record when it is terminal. BytePlus Ark chooses the effect from the task’s current status; the caller cannot select cancel versus delete. Check the task with Get Video Task first and use only an intended disposable task. Requires a Johor (ap-southeast-1) connection and is unavailable in Dublin (eu-west-1).Input Parameters
Output
Count Message Tokens
Count Message Tokens
Create Chat Completion
Create Chat Completion
Slug:
BYTE_PLUS_ARK_CREATE_CHAT_COMPLETIONGenerate one synchronous chat completion from an activated BytePlus Ark model or inference endpoint in the connected Johor or Dublin region. Text, vision, video, audio, file, reasoning, and tool support varies by model. Streaming is intentionally unavailable because the action runner expects one JSON response.Input Parameters
Activated model ID or inference endpoint ID in the connected region. Parameter and modality support varies by model.
Tool-selection policy: none, auto, or required. Use forced_function_name to require a specific function.
Reasoning depth for supported models.
Output
Create Message
Create Message
Create Multimodal Embedding
Create Multimodal Embedding
Slug:
BYTE_PLUS_ARK_CREATE_MULTIMODAL_EMBEDDINGCreate one semantic embedding from mixed text, image, and supported video inputs using an activated skylark-embedding-vision model. Video input, sparse output, dimensions, and input combinations depend on the model version. Requires a Johor (ap-southeast-1) connection and is unavailable in Dublin (eu-west-1).Input Parameters
Activated skylark-embedding-vision model ID or endpoint ID in the connected region. Video, dimensions, and mixed-input limits depend on model version.
Output
Create Video Task
Create Video Task
Slug:
BYTE_PLUS_ARK_CREATE_VIDEO_TASKStart a potentially billable asynchronous video generation task and return its task ID. Model capabilities and optional parameter support vary. A callback URL, if supplied, may receive task-status POSTs. Requires a Johor (ap-southeast-1) connection and is unavailable in Dublin (eu-west-1).Input Parameters
Generation seed from -1 through 2,147,483,647; use -1 or omit it for provider-selected randomness. Supported by Seedance 1.5 pro and Seedance 1.0 models, not Seedance 2.5.
Video-generation model ID or configured inference endpoint ID available in the connected region. This free-form ID does not make this action validate model-specific parameter compatibility.
Requested aspect ratio, such as 16:9, 4:3, 1:1, 3:4, 9:16, 21:9, or adaptive; support depends on the model. Seedance 2.5 requires adaptive for editing, extension, and first-frame image modes.
Requested frame count from 29 through 289 matching 25 + 4n; supported by Seedance 1.0 pro and pro fast, not Seedance 2.5. This value takes precedence over duration.
Ordered model inputs. Seedance 2.5 supports an optional text item plus up to 50 total references: at most 30 reference images, 10 reference videos, and 10 reference audio clips. Other models have lower limits and different supported combinations; this schema caps total items but does not infer compatibility from the free-form model ID.
Requested video duration in seconds; allowed ranges are model-dependent. Seedance 2.5 supports 4-30 or -1, and editing requires -1. frames takes precedence when both are supplied.
Queue priority from 0 through 9 for Seedance 2.5 and Seedance 2.0 models; larger values run first within the same endpoint. Not supported with flex.
Requested output resolution, commonly 480p, 720p, or 1080p; supported values and defaults depend on the model.
HTTPS endpoint to receive provider POST callbacks when task status changes. Omit it to avoid callback side effects.
Whether to request a fixed camera. Supported by Seedance 1.5 pro and Seedance 1.0 models, not Seedance 2.5, and unavailable for reference-image scenarios.
Execution tier: default for online processing or flex for supported lower-cost offline processing. Seedance 2.5 and Seedance 2.0 models do not support flex.
Seedance 2.5 output container: mp4 (default, broad compatibility) or mov (high color precision for professional workflows). Omit for other models.
Whether to generate audio with the video; omit this to use the selected model’s native default.
Stable privacy-preserving end-user identifier of no more than 64 characters; BytePlus recommends English characters.
Seedance 2.5 omni-reference task hint. auto lets the model infer the task and can fail asynchronously for incompatible parameters. Explicit reference, edit, or extend enables earlier API constraint checks, but the task can still fail asynchronously if the prompt implies a different type. edit requires a 4-30 second reference video and uses ratio=adaptive and duration=-1 by default; extend requires a reference video and uses ratio=adaptive by default. Omit for other models.
Output
Delete File
Delete File
Delete Response
Delete Response
Generate Image
Generate Image
Slug:
BYTE_PLUS_ARK_GENERATE_IMAGEGenerate or edit images synchronously with an activated Seedream model in the connected Johor or Dublin region. Image counts, reference limits, dimensions, prompt optimization, sequences, transparency, and layer decomposition are model-specific. Streaming is intentionally unavailable. This operation is billable.Input Parameters
Activated Seedream model ID or inference endpoint ID in the connected region. Size, editing, decomposition, and sequence support varies by model.
Output
Get File
Get File
Get Response
Get Response
Get Video Task
Get Video Task
List Files
List Files
List Response Input Items
List Response Input Items
List Video Tasks
List Video Tasks
Slug:
BYTE_PLUS_ARK_LIST_VIDEO_TASKSReturn one page of video generation tasks, optionally filtered by status, task IDs, model, or service tier. Requires a Johor (ap-southeast-1) connection and is unavailable in Dublin (eu-west-1).Input Parameters
Return only tasks with this status.
Return only these task IDs. Each ID is sent as a separate repeated filter.task_ids query parameter.
Output
Tokenize Text
Tokenize Text
Slug:
BYTE_PLUS_ARK_TOKENIZE_TEXTTokenize text with an activated BytePlus Ark text model or inference endpoint This endpoint accepts text only; token vocabulary and model availability are model- and region-specific. Requires a Johor (ap-southeast-1) connection and is unavailable in Dublin (eu-west-1).Input Parameters
Activated text model ID or inference endpoint ID in the connected region. The tokenization endpoint currently supports text input only.
Output
Upload File
Upload File
Slug:
BYTE_PLUS_ARK_UPLOAD_FILEUpload a local file or import an HTTP(S) or BytePlus TOS file into BytePlus Ark for model or agent use. Files expire automatically; video preprocessing may continue after this request returns. Requires a Johor (ap-southeast-1) connection and is unavailable in Dublin (eu-west-1).Input Parameters
File purpose: user_data for general model input or agent for agent files.
UTC Unix expiration timestamp. It must be 1-30 days from upload time; omit it for the provider’s 7-day default.