Coleções

Uma coleção é uma biblioteca de conhecimento: ela abriga vários documentos de conhecimento.

• Use coleções para agrupar documentos por finalidade, como documentar um produto, uma empresa, um serviço ou fluxo.
• Coleções não produzem custo. Não há limite de coleções por conta.

Criar uma coleção

Para criar uma coleção vazia, informe apenas o nome dela:

Requisição

POST /api/v1/collections

{
    // O nome da coleção não pode ser vazio.
    "collectionName": "Minha primeira coleção"
}

Resposta

{
    "message": null,
    "data": {
        // ID único da coleção criada.
        "collectionId": "01965b62-17c4-7258-9aa8-af5139799527"
    }
}

Listar coleções

Lista as coleções disponíveis na sua conta.

Requisição

GET /api/v1/collections

Resposta

{
    "message": null,
    "data": {
        "pageInfo": {
            "currentPage": 1,
            "hasMoreItems": true
        },
        "items": [
            {
                "id": "01965b62-17c4-7258-9aa8-af5139799527",
                "createdAt": "2025-04-22T02:44:37",
                "name": "Minha coleção"
            },
            {
                "id": "01965b54-7fbd-70cd-982b-604de002ac0a",
                "createdAt": "2025-04-22T02:29:46",
                "name": "Outra coleção"
            }
        ]
    }
}

Ver uma coleção

Obtém detalhes de uma coleção, como seu progresso de indexação e informações como data de criação.

Requisição

GET /api/v1/collections/{collection-id}/

Resposta

{
    "message": null,
    "data": {
        "name": "Minha coleção",
        "createdAt": "2025-04-22T02:29:46",
        "state": {
            
            // traz a quantidade de documentos aguardando indexação
            "queuedDocuments": 0,
            
            // quantidade de documentos pronto para consulta
            "indexedDocuments": 227
        },
        "tags": [
            "tag1",
            "tag2",
            "tag3",
            ...
        ]
    }
}

Excluir uma coleção

Exclui uma coleção e todos os documentos nela. Essa ação é irreversível.

Requisição

DELETE /api/v1/collections/{collection-id}/

Resposta

{
    "message": "Collection deleted successfully.",
    "data": null
}

Limpar uma coleção

Diferente da exclusão de coleção, essa operação remove todos os documentos da coleção, incluindo os indexados e os em fila.

Requisição

DELETE /api/v1/collections/{collection-id}/reset-only

Resposta

{
    "message": "Collection cleaned successfully.",
    "data": null
}