Change workspace settings

curl --request PATCH \
  --url https://www.getsurfaced.ai/api/v1/workspace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-Id: <x-workspace-id>' \
  --data '
{
  "reviewerUiLanguage": "<string>",
  "quality": {
    "weights": {
      "fact": 0.5,
      "seo": 0.5,
      "geo": 0.5,
      "copy": 0.5,
      "humanizer": 0.5
    },
    "thresholds": {
      "shipFloor": 50,
      "escalateFloor": 50
    },
    "minHealthyCheckers": 2
  },
  "brand": {
    "name": "<string>",
    "website": "<string>",
    "industry": "<string>",
    "topicKeywords": [
      "<string>"
    ],
    "defaultCountry": "<string>",
    "defaultLanguage": "<string>",
    "ownedDomains": [
      {
        "domain": "<string>",
        "country": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://www.getsurfaced.ai/api/v1/workspace"

payload = {
    "reviewerUiLanguage": "<string>",
    "quality": {
        "weights": {
            "fact": 0.5,
            "seo": 0.5,
            "geo": 0.5,
            "copy": 0.5,
            "humanizer": 0.5
        },
        "thresholds": {
            "shipFloor": 50,
            "escalateFloor": 50
        },
        "minHealthyCheckers": 2
    },
    "brand": {
        "name": "<string>",
        "website": "<string>",
        "industry": "<string>",
        "topicKeywords": ["<string>"],
        "defaultCountry": "<string>",
        "defaultLanguage": "<string>",
        "ownedDomains": [
            {
                "domain": "<string>",
                "country": "<string>"
            }
        ]
    }
}
headers = {
    "X-Workspace-Id": "<x-workspace-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-Workspace-Id': '<x-workspace-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    reviewerUiLanguage: '<string>',
    quality: {
      weights: {fact: 0.5, seo: 0.5, geo: 0.5, copy: 0.5, humanizer: 0.5},
      thresholds: {shipFloor: 50, escalateFloor: 50},
      minHealthyCheckers: 2
    },
    brand: {
      name: '<string>',
      website: '<string>',
      industry: '<string>',
      topicKeywords: ['<string>'],
      defaultCountry: '<string>',
      defaultLanguage: '<string>',
      ownedDomains: [{domain: '<string>', country: '<string>'}]
    }
  })
};

fetch('https://www.getsurfaced.ai/api/v1/workspace', 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://www.getsurfaced.ai/api/v1/workspace",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'reviewerUiLanguage' => '<string>',
    'quality' => [
        'weights' => [
                'fact' => 0.5,
                'seo' => 0.5,
                'geo' => 0.5,
                'copy' => 0.5,
                'humanizer' => 0.5
        ],
        'thresholds' => [
                'shipFloor' => 50,
                'escalateFloor' => 50
        ],
        'minHealthyCheckers' => 2
    ],
    'brand' => [
        'name' => '<string>',
        'website' => '<string>',
        'industry' => '<string>',
        'topicKeywords' => [
                '<string>'
        ],
        'defaultCountry' => '<string>',
        'defaultLanguage' => '<string>',
        'ownedDomains' => [
                [
                                'domain' => '<string>',
                                'country' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Workspace-Id: <x-workspace-id>"
  ],
]);

$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://www.getsurfaced.ai/api/v1/workspace"

	payload := strings.NewReader("{\n  \"reviewerUiLanguage\": \"<string>\",\n  \"quality\": {\n    \"weights\": {\n      \"fact\": 0.5,\n      \"seo\": 0.5,\n      \"geo\": 0.5,\n      \"copy\": 0.5,\n      \"humanizer\": 0.5\n    },\n    \"thresholds\": {\n      \"shipFloor\": 50,\n      \"escalateFloor\": 50\n    },\n    \"minHealthyCheckers\": 2\n  },\n  \"brand\": {\n    \"name\": \"<string>\",\n    \"website\": \"<string>\",\n    \"industry\": \"<string>\",\n    \"topicKeywords\": [\n      \"<string>\"\n    ],\n    \"defaultCountry\": \"<string>\",\n    \"defaultLanguage\": \"<string>\",\n    \"ownedDomains\": [\n      {\n        \"domain\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    ]\n  }\n}")

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

	req.Header.Add("X-Workspace-Id", "<x-workspace-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://www.getsurfaced.ai/api/v1/workspace")
  .header("X-Workspace-Id", "<x-workspace-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reviewerUiLanguage\": \"<string>\",\n  \"quality\": {\n    \"weights\": {\n      \"fact\": 0.5,\n      \"seo\": 0.5,\n      \"geo\": 0.5,\n      \"copy\": 0.5,\n      \"humanizer\": 0.5\n    },\n    \"thresholds\": {\n      \"shipFloor\": 50,\n      \"escalateFloor\": 50\n    },\n    \"minHealthyCheckers\": 2\n  },\n  \"brand\": {\n    \"name\": \"<string>\",\n    \"website\": \"<string>\",\n    \"industry\": \"<string>\",\n    \"topicKeywords\": [\n      \"<string>\"\n    ],\n    \"defaultCountry\": \"<string>\",\n    \"defaultLanguage\": \"<string>\",\n    \"ownedDomains\": [\n      {\n        \"domain\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.getsurfaced.ai/api/v1/workspace")

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

request = Net::HTTP::Patch.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reviewerUiLanguage\": \"<string>\",\n  \"quality\": {\n    \"weights\": {\n      \"fact\": 0.5,\n      \"seo\": 0.5,\n      \"geo\": 0.5,\n      \"copy\": 0.5,\n      \"humanizer\": 0.5\n    },\n    \"thresholds\": {\n      \"shipFloor\": 50,\n      \"escalateFloor\": 50\n    },\n    \"minHealthyCheckers\": 2\n  },\n  \"brand\": {\n    \"name\": \"<string>\",\n    \"website\": \"<string>\",\n    \"industry\": \"<string>\",\n    \"topicKeywords\": [\n      \"<string>\"\n    ],\n    \"defaultCountry\": \"<string>\",\n    \"defaultLanguage\": \"<string>\",\n    \"ownedDomains\": [\n      {\n        \"domain\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    ]\n  }\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "<string>",
    "reviewPolicy": "gate",
    "contentPurpose": "human",
    "reviewerUiLanguage": "<string>",
    "quality": {
      "weights": {
        "fact": 0.5,
        "seo": 0.5,
        "geo": 0.5,
        "copy": 0.5,
        "humanizer": 0.5
      },
      "thresholds": {
        "shipFloor": 50,
        "escalateFloor": 50
      },
      "minHealthyCheckers": 2
    },
    "brand": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "website": "<string>",
      "domain": "<string>",
      "color": "<string>",
      "logoUrl": "<string>",
      "industry": "<string>",
      "topicKeywords": [
        "<string>"
      ],
      "defaultCountry": "<string>",
      "defaultLanguage": "<string>",
      "ownedDomains": [
        {
          "domain": "<string>",
          "country": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

Workspace

Change workspace settings

Partial update of the workspace’s own settings: reviewPolicy (gate, hybrid, auto), contentPurpose (human, seo, geo), reviewerUiLanguage (BCP-47, e.g. en-US) and quality (score weights and ship/escalate thresholds), which need manage_settings; and brand, the brand the workspace tracks (name, website, industry, topicKeywords, defaultCountry, defaultLanguage, ownedDomains), which needs admin_section. A workspace tracks one brand: a brand with a name sets it up when there is none yet (this call can create it, with website and ownedDomains too), and changes it otherwise; for a second brand, use a second workspace. brand.ownedDomains is the full set of other domains the brand owns, each { domain, country } (country is an ISO 3166-1 alpha-2 code or null); it needs manage_settings on top, so an editor’s call that includes it is refused entirely and the other brand fields go in a separate call. Changing it replaces the whole set and merges competitor entities already tracked on those domains into the brand (irreversible); adding or removing a domain also starts a background recompute of past results and registers each added domain as a brand knowledge source and site-audit target, crawled in the background (its pages count toward the knowledge page quota). The call starts no AI spend. Owned domains need a plan that includes them; otherwise the call fails with 403 OWNED_DOMAINS_LIMIT_REACHED and details { current, limit, planName }. Send at least one field and nothing else; omitted fields keep their value. Brand voice, markets, audiences, SEO rules and tracking models live under /settings/*.

PATCH

workspace

curl --request PATCH \
  --url https://www.getsurfaced.ai/api/v1/workspace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-Id: <x-workspace-id>' \
  --data '
{
  "reviewerUiLanguage": "<string>",
  "quality": {
    "weights": {
      "fact": 0.5,
      "seo": 0.5,
      "geo": 0.5,
      "copy": 0.5,
      "humanizer": 0.5
    },
    "thresholds": {
      "shipFloor": 50,
      "escalateFloor": 50
    },
    "minHealthyCheckers": 2
  },
  "brand": {
    "name": "<string>",
    "website": "<string>",
    "industry": "<string>",
    "topicKeywords": [
      "<string>"
    ],
    "defaultCountry": "<string>",
    "defaultLanguage": "<string>",
    "ownedDomains": [
      {
        "domain": "<string>",
        "country": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://www.getsurfaced.ai/api/v1/workspace"

payload = {
    "reviewerUiLanguage": "<string>",
    "quality": {
        "weights": {
            "fact": 0.5,
            "seo": 0.5,
            "geo": 0.5,
            "copy": 0.5,
            "humanizer": 0.5
        },
        "thresholds": {
            "shipFloor": 50,
            "escalateFloor": 50
        },
        "minHealthyCheckers": 2
    },
    "brand": {
        "name": "<string>",
        "website": "<string>",
        "industry": "<string>",
        "topicKeywords": ["<string>"],
        "defaultCountry": "<string>",
        "defaultLanguage": "<string>",
        "ownedDomains": [
            {
                "domain": "<string>",
                "country": "<string>"
            }
        ]
    }
}
headers = {
    "X-Workspace-Id": "<x-workspace-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-Workspace-Id': '<x-workspace-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    reviewerUiLanguage: '<string>',
    quality: {
      weights: {fact: 0.5, seo: 0.5, geo: 0.5, copy: 0.5, humanizer: 0.5},
      thresholds: {shipFloor: 50, escalateFloor: 50},
      minHealthyCheckers: 2
    },
    brand: {
      name: '<string>',
      website: '<string>',
      industry: '<string>',
      topicKeywords: ['<string>'],
      defaultCountry: '<string>',
      defaultLanguage: '<string>',
      ownedDomains: [{domain: '<string>', country: '<string>'}]
    }
  })
};

fetch('https://www.getsurfaced.ai/api/v1/workspace', 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://www.getsurfaced.ai/api/v1/workspace",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'reviewerUiLanguage' => '<string>',
    'quality' => [
        'weights' => [
                'fact' => 0.5,
                'seo' => 0.5,
                'geo' => 0.5,
                'copy' => 0.5,
                'humanizer' => 0.5
        ],
        'thresholds' => [
                'shipFloor' => 50,
                'escalateFloor' => 50
        ],
        'minHealthyCheckers' => 2
    ],
    'brand' => [
        'name' => '<string>',
        'website' => '<string>',
        'industry' => '<string>',
        'topicKeywords' => [
                '<string>'
        ],
        'defaultCountry' => '<string>',
        'defaultLanguage' => '<string>',
        'ownedDomains' => [
                [
                                'domain' => '<string>',
                                'country' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Workspace-Id: <x-workspace-id>"
  ],
]);

$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://www.getsurfaced.ai/api/v1/workspace"

	payload := strings.NewReader("{\n  \"reviewerUiLanguage\": \"<string>\",\n  \"quality\": {\n    \"weights\": {\n      \"fact\": 0.5,\n      \"seo\": 0.5,\n      \"geo\": 0.5,\n      \"copy\": 0.5,\n      \"humanizer\": 0.5\n    },\n    \"thresholds\": {\n      \"shipFloor\": 50,\n      \"escalateFloor\": 50\n    },\n    \"minHealthyCheckers\": 2\n  },\n  \"brand\": {\n    \"name\": \"<string>\",\n    \"website\": \"<string>\",\n    \"industry\": \"<string>\",\n    \"topicKeywords\": [\n      \"<string>\"\n    ],\n    \"defaultCountry\": \"<string>\",\n    \"defaultLanguage\": \"<string>\",\n    \"ownedDomains\": [\n      {\n        \"domain\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    ]\n  }\n}")

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

	req.Header.Add("X-Workspace-Id", "<x-workspace-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://www.getsurfaced.ai/api/v1/workspace")
  .header("X-Workspace-Id", "<x-workspace-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reviewerUiLanguage\": \"<string>\",\n  \"quality\": {\n    \"weights\": {\n      \"fact\": 0.5,\n      \"seo\": 0.5,\n      \"geo\": 0.5,\n      \"copy\": 0.5,\n      \"humanizer\": 0.5\n    },\n    \"thresholds\": {\n      \"shipFloor\": 50,\n      \"escalateFloor\": 50\n    },\n    \"minHealthyCheckers\": 2\n  },\n  \"brand\": {\n    \"name\": \"<string>\",\n    \"website\": \"<string>\",\n    \"industry\": \"<string>\",\n    \"topicKeywords\": [\n      \"<string>\"\n    ],\n    \"defaultCountry\": \"<string>\",\n    \"defaultLanguage\": \"<string>\",\n    \"ownedDomains\": [\n      {\n        \"domain\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.getsurfaced.ai/api/v1/workspace")

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

request = Net::HTTP::Patch.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reviewerUiLanguage\": \"<string>\",\n  \"quality\": {\n    \"weights\": {\n      \"fact\": 0.5,\n      \"seo\": 0.5,\n      \"geo\": 0.5,\n      \"copy\": 0.5,\n      \"humanizer\": 0.5\n    },\n    \"thresholds\": {\n      \"shipFloor\": 50,\n      \"escalateFloor\": 50\n    },\n    \"minHealthyCheckers\": 2\n  },\n  \"brand\": {\n    \"name\": \"<string>\",\n    \"website\": \"<string>\",\n    \"industry\": \"<string>\",\n    \"topicKeywords\": [\n      \"<string>\"\n    ],\n    \"defaultCountry\": \"<string>\",\n    \"defaultLanguage\": \"<string>\",\n    \"ownedDomains\": [\n      {\n        \"domain\": \"<string>\",\n        \"country\": \"<string>\"\n      }\n    ]\n  }\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "<string>",
    "reviewPolicy": "gate",
    "contentPurpose": "human",
    "reviewerUiLanguage": "<string>",
    "quality": {
      "weights": {
        "fact": 0.5,
        "seo": 0.5,
        "geo": 0.5,
        "copy": 0.5,
        "humanizer": 0.5
      },
      "thresholds": {
        "shipFloor": 50,
        "escalateFloor": 50
      },
      "minHealthyCheckers": 2
    },
    "brand": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "website": "<string>",
      "domain": "<string>",
      "color": "<string>",
      "logoUrl": "<string>",
      "industry": "<string>",
      "topicKeywords": [
        "<string>"
      ],
      "defaultCountry": "<string>",
      "defaultLanguage": "<string>",
      "ownedDomains": [
        {
          "domain": "<string>",
          "country": "<string>"
        }
      ]
    }
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

API key (sk_live_...) created at https://www.getsurfaced.ai/app/settings/account/api-keys

Headers

X-Workspace-Id

string<uuid>

required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Body

application/json

reviewPolicy

enum<string>

Available options:

gate,

hybrid,

auto

contentPurpose

enum<string>

Available options:

human,

seo,

geo

reviewerUiLanguage

string

Pattern: ^[a-z]{2,3}(-[A-Z]{2})?$

quality

object

Show child attributes

brand

object

Show child attributes

Response

The workspace after the change

data

object

required

Show child attributes

Public API

Partner API

Change workspace settings

Authorizations

Headers

Body

Response