VocalDocscontracts 1.65.0

List a Knowledge base's Ingestion runs

GET /v1/knowledge-bases/{knowledge_base_id}/ingestion-runs

PropertyValue
Operationlist_ingestion_runs
GroupKnowledge bases
Scopeknowledge:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; a Source and an Ingestion run carry no content.
Released in1.53.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Lists the runs of every Source, newest first, by Source and status (1.53.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 "$VOCAL_API/v1/knowledge-bases/kb_.../ingestion-runs" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
knowledge_base_idpathKnowledgeBaseIdyesThe id of a Knowledge base: kb_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
source_idqueryKnowledgeSourceIdnoOnly the runs of this Source.
statusqueryIngestionRunStatusnoOnly the runs of this status.

Responses

StatusContent typeShapeError codes
200application/jsonIngestionRunList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is IngestionRunList.

FieldTypeRequiredDescription
dataarray of IngestionRunyesThe Ingestion runs of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes