Open-ended analysis
This endpoint analyzes your videos and creates fully customizable text based on your prompts, including but not limited to tables of content, action items, memos, and detailed analyses.
<Note title="Notes">
- This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
- This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Open-ended analysis](/v1.3/docs/guides/analyze-videos/open-ended-analysis#streaming-responses) guide.
</Note>
Headers
x-api-key
Request
Request to analyze a video and generate text based on its content.
video_id
The unique identifier of the video for which you wish to generate a text.
prompt
A prompt that guides the model on the desired format or content.
<Note title="Notes">
- Even though the model behind this endpoint is trained to a high degree of accuracy, the preciseness of the generated text may vary based on the nature and quality of the video and the clarity of the prompt.
- Your prompts can be instructive or descriptive, or you can also phrase them as questions.
- The maximum length of a prompt is 2,000 tokens.
</Note>
**Examples**:
- Based on this video, I want to generate five keywords for SEO (Search Engine Optimization).
- I want to generate a description for my video with the following format: Title of the video, followed by a summary in 2-3 sentences, highlighting the main topic, key events, and concluding remarks.
temperature
Controls the randomness of the text output generated by the model. A higher value generates more creative text, while a lower value produces more deterministic text output.
Default: 0.2 Min: 0 Max: 1
stream
Set this parameter to `true` to enable streaming responses in the <a href="https://github.com/ndjson/ndjson-spec" target="_blank">NDJSON</a> format.
**Default:** `true`
response_format
Use this parameter to specify the format of the response. When you omit this parameter, the platform returns unstructured text.
max_tokens
The maximum number of tokens to generate.
Response
The specified video has successfully been processed.
<Note title="Note">
The maximum length of the response is 4,096 tokens.
</Note>
Streamed response
OR
Non-streamed response