Prévia da remoção de um material

POST

/v1/knowledge/materials/{materialId}/removal-preview

const url = 'https://developers.nexo.winningsales.com.br/v1/knowledge/materials/example/removal-preview';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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

curl --request POST \
  --url https://developers.nexo.winningsales.com.br/v1/knowledge/materials/example/removal-preview \
  --header 'Authorization: Bearer <token>'

O material, quantos itens da base dependem só dele e sairiam de uso, quantos continuam por outras fontes, sem remover nada. Devolve também uma confirmação, que o MCP exige para remover; pelo REST, o DELETE remove direto. Só administradores, como a Base de conhecimento na tela Calibração; o papel é relido a cada chamada, e para mudar o token precisa do escopo calibration:write.

Authorizations

bearer

Parameters

Path Parameters

materialId

required

Id do material

Responses

200

A prévia

application/json

object

material

required

O material que sairia da base

object

required

Id do material

string format: uuid

name

required

Nome do material na base

string

category

required

Tipo do material: policy (política), playbook, pricing (preços), product (produto), case, presentation (apresentação) ou other (outro)

string

Allowed values: policy playbook pricing product case presentation other

fileName

required

Nome do arquivo da versão atual, usado no download

string

format

required

Formato da versão atual

string

Allowed values: pdf docx pptx xlsx md txt

sizeInBytes

required

Tamanho da versão atual em bytes. Antes da confirmação, o tamanho informado no pedido

integer

version

required

Número da versão atual, começando em 1

integer

status

required

Awaiting_upload: o arquivo ainda não foi confirmado; stored: guardado; rejected: recusado na confirmação

string

Allowed values: awaiting_upload stored rejected

uploadedAt

required

Quando a versão atual foi guardada, ou pedida quando ainda não chegou

string format: date-time

uploadedBy

required

Quem subiu a versão atual. Null quando a pessoa não está mais na empresa

object

required

Id de quem subiu

string format: uuid

name

required

Nome de quem subiu

string

itemsLeavingUse

required

Itens da base que dependem só deste material e sairiam de uso com ele

integer

itemsKeptByOtherSources

required

Itens que este material também sustenta e que continuariam, pelas outras fontes

integer

effect

required

O que a remoção faz, em português, para mostrar à pessoa antes de confirmar

string

confirmation

required

A confirmação que a remoção pelo MCP exige

object

token

required

Passe este token na chamada que remove; ele só vale para esta remoção, desta pessoa

string

expiresAt

required

Até quando o token vale (10 minutos)

string format: date-time

Example

{
  "material": {
    "category": "policy",
    "format": "pdf",
    "status": "awaiting_upload"
  }
}

401

Token ausente, inválido, expirado ou revogado

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.invalid_credential",
  "title": "InvalidCredentialError",
  "status": 401,
  "detail": "Token de acesso inválido, expirado ou revogado. Crie um novo token de acesso no Nexo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb"
}

403

Papel, escopo do token ou plano não permitem a operação

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.insufficient_scope",
  "title": "InsufficientScopeError",
  "status": 403,
  "detail": "Este token não tem o escopo conversations:read, exigido por esta operação. Gere um token com esse escopo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "operation": "conversations.reading",
    "scope": "conversations:read"
  }
}

404

Material inexistente ou já removido

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "knowledge.material_not_found",
  "title": "MaterialNotFoundError",
  "status": 404,
  "detail": "Material não encontrado na base de conhecimento.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "materialId": "019fcae7-3e54-755a-8458-bdb605b324aa"
  }
}

429

Limite de chamadas da empresa ou do token atingido

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.rate_limited",
  "title": "PublicRateLimitedError",
  "status": 429,
  "detail": "Muitas chamadas em pouco tempo. Tente de novo em 12 segundos.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "class": "content",
    "limitedBy": "company",
    "limit": 120,
    "windowSeconds": 60,
    "retryAfterSeconds": 12
  }
}