Notebooks
Knowledge Bash reads before it answers: notebooks, and the documents in them.
RoutesOpen one for every field it takes and answers.
POST/v1/notebooksCreate a notebook.
Request5 fields
Headers
Idempotency-KeystringSend the same key to retry this call safely for 24 hours.
- Type
string
Body
namestringrequiredIts name, as people read it, 1 to 80 characters.
- Limits
- 1 to 80 characters.
- Example
Refund policy
slugstringrequiredIts short name: lowercase letters, digits and hyphens, starting with a letter, up to 40.
- Example
refund-policy
descriptionstringWhat it holds, up to 300 characters: Bash reads this to know when to look in it. Empty by default.
- Default
- Empty.
- Limits
- At most 300 characters.
accessobjectWho may read it. Default { "mode": "all" }.
- Default
{"mode":"all"}- One of
{ mode },{ mode, user_ids }
Answers 20110 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
No sample in your language for this route, so here it is over HTTP.
curl -X POST "$VESTRA_BASE_URL/v1/notebooks" \ -H "Authorization: Bearer $VESTRA_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Refund policy", "slug": "refund-policy" }'