Read an Ingestion run
GET /v1/knowledge-bases/{knowledge_base_id}/ingestion-runs/{run_id}
Property Value Operation get_ingestion_runGroup Knowledge bases Scope knowledge:readRoute class readIdempotency No Idempotency-Key Audit Not audited: A configuration read; a Source and an Ingestion run carry no content. Released in 1.53.0 Phase 0 host Served (the hosted api pins 1.65.0)
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the knowledge:read scope (Authentication and keys ). Replace each placeholder, such as agt_... or <name>, with your own value.
cURL Node.js Python
curl "$VOCAL_API/v1/knowledge-bases/kb_.../ingestion-runs/kir_..." \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/knowledge-bases/kb_.../ingestion-runs/kir_...`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/knowledge-bases/kb_.../ingestion-runs/kir_...",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
Name In Type Required Description knowledge_base_idpath KnowledgeBaseId yes The id of a Knowledge base: kb_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log. run_idpath IngestionRunId yes The id of an Ingestion run of a Source: kir_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
Responses
Fields of the 200 answer
The shape is IngestionRun .