> ## Documentation Index
> Fetch the complete documentation index at: https://docs.convocore.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create KB

> <strong>(Convocore agents only)</strong> Adds a new document to the agent's knowledge base, if your agent is built with VF use [Voiceflow's API instead](https://developer.voiceflow.com/reference/project). This route must use the new V3 [endpoints](/api-reference/v3/intro).

## Example: Add Text Document

```json theme={null}
{
  "name": "Product FAQ",
  "sourceType": "doc",
  "content": "Your product FAQ content here...",
  "metadata": {
    "description": "Frequently asked questions about our product"
  },
  "tags": ["faq", "product"]
}
```

## Example: Add URLs

```json theme={null}
{
  "name": "Website Pages",
  "sourceType": "url",
  "urls": [
    "https://example.com/about",
    "https://example.com/pricing"
  ],
  "scrapeContent": true,
  "refreshRate": "3d"
}
```

## Example: Crawl Sitemap

```json theme={null}
{
  "name": "Full Website",
  "sourceType": "sitemap",
  "sitemapUrl": "https://example.com/sitemap.xml",
  "maxPages": 100,
  "scrapeContent": true,
  "refreshRate": "7d"
}
```

<Warning>
  URL and sitemap sources may take time to process. Check document status via `GET /agents/{agentId}/kb/{docId}`.
</Warning>

<Tip>
  Set `refreshRate` to automatically re-crawl URL sources. Options: `3d`, `7d`, or `never`.
</Tip>


## OpenAPI

````yaml POST /agents/{agentId}/kb
openapi: 3.0.3
info:
  title: Convocore OpenAPI
  description: Full API reference for Convocore
  version: 1.0.4
servers:
  - url: https://eu-gcp-api.vg-stuff.com/v3
    description: EU Node.js API server
  - url: https://na-gcp-api.vg-stuff.com/v3
    description: NA Node.js API server
security: []
paths:
  /agents/{agentId}/kb:
    post:
      tags:
        - KB
      summary: Add Knowledge Base
      operationId: kbRouter-addKnowledgeBaseToAgent
      parameters:
        - name: agentId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                content:
                  type: string
                metadata:
                  type: object
                  properties:
                    description:
                      type: string
                  required:
                    - description
                  additionalProperties: false
                tags:
                  type: array
                  items:
                    type: string
                sourceType:
                  type: string
                  enum:
                    - doc
                    - url
                    - sitemap
                refreshRate:
                  type: string
                  enum:
                    - 3d
                    - 7d
                    - never
                  default: never
                sitemapUrl:
                  type: string
                urls:
                  type: array
                  items:
                    type: string
                maxPages:
                  type: number
                scrapeContent:
                  type: boolean
              required:
                - name
                - sourceType
              additionalProperties: false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data: {}
                required:
                  - success
                  - message
                additionalProperties: false
        default:
          $ref: '#/components/responses/error'
      security:
        - Authorization: []
components:
  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
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````