Create a knowledge source to ingest

POST

knowledge

sources

curl --request POST "$MITHUNAI_URL/arukz/api/v1/knowledge/sources" \
  --header "Authorization: Bearer $MITHUNAI_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "collection_id": "0b6f2c14-8a3d-4e91-9c77-2f5b1d0a4e88",
    "source_type": "website",
    "name": "Product documentation site",
    "configuration": {
      "seed_url": "https://docs.example.com/",
      "path_prefix": "/guides",
      "max_pages": "1000",
      "exclude_paths": "/guides/archive/"
    }
  }'

import os, requests

response = requests.post(
    f"{os.environ['MITHUNAI_URL']}/arukz/api/v1/knowledge/sources",
    headers={"Authorization": f"Bearer {os.environ['MITHUNAI_API_KEY']}"},
    json={
        "collection_id": "0b6f2c14-8a3d-4e91-9c77-2f5b1d0a4e88",
        "source_type": "website",
        "name": "Product documentation site",
        "configuration": {
            "seed_url": "https://docs.example.com/",
            "path_prefix": "/guides",
            "max_pages": "1000",
            "exclude_paths": "/guides/archive/",
        },
    },
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch(`${process.env.MITHUNAI_URL}/arukz/api/v1/knowledge/sources`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MITHUNAI_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    collection_id: '0b6f2c14-8a3d-4e91-9c77-2f5b1d0a4e88',
    source_type: 'website',
    name: 'Product documentation site',
    configuration: {
      seed_url: 'https://docs.example.com/',
      path_prefix: '/guides',
      max_pages: '1000',
      exclude_paths: '/guides/archive/',
    },
  }),
})
console.log(await response.json())

{
  "id": "5d1e7a90-3c4b-4f2a-8e61-7b9c0d2f4a13",
  "collection_id": "0b6f2c14-8a3d-4e91-9c77-2f5b1d0a4e88",
  "source_type": "website",
  "name": "Product documentation site",
  "configuration": {
    "seed_url": "https://docs.example.com/",
    "path_prefix": "/guides",
    "max_depth": "3",
    "max_pages": "1000",
    "include_paths": "",
    "exclude_paths": "/guides/archive/"
  },
  "status": "active",
  "last_source_version": null,
  "last_ingested_at": null,
  "created_at": "2026-09-24T10:15:02.418331",
  "updated_at": "2026-09-24T10:15:02.418331"
}

{ "code": "validation_error", "message": "The source URL is not valid." }

{ "code": "authorization_error", "message": "You do not have permission to perform this action." }

{ "code": "not_found", "message": "The knowledge collection was not found." }

Creating a source validates and stores its configuration. It does not read anything. To ingest the source, call Sync a source. configuration is a flat object. Every value is a string, and lists are comma-separated inside one string, for example "docs/,README.md". Numbers are accepted and converted to strings. Booleans, arrays and nested objects are refused. The configuration is checked for its source_type when you create the source, so a malformed URL or repository name returns 400 here, not later during ingestion. The response returns the stored form: keys the source type does not read are dropped, and optional keys you left out are filled in with their defaults. No credential can be passed in configuration. Everything in it is readable by every member of your organization. Creating a source requires a role that can manage knowledge. A read-only member receives 403. A collection_id that is not in your organization returns 404. See Knowledge sources for guidance on choosing a source type.

string

required

ID (a UUID) of the collection to ingest into. A malformed ID returns 400. Syncing a source whose collection is archived is accepted, and the job then ends failed.

string

required

One of website, sitemap, github or upload. Any other value returns 400.

string

required

Display name, 1 to 255 characters after trimming.

object

Settings for the source type. At most 50 keys, and each value at most 8,192 characters. The keys each type reads are listed below. The field itself may be omitted, but every source type has a required setting, so in practice a source created without configuration is refused with 400.

Show website

Crawls a documentation site from a seed URL, following links on the same origin (scheme, host and port) only. Redirects are not followed, so a page that redirects is treated as unreadable. URLs ending in image, media, archive, font, stylesheet or script extensions are skipped.

string

required

