BizKitHub
DocsAPI ReferenceAi Agent/bff/ai-context/detail
getAi AgentAdmin BFF

/bff/ai-context/detail

Read a note including its current version before updating it.

AI AgentgetBffAi-contextDetail

Parameters

1 query

Query parameters

· 1
idstringRequired

Note id (16 characters), as returned by /list or shown in the /document markdown.

Length: 16–16
Exampleexample_id

Response schema

1 status code documented

200Success
idstringRequired
titlestringRequired
contentstringRequired
isPinnedbooleanRequired
versionnumberRequired

Current version; send it back as expectedVersion when updating.

insertedDatestringRequired
updatedDatestringRequired
createdByNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
createdViaAiAgentbooleanRequired
updatedByNamestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
updatedViaAiAgentbooleanRequired

Response example

application/json
{
  "id": "example_id",
  "title": "example_title",
  "content": "example_content",
  "isPinned": false,
  "version": 0,
  "insertedDate": "example_insertedDate",
  "updatedDate": "example_updatedDate",
  "createdViaAiAgent": false,
  "updatedViaAiAgent": false
}

Request example

GET /bff/ai-context/detail

get
curl -X GET "https://api.bizkithub.com/bff/ai-context/detail?id=example_id" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key