Buscar em Knowledge Bases

Buscar em uma ou mais knowledge bases com recuperação vetorial semântica, recuperação híbrida de texto completo opcional e filtros estruturados por tag. Cada resultado nomeia o knowledgeBaseId de onde veio. Um corpo de requisição acima de 2 MiB é um 413.

POST/api/v2/knowledge/search

Authorization

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

Corpo da requisição

application/json

Knowledge bases, consulta, limite de resultados, modo de recuperação e filtros de tag opcionais.

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

application/json

application/json

curl -X POST "https://agent-studio.seeyu.ai/api/v2/knowledge/search" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "string",    "knowledgeBaseIds": [      "7c9e6679-7425-40de-944b-e07fc1f90ae7"    ]  }'
{
  "data": {
    "results": [
      {
        "knowledgeBaseId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "documentId": "b2d4f8a0-1c3e-4a5b-9d7c-2e6f0a8b4c12",
        "documentName": "getting-started.pdf",
        "sourceUrl": "string",
        "content": "To reset your password, open Settings and choose Security.",
        "chunkIndex": 3,
        "metadata": {
          "category": "billing",
          "priority": 2
        },
        "similarity": 0.8423,
        "rerankerScore": 0.9312
      }
    ],
    "query": "How do I reset my password?",
    "knowledgeBaseIds": [
      "7c9e6679-7425-40de-944b-e07fc1f90ae7"
    ],
    "topK": 10,
    "totalResults": 4,
    "rerankerStatus": "applied"
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "USAGE_LIMIT_EXCEEDED",
    "message": "Usage limit exceeded. Please upgrade your plan to continue."
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "message": "Upload has already been completed"
  }
}
{
  "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"
  }
}
POSTRestore Knowledge BasePOSTSync Knowledge Connector