> ## Documentation Index > Fetch the complete documentation index at: https://docs.weve.cx/llms.txt > Use this file to discover all available pages before exploring further. # Testar a busca no material > O que o agente encontraria para uma pergunta, sem chamar o modelo. ## OpenAPI ````yaml POST /v1/clubs/{clubId}/agents/{agentId}/knowledge/search openapi: 3.0.3 info: title: weve API description: > Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de verdade**: os tipos e a interface de servidor em Go, e o client TypeScript, são todos gerados daqui (`make openapi`). Handler que divergir da interface não compila. A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de máquina, protegido por segredo dedicado, e não é contrato de cliente. version: 0.2.0 servers: - url: https://api.weve.cx description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: outgoing-webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: community - name: mentorships - name: agents - name: lives - name: students - name: auth - name: campaigns - name: workflows - name: email paths: /v1/clubs/{clubId}/agents/{agentId}/knowledge/search: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/AgentId' post: tags: - agents summary: O que o agente encontraria para uma pergunta description: | A mesma recuperação que acompanha a pergunta do aluno, sem chamar o modelo: é a ferramenta para entender por que o agente respondeu o que respondeu. `mode: all` diz que o material inteiro vai junto; `lexical: true`, que a busca foi só por palavra. Os trechos vêm na ordem de LEITURA (a do material no agente, e a de cada documento) — a mesma em que acompanham a pergunta. A relevância de cada um está em `score`. operationId: searchAgentKnowledge requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/KnowledgeSearch' responses: '200': description: Os trechos content: application/json: schema: $ref: '#/components/schemas/KnowledgeSearchResult' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/UnprocessableEntity' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' security: - userSession: [] components: parameters: OrgId: name: clubId in: path required: true description: > Id público da organização — o mesmo que `GET /v1/me` devolve em `organization_id`. Na URL o recurso se chama **club**; no contrato e no domínio, organization. A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o que as pessoas leem. É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer. O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso. schema: type: string format: uuid AgentId: name: agentId in: path required: true description: O id do agente — o mesmo do entregável. schema: type: string format: uuid schemas: KnowledgeSearch: type: object required: - query additionalProperties: false properties: query: type: string minLength: 1 maxLength: 2000 KnowledgeSearchResult: type: object required: - mode - lexical - data properties: mode: type: string enum: - all - search x-enum-varnames: - KnowledgeModeAll - KnowledgeModeSearch lexical: type: boolean description: A busca foi só por palavra (sem o provedor de vetores). data: type: array items: $ref: '#/components/schemas/KnowledgePassage' KnowledgePassage: type: object required: - media_id - media_title - content - score properties: media_id: type: string format: uuid media_title: type: string page_from: type: integer page_to: type: integer content: type: string score: type: number format: double description: A nota da busca. Zero quando o material vai inteiro. ErrorEnvelope: type: object description: >- Envelope único de erro da API. O `code` é o contrato com o cliente — a `message` é diagnóstico, e pode mudar. required: - error properties: error: type: object required: - code properties: code: type: string message: type: string responses: BadRequest: description: Requisição malformada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: > A sessão é válida, mas não age nesta organização. É a mesma resposta para uma organização que não existe — distinguir as duas deixaria enumerar organizações alheias. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' NotFound: description: Recurso não encontrado content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' UnprocessableEntity: description: Campos obrigatórios ausentes ou inválidos content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' TooManyRequests: description: Teto por IP atingido headers: Retry-After: schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: >- Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no rastreamento. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: userSession: type: http scheme: bearer description: | Token OPACO de sessão de quem administra, emitido por `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo desenho do `studentSession`, para a outra identidade. É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o `studentSession`; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe. O dashboard o guarda em cookie httpOnly, que o BFF troca pelo `Authorization` a cada chamada. ```` ## Related topics - [Baixa um material carimbado](/api-reference/classroom/lesson-file.md) - [Webhooks de saída](/essentials/webhooks.md) - [Biblioteca de mídia](/essentials/media.md) - [Agentes](/essentials/agents.md) - [Lives](/essentials/lives.md)