Absolute http or https URL the crawl starts from, at most 2,048 characters. It must not contain a username or password.

string

default:""

Crawl only paths at or below this prefix, for example /docs. It must start with / and must not contain ... Matching is by path segment, so /docs does not match /docs-internal.

string

default:"3"

Number of links followed from the seed. An integer from 1 to 10.

string

default:"500"

Maximum pages collected in one run. An integer from 1 to 5000.

string

default:""

Comma-separated globs matched against the URL path. When set, only matching pages are ingested. At most 100 globs of up to 512 characters each.

string

default:""

Comma-separated globs matched against the URL path. Matching pages are skipped, even when they also match include_paths. At most 100 globs of up to 512 characters each.

Show sitemap

Reads the URLs listed in a sitemap.xml without following links. It takes the same keys as website. Listed URLs must still be on the sitemap’s origin and pass path_prefix, include_paths and exclude_paths. max_pages caps the pages read. max_depth is validated but not used. A sitemap index is followed to at most 100 child sitemaps.

string

required

Absolute http or https URL of the sitemap, at most 2,048 characters.

Show github

Reads a GitHub repository at a branch, tag or commit. Nothing secret is stored on the source. The repository is read with the access your deployment is configured with.

string

required

Account or organization name. Letters, digits, ., _ and -, starting with a letter or digit, not ending in ., at most 100 characters.

string

required

Repository name, with the same rules as owner.

string

default:""

Branch, tag or commit SHA: letters, digits, ., _, / and -, starting with a letter or digit, at most 255 characters. It must not contain .. or //. Leave it empty to follow the repository’s default branch.

string

default:""

Comma-separated globs matched against repository paths. When set, only matching files are ingested. At most 100 globs of up to 512 characters each.

string

Comma-separated globs for files to skip. An exclusion wins over an include. A value you send replaces the default list rather than adding to it. At most 100 globs of up to 512 characters each.

Show upload

Ingests files you stored with Upload files. Post that response’s configuration object back unchanged.

string

required

The manifest: one storage_key|filename entry per file, entries separated by newlines. At most 1,000 files, with no storage key listed twice. Every storage key must be one issued to your organization.

In include_paths and exclude_paths, * matches within one path segment, ** matches across segments, ? matches one character, and a trailing / matches everything below a directory.

Response

Returns 201 with the new source.

string

required

Source ID (a UUID).

string

required

Collection the source ingests into.

string

required

website, sitemap, github or upload.

string

required

The trimmed name.

object

required

The stored configuration. Every key the source type reads is present, with defaults filled in, and every value is a string.

string

required

active for a new source.

string | null

required

null until the source has been ingested.

string | null

required

null until the source has been ingested.

string

required

When the source was created, ISO 8601 in UTC.

string

required

When the source was last changed, ISO 8601 in UTC.

curl --request POST "$MITHUNAI_URL/arukz/api/v1/knowledge/sources" \
  --header "Authorization: Bearer $MITHUNAI_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "collection_id": "0b6f2c14-8a3d-4e91-9c77-2f5b1d0a4e88",
    "source_type": "website",
    "name": "Product documentation site",
    "configuration": {
      "seed_url": "https://docs.example.com/",
      "path_prefix": "/guides",
      "max_pages": "1000",
      "exclude_paths": "/guides/archive/"
    }
  }'

import os, requests

response = requests.post(
    f"{os.environ['MITHUNAI_URL']}/arukz/api/v1/knowledge/sources",
    headers={"Authorization": f"Bearer {os.environ['MITHUNAI_API_KEY']}"},
    json={
        "collection_id": "0b6f2c14-8a3d-4e91-9c77-2f5b1d0a4e88",
        "source_type": "website",
        "name": "Product documentation site",
        "configuration": {
            "seed_url": "https://docs.example.com/",
            "path_prefix": "/guides",
            "max_pages": "1000",
            "exclude_paths": "/guides/archive/",
        },
    },
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch(`${process.env.MITHUNAI_URL}/arukz/api/v1/knowledge/sources`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MITHUNAI_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    collection_id: '0b6f2c14-8a3d-4e91-9c77-2f5b1d0a4e88',
    source_type: 'website',
    name: 'Product documentation site',
    configuration: {
      seed_url: 'https://docs.example.com/',
      path_prefix: '/guides',
      max_pages: '1000',
      exclude_paths: '/guides/archive/',
    },
  }),
})
console.log(await response.json())

