Ativar ou Desativar Documentos em Massa

Ativar ou desativar muitos documentos em uma única requisição, por identificador ou, com selectAll, todos os documentos da knowledge base. Não há exclusão em massa; exclua os documentos um a um com DELETE /api/v2/knowledge/{id}/documents/{documentId}. Uma API key de workspace é rejeitada com 403; use uma API key pessoal.

PATCH/api/v2/knowledge/{knowledgeBaseId}/documents
X-API-Key<token>

Sua API key do Studio, pessoal ou com escopo de workspace. Gere uma em Settings e depois API Keys. As operações que rejeitam API keys de workspace dizem isso na própria descrição.

Em: header

Parâmetros de path

knowledgeBaseId*string

Identificador único da knowledge base.

Tamanho1 <= length

Corpo da requisição

application/json

Operação e os documentos a que ela se aplica.

Definições TypeScript

Use o tipo request body no TypeScript.

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://agent-studio.seeyu.ai/api/v2/knowledge/string/documents" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",    "operation": "disable",    "documentIds": [      "b2d4f8a0-1c3e-4a5b-9d7c-2e6f0a8b4c12"    ]  }'
{
  "data": {
    "operation": "enable",
    "updatedCount": 42,
    "documentIds": [
      "string"
    ]
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Request body must be sent as application/json"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}