Sign in

v1

latestOpenAPI 3.0.02026-07-268285163.6 KB
Knowledge Bases

Create a knowledge base

Create a new knowledge base with advanced configurations for ingestion, chunking, and reranking

post/assistant_knowledges

Request body

namestring required

Name of the knowledge base

is_document_confidentialboolean

Whether documents are confidential

Example request

{
  "name": "Customer Support Knowledge",
  "LLM": {
    "model_id": "68d107cb4e25ad833b1fd928",
    "model_name": "GPT-4 Turbo",
    "provider": "OpenAI",
    "name": "gpt-4-turbo"
  },
  "reranking": {
    "weighting_multiplier_coefficient": 1
  },
  "chunking": {
    "web": {
      "chunking_method": "dynamic",
      "chunk_size": 7500,
      "chunk_overlap": 100,
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    },
    "image": {
      "chunking_method": "fixed_size",
      "chunk_size": 7500,
      "chunk_overlap": 100,
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    },
    "pdf": {
      "chunking_method": "by_page",
      "chunk_size": 7500,
      "chunk_overlap": 100,
      "split_pdf_pages": true,
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    },
    "docx": {
      "chunking_method": "by_page",
      "chunk_size": 7500,
      "chunk_overlap": 100,
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    },
    "ppt": {
      "chunking_method": "dynamic",
      "chunk_size": 7500,
      "chunk_overlap": 100,
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    },
    "txt": {
      "chunking_method": "fixed_size",
      "chunk_size": 7500,
      "chunk_overlap": 100,
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    },
    "csv": {
      "chunking_method": "by_line",
      "chunk_size": 7500,
      "chunk_overlap": 100,
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    }
  },
  "ingestion": {
    "delay_between_documents_ms": 2000,
    "web": {
      "library": "Puppeteer",
      "selector": "h1, h2, h3, h4, h5, h6, h7, h8, p, span, article, div.content, div.text, li, blockquote, figcaption, summary",
      "exclude": "header, footer",
      "proxy": {
        "country": "France"
      }
    },
    "image": {
      "strategy": "ocr",
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    },
    "pdf": {
      "strategy": "parse",
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    },
    "docx": {
      "strategy": "parse",
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    },
    "ppt": {
      "strategy": "parse",
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    },
    "txt": {
      "strategy": "parse",
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    },
    "csv": {
      "strategy": "parse",
      "llm_model": {
        "model_id": "68d107cb4e25ad833b1fd928",
        "model_name": "GPT-4 Turbo",
        "provider": "OpenAI",
        "name": "gpt-4-turbo"
      }
    }
  }
}

Response

Knowledge base successfully created

Example response

{
  "knowledge": {
    "_id": "69803b43c782090c87b676c6",
    "name": "Customer Support Knowledge",
    "user_id": "5d4ae69ef5dc79b3d4ca5ad3",
    "need_training": true,
    "LLM": {
      "model_id": "68d107cb4e25ad833b1fd928",
      "model_name": "GPT-4 Turbo",
      "provider": "OpenAI",
      "name": "gpt-4-turbo"
    },
    "reranking": {
      "weighting_multiplier_coefficient": 1
    },
    "chunking": {
      "web": {
        "chunking_method": "dynamic",
        "chunk_size": 7500,
        "chunk_overlap": 100,
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      },
      "image": {
        "chunking_method": "fixed_size",
        "chunk_size": 7500,
        "chunk_overlap": 100,
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      },
      "pdf": {
        "chunking_method": "by_page",
        "chunk_size": 7500,
        "chunk_overlap": 100,
        "split_pdf_pages": true,
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      },
      "docx": {
        "chunking_method": "by_page",
        "chunk_size": 7500,
        "chunk_overlap": 100,
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      },
      "ppt": {
        "chunking_method": "dynamic",
        "chunk_size": 7500,
        "chunk_overlap": 100,
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      },
      "txt": {
        "chunking_method": "fixed_size",
        "chunk_size": 7500,
        "chunk_overlap": 100,
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      },
      "csv": {
        "chunking_method": "by_line",
        "chunk_size": 7500,
        "chunk_overlap": 100,
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      }
    },
    "ingestion": {
      "delay_between_documents_ms": 2000,
      "web": {
        "library": "Puppeteer",
        "selector": "h1, h2, h3, h4, h5, h6, h7, h8, p, span, article, div.content, div.text, li, blockquote, figcaption, summary",
        "exclude": "header, footer",
        "proxy": {
          "country": "France"
        }
      },
      "image": {
        "strategy": "ocr",
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      },
      "pdf": {
        "strategy": "parse",
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      },
      "docx": {
        "strategy": "parse",
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      },
      "ppt": {
        "strategy": "parse",
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      },
      "txt": {
        "strategy": "parse",
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      },
      "csv": {
        "strategy": "parse",
        "llm_model": {
          "model_id": "68d107cb4e25ad833b1fd928",
          "model_name": "GPT-4 Turbo",
          "provider": "OpenAI",
          "name": "gpt-4-turbo"
        }
      }
    },
    "createdAt": "2026-02-02T05:50:59.424Z",
    "updatedAt": "2026-02-02T05:50:59.424Z"
  }
}