> Documentation index for agents: https://docs.rocketride.ai/llms.txt

# twelvelabs

A RocketRide video node that sends an incoming video to TwelveLabs and emits
the service's generated text response.

## About TwelveLabs

TwelveLabs is the video-analysis service that this node contacts. RocketRide
uses it to index a submitted video temporarily and request text generated from
that indexed video.

## What it does

The node receives `video` data, streams it to a temporary file as it arrives,
submits the completed file for analysis, and writes the returned text to
`text` when that lane has a listener. Pick it when a pipeline needs a hosted
analysis response for a complete video, rather than local playback,
transcription, or speech generation. There is no agent-tool interface.

## Lanes

| Lane in | Lane out | Description |
| --- | --- | --- |
| `video` | `text` | Submit the completed video stream and emit its generated text response. |

## Configuration

Set the API key and add instructions only when the default description prompt
is not enough. The node has one `default` profile, so profile selection itself
does not change its behavior.

### Instructions

The instruction strings are joined with newlines and sent as the analysis
prompt. Leave the list empty to use `Describe this video.`. Add instructions
when the response needs to answer a particular question or follow a particular
format; use separate entries for distinct constraints so they remain readable
in the configuration panel.

## Authentication

Set `apikey` to the API key accepted by the TwelveLabs client. The key and
instructions are loaded once when the pipeline starts and shared by the node's
instances.

## Notes

### Submission lifecycle and failures

Every stream is written to a temporary file as its chunks arrive (not buffered
in memory first), then analyzed through a new index named
`rocketride-<random>` once the stream ends. The node polls the indexing task
every five seconds, fails if that task reports `failed`, and raises
`TwelveLabs task timed out` after 15 minutes. It attempts to delete both the
temporary index and the local temporary file even when processing fails; an
empty service response is emitted as `No data from TwelveLabs`.

### Input file suffix

The local temporary-file suffix follows the input MIME type for MP4, QuickTime,
AVI, WebM, Matroska, and MPEG video. Any other MIME type is written with an
`.mp4` suffix. This only determines the temporary filename; choose a MIME type
that accurately describes the input so the upload is not mislabeled.

## Upstream docs

- [TwelveLabs documentation](https://docs.twelvelabs.io)

<!-- ROCKETRIDE:GENERATED:PARAMS START -->
<!-- Generated by nodes:docs-generate. Do not edit by hand. -->

## Schema

| Field | Type | Description | Default |
|---|---|---|---|
| `twelvelabs.apikey` | `string` | **API Key**<br/>TwelveLabs API key. |  |
| `twelvelabs.instructions` | `array` | **Instructions**<br/>Instructions to guide TwelveLabs when analyzing the video. |  |
| `twelvelabs.profile` | `string` |  | `"default"` |

## Dependencies

- `twelvelabs`

## Source

[<svg viewBox="0 0 16 16" width="15" height="15" fill="currentColor" aria-hidden="true" style="vertical-align:-0.15em;margin-right:0.35em"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"/></svg> View source](https://github.com/rocketride-org/rocketride-server/tree/develop/nodes/src/nodes/twelvelabs)
<!-- ROCKETRIDE:GENERATED:PARAMS END -->
