> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://fastpix.com/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://fastpix.com/docs/_mcp/server.

# Enable named entities on a media

PATCH https://api.fastpix.com/v1/on-demand/{mediaId}/named-entities
Content-Type: application/json

This endpoint will be deprecated on September 30, 2026. To extract named entities from an existing media, use [Extract named entities from video](/docs/in-video-ai-api/named-entities/create-ai-named-entities) instead.

This endpoint allows you to extract named entities from an existing media.
Named Entity Recognition (NER) is a fundamental natural language processing (NLP) technique that identifies and classifies key information (entities) in text into predefined categories. For instance:

* Organizations (for example, "Microsoft", "United Nations")
* Locations (for example, "Paris", "Mount Everest")
* Product names (for example, "iPhone", "Coca-Cola")

#### How it works

1. Make a PATCH request to this endpoint, replacing `<mediaId>` with the ID of the media you want to extract named-entities.
2. Include the `namedEntities` parameter in the request body to enable.
3. Receive a response containing the updated media data, confirming the changes made.

You can use the video.mediaAI.named-entities.ready webhook event to track and notify about the named entities extraction.

**Use case:** If a user uploads a video and later decides to enable named entity extraction without re-uploading the entire video.

Related guide: Named entities

Reference: https://fastpix.com/docs/in-video-ai-api/named-entities/update-media-named-entities

## Authentication

- `Authorization` header (basic auth, required) — FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request. * Username: Access Token ID * Password: Secret Key Activate your FastPix account to generate your API credentials. See the guide here

## Request

### Path parameters

- `mediaId` (string, required) — The unique identifier assigned to the media when created. The value must be a valid UUID.

### Body (application/json)

This endpoint expects an object.

- `namedEntities` (boolean, required) — Enable or disable named entity extraction. Set to `true` to enable or `false` to disable.

## Response

### 200

Media details updated successfully with the named entity extraction feature enabled or disabled

- `success` (boolean, optional) — Indicates if the request was successful or not.
- `data` (NamedEntitiesResponse, optional)

## Types

### NamedEntitiesResponse

- `mediaId` (string, optional)
- `isNamedEntitiesEnabled` (boolean, optional)

## Examples

**Request**

```json
{
  "namedEntities": true
}
```

**Response**

```json
{
  "success": true,
  "data": {
    "mediaId": "c695988b-ff84-42ae-bb21-10f284fedb0e",
    "isNamedEntitiesEnabled": true
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.fastpix.com/v1/on-demand/0cec3c88-c69d-4232-9b96-f0976327fa2d/named-entities"

payload = { "namedEntities": True }
headers = {
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers, auth=("<username>", "<password>"))

print(response.json())
```

```javascript
const url = 'https://api.fastpix.com/v1/on-demand/0cec3c88-c69d-4232-9b96-f0976327fa2d/named-entities';
const credentials = btoa("<username>:<password>");

const options = {
  method: 'PATCH',
  headers: {
    Authorization: `Basic ${credentials}`,
    'Content-Type': 'application/json'
  },
  body: '{"namedEntities":true}'
};

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://api.fastpix.com/v1/on-demand/0cec3c88-c69d-4232-9b96-f0976327fa2d/named-entities"

	payload := strings.NewReader("{\n  \"namedEntities\": true\n}")

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

	req.SetBasicAuth("<username>", "<password>")
	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://api.fastpix.com/v1/on-demand/0cec3c88-c69d-4232-9b96-f0976327fa2d/named-entities")

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

request = Net::HTTP::Patch.new(url)
request.basic_auth("<username>", "<password>")
request["Content-Type"] = 'application/json'
request.body = "{\n  \"namedEntities\": true\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.patch("https://api.fastpix.com/v1/on-demand/0cec3c88-c69d-4232-9b96-f0976327fa2d/named-entities")
  .basicAuth("<username>", "<password>")
  .header("Content-Type", "application/json")
  .body("{\n  \"namedEntities\": true\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.fastpix.com/v1/on-demand/0cec3c88-c69d-4232-9b96-f0976327fa2d/named-entities', [
  'body' => '{
  "namedEntities": true
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
    'auth' => ['<username>', '<password>'],
]);

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

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://api.fastpix.com/v1/on-demand/0cec3c88-c69d-4232-9b96-f0976327fa2d/named-entities");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.PATCH);

request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"namedEntities\": true\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = [
  "Authorization": "Basic \(credentials)",
  "Content-Type": "application/json"
]
let parameters = ["namedEntities": true] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.fastpix.com/v1/on-demand/0cec3c88-c69d-4232-9b96-f0976327fa2d/named-entities")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
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()
```