Add a Source to a Knowledge base

POST /v1/knowledge-bases/{knowledge_base_id}/sources

Property	Value
Operation	`create_knowledge_source`
Group	Knowledge bases
Scope	`knowledge:write`
Route class	`control`
Idempotency	`Idempotency-Key` accepted: a retry with the same key replays the first answer
Audit	Audited `knowledge.source.create` (mutation)
Released in	1.53.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Creates a Source at revision 1 (1.53.0). A url Source starts its first sync, an Ingestion run with cause manual; an upload Source waits for uploads. A connection Source is refused with capability_not_available until P2. Every issue is a detail of 422 validation_failed (KnowledgeSourceIssueCode, and egress_denied with its reason for a URL the egress guard refuses).

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the knowledge:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/knowledge-bases/kb_.../sources" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "kind": "upload" }'

const response = await fetch(`${process.env.VOCAL_API}/v1/knowledge-bases/kb_.../sources`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "kind": "upload"
  }),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/knowledge-bases/kb_.../sources",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "kind": "upload",
    },
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`knowledge_base_id`	path	KnowledgeBaseId	yes	The id of a Knowledge base: `kb_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`idempotency-key`	header	string	no	A client-chosen key, kept 24 hours per Organization, environment and route. A replay returns the stored response.

Request body

Content type application/json, required: KnowledgeSourceCreateRequest.

Field	Type	Required
`connection`	KnowledgeConnectionSettingsInput	no
`kind`	KnowledgeSourceKind	yes
`name`	string	no
`refresh`	KnowledgeRefreshInput	no
`url`	KnowledgeUrlSettingsInput	no

Responses

Status	Content type	Shape	Error codes
`201`	`application/json`	KnowledgeSource
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`, `org_suspended`
`404`	`application/json`	ErrorEnvelope	`not_found`
`409`	`application/json`	ErrorEnvelope	`knowledge_base_archived`, `idempotency_in_progress`, `idempotency_key_reused`
`422`	`application/json`	ErrorEnvelope	`validation_failed`, `capability_not_available`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `201` answer

The shape is KnowledgeSource.

Field	Type	Required	Description
`connection`	KnowledgeConnectionSettings or null	yes	The settings of a `connection` Source; null for another kind.
`created_at`	Timestamp	yes
`id`	KnowledgeSourceId	yes
`kind`	KnowledgeSourceKind	yes
`knowledge_base_id`	KnowledgeBaseId	yes
`last_run_id`	IngestionRunId or null	yes
`last_synced_at`	Timestamp or null	yes	When the last run that read the Source finished, or null before one.
`name`	string or null	yes
`object`	`"knowledge_source"`	yes
`refresh`	KnowledgeRefresh or null	yes	Null for an `upload` Source.
`revision`	integer	yes	Counts writes; returned as the ETag and required in If-Match.
`status`	KnowledgeSourceStatus	yes
`updated_at`	Timestamp	yes
`url`	KnowledgeUrlSettings or null	yes	The settings of a `url` Source; null for another kind.