> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.reka.ai/vision/api-reference/video-insights/segment-video/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.reka.ai/_mcp/server.

# Segment Video

POST https://vision-agent.api.reka.ai/v2/videos/{video_id}/segment
Content-Type: application/json

Reference: https://docs.reka.ai/vision/api-reference/video-insights/segment-video

## Authentication

- `X-Api-Key` header (required) — API key authentication via X-Api-Key header
- `Authorization` header (bearer token, required) — Bearer token authentication via Authorization header

## Request

### Path parameters

- `video_id` (string, required)

### Headers

- `X-Enable-Overwrite-Metering` (string, optional, nullable)

### Body (application/json)

This endpoint expects a SegmentRequest.

- `prompts` (list of SegmentPrompt, required) — Objects to detect. Each prompt is run against every sampled frame.
- `start` (double, optional, default: 0) — Start of time range in seconds.
- `end` (double, optional, nullable) — End of time range in seconds. Defaults to start + 15s, clamped to video duration. Max range is 15 seconds.
- `threshold` (double, optional, default: 0.3) — Confidence threshold. Detections below this score are excluded.

## Response

### 200

Successful Response

- `frames` (list of SegmentFrame, required)
- `frame_size` (FrameSize, required, nullable)
- `frame_count` (integer, required)

## Types

### SegmentPrompt

- `type` ("text", required) — Prompt type. Currently only 'text' is supported.
- `text` (string, required) — What to detect (e.g., 'person', 'laptop', 'red car').

### SegmentFrame

- `timestamp` (double, required)
- `detections` (list of SegmentDetection, required)

### FrameSize

- `width` (integer, required)
- `height` (integer, required)

### SegmentDetection

- `label` (string, required)
- `prompt_index` (integer, required)
- `score` (double, required)
- `bbox` (SegmentBoundingBox, required)

### SegmentBoundingBox

- `x_min` (double, required)
- `y_min` (double, required)
- `x_max` (double, required)
- `y_max` (double, required)

## Examples

**Request**

```json
{
  "prompts": [
    {
      "type": "string",
      "text": "string"
    }
  ]
}
```

**Response**

```json
{
  "frames": [
    {
      "timestamp": 1.1,
      "detections": [
        {
          "label": "string",
          "prompt_index": 1,
          "score": 1.1,
          "bbox": {
            "x_min": 1.1,
            "y_min": 1.1,
            "x_max": 1.1,
            "y_max": 1.1
          }
        }
      ]
    }
  ],
  "frame_size": {
    "width": 1,
    "height": 1
  },
  "frame_count": 1
}
```

**SDK Code**

```python
import requests

url = "https://vision-agent.api.reka.ai/v2/videos/video_id/segment"

payload = { "prompts": [
        {
            "type": "string",
            "text": "string"
        }
    ] }
headers = {
    "X-Api-Key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://vision-agent.api.reka.ai/v2/videos/video_id/segment';
const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"prompts":[{"type":"string","text":"string"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://vision-agent.api.reka.ai/v2/videos/video_id/segment"

	payload := strings.NewReader("{\n  \"prompts\": [\n    {\n      \"type\": \"string\",\n      \"text\": \"string\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://vision-agent.api.reka.ai/v2/videos/video_id/segment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompts\": [\n    {\n      \"type\": \"string\",\n      \"text\": \"string\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://vision-agent.api.reka.ai/v2/videos/video_id/segment")
  .header("X-Api-Key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompts\": [\n    {\n      \"type\": \"string\",\n      \"text\": \"string\"\n    }\n  ]\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://vision-agent.api.reka.ai/v2/videos/video_id/segment', [
  'body' => '{
  "prompts": [
    {
      "type": "string",
      "text": "string"
    }
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Api-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://vision-agent.api.reka.ai/v2/videos/video_id/segment");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Api-Key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"prompts\": [\n    {\n      \"type\": \"string\",\n      \"text\": \"string\"\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Api-Key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["prompts": [
    [
      "type": "string",
      "text": "string"
    ]
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://vision-agent.api.reka.ai/v2/videos/video_id/segment")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

> One OpenAI-compatible API for Reka models and a curated selection of open models.