Skip to content
vocapable.Docs

Apply reviewed website changes while retaining all other knowledge

POST
/v1/knowledge-packs/{pack_id}/website-refresh
curl --request POST \
  --url https://api.vocapable.com/v1/knowledge-packs/example/website-refresh \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_version": 1, "changes": [ { "source_index": 1, "fact": { "label": "example", "text": "example", "source_url": "example", "evidence": "example" } } ], "reviewed": true }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
pack_id
required
Pack Id
string

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WebsiteKnowledgeRefresh
object
expected_version
required
Expected Version
integer
>= 1
changes
required
Changes
Array<object>
>= 1 items <= 100 items
WebsiteKnowledgeChange

An explicit edit of one source, or a new answer; indexes belong to expected_version.

object
source_index
Any of:
integer
fact
Any of:
WebsiteFact
object
label
required
Label
string
>= 1 characters <= 120 characters
text
required
Text
string
>= 1 characters <= 1200 characters
source_url
required
Source Url
string
>= 1 characters <= 2048 characters
evidence
required
Evidence
string
>= 10 characters <= 800 characters
reviewed
required
Reviewed
boolean

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WebsiteKnowledgeSaved
object
pack
required
KnowledgePackSummary

A pack as a list row. current_version is the highest version that reached ready.

object
id
required
Id
string
name
required
Name
string
current_version
Any of:
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
version
required
KnowledgePackVersionResource

A compiled version. Immutable once ready - an edit is the next version.

object
id
required
Id
string
knowledge_pack_id
required
Knowledge Pack Id
string
version
required
Version
integer
content_hash
required
Content Hash
string
compiled_token_count
Any of:
integer
status
required
Status
string
Allowed values: compiling ready failed
sources
required
Sources
Array<object>
PackSource

One distilled section of a pack, plus where it came from.

text is the artifact, not a summary of one: knowledge_pack_versions carries sources and no separate body column, so these sections are the compiled pack. Phrase them spoken-answer-ready - short declaratives an agent can say verbatim.

object
kind
required
Kind
string
Allowed values: pdf url text
label
required
Label
string
>= 1 characters <= 200 characters
text
required
Text
string
>= 1 characters
uri
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
over_default_budget
required
Over Default Budget

Compiled above the 8k default budget but inside the 16k hard cap.

Permitted, and worth telling the tenant: a cap-size pack roughly doubles cold prefill and halves the number of warm pack prefixes a node holds.

boolean
Example
{
  "version": {
    "status": "compiling",
    "sources": [
      {
        "kind": "pdf"
      }
    ]
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}