{
  "id": "5d1e7a90-3c4b-4f2a-8e61-7b9c0d2f4a13",
  "collection_id": "0b6f2c14-8a3d-4e91-9c77-2f5b1d0a4e88",
  "source_type": "website",
  "name": "Product documentation site",
  "configuration": {
    "seed_url": "https://docs.example.com/",
    "path_prefix": "/guides",
    "max_depth": "3",
    "max_pages": "1000",
    "include_paths": "",
    "exclude_paths": "/guides/archive/"
  },
  "status": "active",
  "last_source_version": null,
  "last_ingested_at": null,
  "created_at": "2026-09-24T10:15:02.418331",
  "updated_at": "2026-09-24T10:15:02.418331"
}

{ "code": "validation_error", "message": "The source URL is not valid." }

{ "code": "authorization_error", "message": "You do not have permission to perform this action." }

{ "code": "not_found", "message": "The knowledge collection was not found." }

Last modified on September 26, 2026

⌘I

curl --request POST "$MITHUNAI_URL/arukz/api/v1/knowledge/sources" \
  --header "Authorization: Bearer $MITHUNAI_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "collection_id": "0b6f2c14-8a3d-4e91-9c77-2f5b1d0a4e88",
    "source_type": "website",
    "name": "Product documentation site",
    "configuration": {
      "seed_url": "https://docs.example.com/",
      "path_prefix": "/guides",
      "max_pages": "1000",
      "exclude_paths": "/guides/archive/"
    }
  }'

import os, requests

response = requests.post(
    f"{os.environ['MITHUNAI_URL']}/arukz/api/v1/knowledge/sources",
    headers={"Authorization": f"Bearer {os.environ['MITHUNAI_API_KEY']}"},
    json={
        "collection_id": "0b6f2c14-8a3d-4e91-9c77-2f5b1d0a4e88",
        "source_type": "website",
        "name": "Product documentation site",
        "configuration": {
            "seed_url": "https://docs.example.com/",
            "path_prefix": "/guides",
            "max_pages": "1000",
            "exclude_paths": "/guides/archive/",
        },
    },
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch(`${process.env.MITHUNAI_URL}/arukz/api/v1/knowledge/sources`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MITHUNAI_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    collection_id: '0b6f2c14-8a3d-4e91-9c77-2f5b1d0a4e88',
    source_type: 'website',
    name: 'Product documentation site',
    configuration: {
      seed_url: 'https://docs.example.com/',
      path_prefix: '/guides',
      max_pages: '1000',
      exclude_paths: '/guides/archive/',
    },
  }),
})
console.log(await response.json())

{
  "id": "5d1e7a90-3c4b-4f2a-8e61-7b9c0d2f4a13",
  "collection_id": "0b6f2c14-8a3d-4e91-9c77-2f5b1d0a4e88",
  "source_type": "website",
  "name": "Product documentation site",
  "configuration": {
    "seed_url": "https://docs.example.com/",
    "path_prefix": "/guides",
    "max_depth": "3",
    "max_pages": "1000",
    "include_paths": "",
    "exclude_paths": "/guides/archive/"
  },
  "status": "active",
  "last_source_version": null,
  "last_ingested_at": null,
  "created_at": "2026-09-24T10:15:02.418331",
  "updated_at": "2026-09-24T10:15:02.418331"
}

{ "code": "validation_error", "message": "The source URL is not valid." }

{ "code": "authorization_error", "message": "You do not have permission to perform this action." }

{ "code": "not_found", "message": "The knowledge collection was not found." }

Get started

Conversations

Assistants

Models

Knowledge

Widget deployments

Widget (public)

MCP

API keys

Members

Analytics

Support access

Branding

Operations

Create a knowledge source to ingest

Response

​Response

Response