Saltar para a documentação
API

Adicionar uma nota

Uma nota de até 20.000 caracteres num nível, normalmente pronta em um ou dois segundos.

POST/knowledge/notes

Executa a chamada real no seu espaço de trabalho.

POST /knowledge/notes

Uma nota de até 20.000 caracteres num nível, normalmente pronta em um ou dois segundos.

Exemplo

Requer knowledge:write. title tem até 200 caracteres e body até 20.000, em Markdown se quiser. Omita scope para todo o espaço de trabalho. pinned põe a nota em cada prompt do seu nível, até 2.000 caracteres de notas afixadas por nível. Responde 201 com a nota.

curl
curl -X POST "$OE/knowledge/notes" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "scope": "@acme.com", "title": "Refunds", "body": "Refunds are paid within 14 days of the return reaching our warehouse.", "pinned": true }'
Resposta
{  "object": "knowledge_item",  "id": "kb_8c1f4a2b9d7e3f60a5c7b21d",  "kind": "note",  "scope": "@acme.com",  "level": "domain",  "title": "Refunds",  "url": null,  "fileName": null,  "mimeType": null,  "sizeBytes": null,  "pinned": true,  "status": "ready",  "failure": null,  "chunks": 1,  "chars": 71,  "origin": "api",  "createdBy": "usr_5f2a9c71",  "createdAt": "2026-10-08T09:12:44.000Z",  "updatedAt": "2026-10-08T09:12:44.000Z",  "indexedAt": "2026-10-08T09:12:45.000Z"}

Alterar um item requer alcançar cada endereço que o seu nível abrange: todo o espaço de trabalho requer todos os endereços, um domínio o domínio inteiro, e um endereço esse endereço. Uma chave ou uma aplicação limitada a certos endereços só pode alterar itens nesses endereços, ou em domínios que tenha inteiros.

Um nível que não é o espaço de trabalho, um dos seus domínios nem um dos seus endereços é um 422 invalid_knowledge_scope, e um fora do alcance da chave um 403 knowledge_scope_not_reached. Enviar o mesmo pedido duas vezes adiciona duas notas.

Referência