Skip to main content
PUT
/
projects
/
{project_id}
/
content_extraction_settings
Update extraction settings
curl --request PUT \
  --url https://api.beyondwords.io/v1/projects/{project_id}/content_extraction_settings \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "mode": "manual",
  "javascript_enabled": false,
  "static_ip_enabled": true,
  "request_headers": {
    "X-Custom-Header": "my-custom-value"
  }
}
'
import requests

url = "https://api.beyondwords.io/v1/projects/{project_id}/content_extraction_settings"

payload = {
"mode": "manual",
"javascript_enabled": False,
"static_ip_enabled": True,
"request_headers": { "X-Custom-Header": "my-custom-value" }
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mode: 'manual',
javascript_enabled: false,
static_ip_enabled: true,
request_headers: {'X-Custom-Header': 'my-custom-value'}
})
};

fetch('https://api.beyondwords.io/v1/projects/{project_id}/content_extraction_settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.beyondwords.io/v1/projects/{project_id}/content_extraction_settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'mode' => 'manual',
'javascript_enabled' => false,
'static_ip_enabled' => true,
'request_headers' => [
'X-Custom-Header' => 'my-custom-value'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api.beyondwords.io/v1/projects/{project_id}/content_extraction_settings"

payload := strings.NewReader("{\n \"mode\": \"manual\",\n \"javascript_enabled\": false,\n \"static_ip_enabled\": true,\n \"request_headers\": {\n \"X-Custom-Header\": \"my-custom-value\"\n }\n}")

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

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

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.beyondwords.io/v1/projects/{project_id}/content_extraction_settings")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"manual\",\n \"javascript_enabled\": false,\n \"static_ip_enabled\": true,\n \"request_headers\": {\n \"X-Custom-Header\": \"my-custom-value\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/projects/{project_id}/content_extraction_settings")

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

request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mode\": \"manual\",\n \"javascript_enabled\": false,\n \"static_ip_enabled\": true,\n \"request_headers\": {\n \"X-Custom-Header\": \"my-custom-value\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "mode": "automatic",
  "javascript_enabled": true,
  "static_ip_enabled": false,
  "request_headers": {
    "X-Paywall-Token": "my-secret-token"
  }
}
{
"code": 401,
"message": "Unauthorized"
}

Authorizations

X-Api-Key
string
header
required

Path Parameters

project_id
string
required

The numeric ID of your project

Body

application/json
mode
enum<string>

The mode to use for content extraction

Available options:
automatic,
manual,
legacy
javascript_enabled
boolean

Whether to evaluate JavaScript when extracting content. Useful for single-page applications.

static_ip_enabled
boolean

Whether requests should originate from a static IP address when extracting content.

request_headers
object

Headers that you want to include in the HTTP request when fetching and extracting the content.

Response

successful

mode
enum<string>

The mode to use for content extraction

Available options:
automatic,
manual,
legacy
javascript_enabled
boolean

Whether to evaluate JavaScript when extracting content. Useful for single-page applications.

static_ip_enabled
boolean

Whether requests should originate from a static IP address when extracting content.

request_headers
object

Headers that you want to include in the HTTP request when fetching and extracting the content.