Editar conhecimento

PATCH /chatbot/knowledge

Altera só os campos enviados. Mudar o texto (content ou source_url) ou religar o conhecimento refaz o preparo para a busca (vector_status: processing). Mudar só o título ou a prioridade de um conhecimento pronto (completed) não refaz.

Durante o preparo, a edição volta 409 knowledge_processing; tente de novo em instantes.

Autenticação

[
  {
    "token": []
  }
]

{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}

Corpo da requisição

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AIKnowledgeInput"
      },
      "example": {
        "knowledge_id": "rkn1a2b3c4d5e6f",
        "active": false
      }
    }
  }
}

Respostas

{
  "200": {
    "description": "Conhecimento atualizado",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AIKnowledge"
        },
        "example": {
          "id": "rk1b2c3d4e5f6a7",
          "title": "Horário de atendimento",
          "content": "Atendemos de segunda a sexta, das 9h às 18h.",
          "active": true,
          "priority": 1,
          "vector_status": "completed",
          "vectorized_at": "2026-10-17T12:00:00.000Z",
          "created_at": "2026-10-17T12:00:00.000Z",
          "updated_at": "2026-10-17T12:00:00.000Z"
        }
      }
    }
  },
  "400": {
    "description": "`invalid_request`: JSON malformado ou campo desconhecido; ou valor fora do permitido.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "invalid_request",
          "message": "JSON malformado ou campo desconhecido."
        }
      }
    }
  },
  "401": {
    "description": "Token ausente ou inválido.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unauthorized",
          "message": "Token inválido."
        }
      }
    }
  },
  "404": {
    "description": "Nenhum recurso com esse `id` nesta inbox.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "not_found",
          "message": "Nenhum recurso com esse `id` nesta inbox."
        }
      }
    }
  },
  "409": {
    "description": "`inbox_not_paired`: conecte a inbox ao WhatsApp antes. `knowledge_processing`: o preparo ainda está em andamento; tente de novo em instantes. `openai_api_key_required`: o conhecimento ficaria ativo sem a `openai_api_key` da inbox.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "inbox_not_paired",
          "message": "A inbox ainda não foi conectada ao WhatsApp. Os dados pertencem ao número conectado; conecte a inbox antes (`inbox_not_paired`)."
        }
      }
    }
  },
  "429": {
    "$ref": "#/components/responses/RateLimited"
  },
  "500": {
    "description": "Falha inesperada ao gravar ou ler os dados.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "internal_error",
          "message": "Erro interno; tente de novo."
        }
      }
    }
  }
}

Estado: Disponível

Compatibilidade de canais

CanalCompatívelObservação
WhatsApp (Web)Sim
WhatsApp (API oficial)Sim
InstagramSim
MessengerSim
TelegramSim

Eventos que esta rota gera

Nenhum. Esta rota não gera evento no webhook (nem em GET /events): o resultado vem só na resposta.

Antes e depois (uazapi → Orkesio)

Na uazapi: PATCH /chatbot/knowledge/{id}.

  • Mesmas funções; o id vai no corpo, em knowledge_id (antes {id} no caminho); muda o formato: campos em snake_case, datas em ISO 8601 (_at) e erros em {error, message}.
  • Campos renomeados: createdAt → created_at, fileType → file_type, sourceUrl → source_url, updatedAt → updated_at, vectorStatus → vector_status, vectorizedAt → vectorized_at.

#/components/schemas/AIKnowledgeInput

{
  "type": "object",
  "description": "Na criação, envie `title` e `content` ou `source_url`. Na edição, só os campos enviados mudam; mudar o texto refaz o preparo para a busca.",
  "additionalProperties": false,
  "properties": {
    "knowledge_id": {
      "type": "string",
      "description": "ID do conhecimento."
    },
    "title": {
      "type": "string",
      "description": "Título do conhecimento; vai como cabeçalho do texto quando o agente o lê."
    },
    "content": {
      "type": "string",
      "description": "Texto do conhecimento. Não use junto com `source_url`."
    },
    "source_url": {
      "type": "string",
      "format": "uri",
      "description": "Endereço público (http/https) de um PDF, CSV, página ou texto; o conteúdo é baixado (até 20 MB) e vira o `content`. Endereços internos ou privados são recusados."
    },
    "file_type": {
      "type": "string",
      "enum": [
        "pdf",
        "csv"
      ],
      "description": "Tipo do arquivo em `source_url`. Omitido, vale pela extensão da URL; sem extensão conhecida, é lido como texto ou HTML."
    },
    "active": {
      "type": "boolean",
      "description": "Padrão `true`."
    },
    "priority": {
      "type": "integer",
      "description": "Ordem em que o conhecimento chega ao agente e aparece na listagem (maior primeiro). Padrão `0`."
    }
  },
  "required": [
    "knowledge_id"
  ]
}

#/components/schemas/AIKnowledge

{
  "type": "object",
  "description": "Texto que os agentes consultam para responder (horários, preços, políticas). Base pequena vai inteira para o agente, em ordem de `priority`; base grande é consultada por busca, que pega os trechos mais parecidos com as últimas mensagens do contato.",
  "required": [
    "id",
    "title",
    "active",
    "priority",
    "vector_status",
    "vectorized_at",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "ID do conhecimento, usado em `/chatbot/knowledge/{knowledge_id}`."
    },
    "title": {
      "type": "string",
      "description": "Título do conhecimento; vai como cabeçalho do texto quando o agente o lê."
    },
    "content": {
      "type": "string",
      "description": "Texto do conhecimento; só no `GET /chatbot/knowledge/{knowledge_id}` (a lista não traz). Quando criado por `source_url`, é o texto extraído do arquivo."
    },
    "active": {
      "type": "boolean",
      "description": "Só conhecimento ativo entra nas respostas."
    },
    "priority": {
      "type": "integer",
      "description": "Ordem em que o conhecimento chega ao agente e aparece na listagem (maior primeiro)."
    },
    "vector_status": {
      "type": "string",
      "enum": [
        "processing",
        "completed",
        "failed",
        "inactive"
      ],
      "description": "Preparo para a busca. `processing`: em andamento, segundos a poucos minutos; `completed`: pronto; `failed`: falhou e é tentado de novo sozinho; `inactive`: conhecimento desativado."
    },
    "vectorized_at": {
      "description": "Último preparo. ISO 8601 em UTC com milissegundos.",
      "type": "string",
      "format": "date-time"
    },
    "created_at": {
      "description": "Criação. ISO 8601 em UTC com milissegundos.",
      "readOnly": true,
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "description": "Última alteração. ISO 8601 em UTC com milissegundos.",
      "readOnly": true,
      "type": "string",
      "format": "date-time"
    }
  }
}

#/components/schemas/OrkesioError

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
    },
    "message": {
      "type": "string",
      "description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
    },
    "field": {
      "type": "string",
      "description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
    }
  },
  "required": [
    "error",
    "message"
  ],
  "additionalProperties": true,
  "description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}

#/components/responses/RateLimited

{
  "description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
  "headers": {
    "Retry-After": {
      "description": "Segundos até poder chamar de novo.",
      "schema": {
        "type": "integer",
        "minimum": 1
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "rate_limited",
        "message": "Muitas requisições."
      }
    }
  }
}

Guias relacionados

Visão geral · O que funciona em cada canal · O que muda da uazapi