Notebooks

Knowledge Bash reads before it answers: notebooks, and the documents in them.

Send Authorization: Bearer vk_test_... on every call. Every route of Notebooks.

PATCH/v1/notebooks/{notebook_id}Rename it, or set who may read it: every user, or named users only.

Your API key, scope setup or all. On the card: deploy. Over HTTP it is made from the contract: fill in each {…} and every value.

Request4 fields

Path

notebook_idstringrequiredThe notebook's id (nb_...).

Type: string

Body

namestringA new name, 1 to 80 characters.

Limits: 1 to 80 characters.

descriptionstringA new description, up to 300 characters.

Limits: At most 300 characters.

accessobjectWho may read it, from now on.

One of: { mode }, { mode, user_ids }

Answers 20010 fields

object"notebook"Always notebook.

Type: "notebook"

idstringThe notebook's id.

Example: nb_8f2k

slugstringIts short name.

Type: string

namestringIts name, as people read it.

Type: string

descriptionstringWhat it holds; empty when none was given.

Type: string

accessobjectWho may read it.

One of: { mode }, { mode, user_ids }

document_countintegerHow many documents it holds.

Type: integer

bytesintegerThe size of its text, in bytes, at most 5 MB.

Type: integer

created_atstringWhen it was made, as an ISO 8601 date and time in UTC.

Type: string

updated_atstringWhen it last changed, as an ISO 8601 date and time in UTC.

Type: string

HTTP

No sample in your language for this route, so here it is over HTTP.

curl -X PATCH "$VESTRA_BASE_URL/v1/notebooks/{notebook_id}" \  -H "Authorization: Bearer $VESTRA_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'