{"openapi":"3.0.3","info":{"title":"Knowledge","version":"0.0.1"},"servers":[{"url":"https://api.bases.rdstationmentoria.com.br/rest"}],"paths":{"/bases":{"get":{"operationId":"knowledge-list","summary":"Listar bases de conhecimento","description":"Retorna uma lista das bases de conhecimento.","tags":["Knowledge"],"security":[{"Authorization":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"number","default":1},"description":"Número da página atual"},{"name":"size","in":"query","required":false,"schema":{"type":"number","default":20},"description":"Quantidade de itens por página"},{"name":"search","in":"query","required":false,"schema":{"type":"string"},"description":"Termo de busca aplicado ao conteúdo da base de conhecimento"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da base de conhecimento"},"description":{"type":"string","description":"Descrição geral da base de conhecimento"},"status":{"type":"string","enum":["succeeded","failed","in_progress","partial"],"description":"Status de processamento da base","default":"in_progress"},"records":{"type":"number","default":0,"description":"Número de registros indexados"},"workspaceId":{"type":"string","description":"Workspace ao qual o recurso pertence"},"createdBy":{"type":"string","description":"Usuário que criou o recurso","nullable":true},"updatedBy":{"type":"string","description":"Usuário que atualizou o recurso pela última vez","nullable":true},"createdAt":{"type":"string","format":"date-time","description":"Data de criação do recurso"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última atualização do recurso"}},"required":["id","description","workspaceId","createdBy","updatedBy","createdAt","updatedAt"],"additionalProperties":false},"description":"Lista de dados paginados"},"meta":{"type":"object","properties":{"total":{"type":"number","description":"Total de registros disponíveis"},"page":{"type":"number","description":"Página atual"},"size":{"type":"number","description":"Quantidade de itens por página"},"first":{"type":"number","description":"Número da primeira página"},"last":{"type":"number","description":"Número da última página"},"next":{"type":"number","nullable":true,"description":"Número da próxima página, se houver"},"previous":{"type":"number","nullable":true,"description":"Número da página anterior, se houver"}},"required":["total","page","size","first","last","next","previous"],"additionalProperties":false,"description":"Metadados da paginação"}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"knowledge-create","summary":"Criar base de conhecimento","description":"Cria uma nova base de conhecimento.","tags":["Knowledge"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"Descrição geral da base de conhecimento"},"sources":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["site","page","youtube","file","audio","faq"],"description":"Tipo da fonte de informação vinculada à base de conhecimento"},"file":{"type":"object","properties":{"url":{"type":"string","nullable":true,"default":null,"description":"URL do arquivo (se armazenado externamente)"},"data":{"type":"object","properties":{},"additionalProperties":true,"nullable":true,"default":null,"description":"Conteúdo do arquivo em forma de objeto"},"title":{"type":"string","nullable":true,"default":null,"description":"Título ou nome do arquivo"},"img":{"type":"string","nullable":true,"default":null,"description":"Representação de imagem (base64 ou URL)"},"description":{"type":"string","nullable":true,"default":null,"description":"Descrição adicional do arquivo"},"size":{"type":"number","nullable":true,"default":null,"description":"Tamanho do arquivo em bytes"},"key":{"type":"string","nullable":true,"default":null,"description":"Chave única de armazenamento do arquivo"},"ext":{"type":"string","nullable":true,"default":null,"description":"Extensão do arquivo"}},"additionalProperties":false,"description":"Arquivo ou conteúdo associado à fonte"}},"required":["type","file"],"additionalProperties":false,"description":"Fonte de informação vinculada a uma base de conhecimento"},"minItems":1}},"required":["description","sources"],"additionalProperties":false}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da base de conhecimento"},"description":{"type":"string","description":"Descrição geral da base de conhecimento"},"status":{"type":"string","enum":["succeeded","failed","in_progress","partial"],"description":"Status de processamento da base","default":"in_progress"},"records":{"type":"number","default":0,"description":"Número de registros indexados"},"workspaceId":{"type":"string","description":"Workspace ao qual o recurso pertence"},"createdBy":{"type":"string","description":"Usuário que criou o recurso","nullable":true},"updatedBy":{"type":"string","description":"Usuário que atualizou o recurso pela última vez","nullable":true},"createdAt":{"type":"string","format":"date-time","description":"Data de criação do recurso"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última atualização do recurso"}},"required":["id","description","workspaceId","createdBy","updatedBy","createdAt","updatedAt"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}}},"/bases/{id}":{"get":{"operationId":"knowledge-get","summary":"Obter base de conhecimento","description":"Retorna os dados completos de uma base de conhecimento.","tags":["Knowledge"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador único da base de conhecimento"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da base de conhecimento"},"status":{"type":"string","enum":["succeeded","failed","in_progress","partial"],"description":"Status de processamento da base","default":"in_progress"},"description":{"type":"string","description":"Descrição geral da base de conhecimento"},"sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da fonte"},"baseId":{"type":"string","description":"ID da base de conhecimento à qual esta fonte pertence"},"type":{"type":"string","enum":["site","page","youtube","file","audio","faq"],"description":"Tipo da fonte de informação vinculada à base de conhecimento"},"file":{"type":"object","properties":{"url":{"type":"string","nullable":true,"default":null,"description":"URL do arquivo (se armazenado externamente)"},"data":{"type":"object","properties":{},"additionalProperties":true,"nullable":true,"default":null,"description":"Conteúdo do arquivo em forma de objeto"},"title":{"type":"string","nullable":true,"default":null,"description":"Título ou nome do arquivo"},"img":{"type":"string","nullable":true,"default":null,"description":"Representação de imagem (base64 ou URL)"},"description":{"type":"string","nullable":true,"default":null,"description":"Descrição adicional do arquivo"},"size":{"type":"number","nullable":true,"default":null,"description":"Tamanho do arquivo em bytes"},"key":{"type":"string","nullable":true,"default":null,"description":"Chave única de armazenamento do arquivo"},"ext":{"type":"string","nullable":true,"default":null,"description":"Extensão do arquivo"}},"additionalProperties":false,"description":"Arquivo ou conteúdo associado à fonte"},"status":{"type":"string","enum":["in_progress","succeeded","failed"],"description":"Status da fonte"}},"required":["id","baseId","type","file","status"],"additionalProperties":false,"description":"Fonte de informação vinculada a uma base de conhecimento"},"description":"Lista de fontes associadas a esta base de conhecimento"}},"required":["id","description","sources"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}},"put":{"operationId":"knowledge-update","summary":"Atualizar base de conhecimento","description":"Atualiza o nome e outras configurações de uma base de conhecimento existente.","tags":["Knowledge"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"Descrição geral da base de conhecimento"},"sources":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["site","page","youtube","file","audio","faq"],"description":"Tipo da fonte de informação vinculada à base de conhecimento"},"file":{"type":"object","properties":{"url":{"type":"string","nullable":true,"default":null,"description":"URL do arquivo (se armazenado externamente)"},"data":{"type":"object","properties":{},"additionalProperties":true,"nullable":true,"default":null,"description":"Conteúdo do arquivo em forma de objeto"},"title":{"type":"string","nullable":true,"default":null,"description":"Título ou nome do arquivo"},"img":{"type":"string","nullable":true,"default":null,"description":"Representação de imagem (base64 ou URL)"},"description":{"type":"string","nullable":true,"default":null,"description":"Descrição adicional do arquivo"},"size":{"type":"number","nullable":true,"default":null,"description":"Tamanho do arquivo em bytes"},"key":{"type":"string","nullable":true,"default":null,"description":"Chave única de armazenamento do arquivo"},"ext":{"type":"string","nullable":true,"default":null,"description":"Extensão do arquivo"}},"additionalProperties":false,"description":"Arquivo ou conteúdo associado à fonte"}},"required":["type","file"],"additionalProperties":false,"description":"Fonte de informação vinculada a uma base de conhecimento"},"minItems":1,"description":"Lista de fontes que devem ser atualizadas ou adicionadas à base de conhecimento"}},"required":["description","sources"],"additionalProperties":false}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador único da base de conhecimento"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da base de conhecimento"},"description":{"type":"string","description":"Descrição geral da base de conhecimento"},"status":{"type":"string","enum":["succeeded","failed","in_progress","partial"],"description":"Status de processamento da base","default":"in_progress"},"records":{"type":"number","default":0,"description":"Número de registros indexados"},"workspaceId":{"type":"string","description":"Workspace ao qual o recurso pertence"},"createdBy":{"type":"string","description":"Usuário que criou o recurso","nullable":true},"updatedBy":{"type":"string","description":"Usuário que atualizou o recurso pela última vez","nullable":true},"createdAt":{"type":"string","format":"date-time","description":"Data de criação do recurso"},"updatedAt":{"type":"string","format":"date-time","description":"Data da última atualização do recurso"}},"required":["id","description","workspaceId","createdBy","updatedBy","createdAt","updatedAt"],"additionalProperties":false}}}},"default":{"$ref":"#/components/responses/error"}}},"delete":{"operationId":"knowledge-remove","summary":"Remover base de conhecimento","description":"Remove uma base de conhecimento do workspace atual.","tags":["Knowledge"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador único da base de conhecimento"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"default":{"$ref":"#/components/responses/error"}}}}},"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer"}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false}}}}}}}