Skip to the content

Update a Source

PATCH /v1/knowledge-bases/{knowledge_base_id}/sources/{source_id}

Property	Value
Operation	`update_knowledge_source`
Group	Knowledge bases
Scope	`knowledge:write`
Route class	`control`
Idempotency	No `Idempotency-Key`
Audit	Audited `knowledge.source.update` (mutation)
Released in	1.53.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Replaces the named fields at the revision If-Match names (1.53.0); the kind never changes, and the change applies to the next sync. 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 PATCH "$VOCAL_API/v1/knowledge-bases/kb_.../sources/ksrc_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/knowledge-bases/kb_.../sources/ksrc_...`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os

import requests

response = requests.patch(
    f"{os.environ['VOCAL_API']}/v1/knowledge-bases/kb_.../sources/ksrc_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
    json={},
)
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.
`source_id`	path	KnowledgeSourceId	yes	The id of a Source of a Knowledge base: `ksrc_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`if-match`	header	string	yes	The revision the change was made against, quoted as the ETag returns it, or `*` to overwrite.

Request body

Content type application/json, required: KnowledgeSourceUpdateRequest.

Field	Type	Required	Description
`connection`	KnowledgeConnectionSettingsInput	no
`name`	string or null	no
`refresh`	KnowledgeRefreshInput	no
`url`	KnowledgeUrlSettingsInput	no

Responses

Status	Content type	Shape	Error codes
`200`	`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`
`412`	`application/json`	ErrorEnvelope	`revision_mismatch`
`422`	`application/json`	ErrorEnvelope	`validation_failed`
`428`	`application/json`	ErrorEnvelope	`precondition_required`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` 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.