Knowledge

Events

Request fields, response objects and current limitations.

Quickstart: official Python SDK

Base URL and authentication

Use existing resource IDs in paths. Set the environment variables shown in each example.

List events

GET /knowledge/v1/vector_stores/{vector_store_id}/events

Reads events for this knowledge base in increasing sequence order, including while soft-deleted. Pass next_seq as after_seq to continue; null next_seq marks the current end. Example: ?after_seq=0&limit=20.

Parameters

NameLocation and typeDescription
vector_store_idpath: stringRequired; Knowledge-base ID returned by create or list; use the ID rather than its display name. min characters: 1
after_seqquery: integerReturn events with larger seq. Use next_seq to continue; invalid text is currently ignored. default: 0
limitquery: integerPage size. min: 1; max: 100; default: 20

Request example

curl -X GET "https://api.deepraxis.ai/knowledge/v1/vector_stores/${VECTOR_STORE_ID}/events" \
  -H "Authorization: Bearer $PRAXIS_API_KEY"

Response

HTTP 200

FieldTypeDescription
dataobject[]required; Events with seq greater than after_seq, ordered by increasing seq.
data[].seqintegerrequired; Store-local increasing event sequence; pass the returned next_seq as after_seq to continue.; min: 1
data[].idstringrequired; Server-generated UUID identifying this event.
data[].type"vector_store.created" / "vector_store.updated" / "vector_store.expired" / "vector_store.deleted" / "vector_store.restored" / "file.attached" / "file.stage_changed" / "file.completed" / "file.failed" / "file.cancelled" / "file.removed" / "batch.created" / "batch.completed" / "batch.cancelled"required; Kind of store, file-ingestion or batch event recorded in this knowledge base.
data[].processed_atintegerrequired; Unix timestamp in seconds.
data[].vector_store_idstringrequired; Resource ID.; min characters: 1
data[].file_idstring / nullrequired; Associated source File ID; null for events without a file.
data[].batch_idstring / nullrequired; Associated file-batch ID; null for events without a batch.
data[].dataobjectrequired; Event-specific details; stage changes include stage, ingestion failures include code, and other events may use an empty object.
next_seqinteger / nullrequired; Pass as after_seq for the next page; null means the end.

Error codes and objects

Export

On this page