Skip to content
vocapable.Docs

Update Company Knowledge

PATCH
/v1/mobile/company-knowledge/{pack_id}
curl --request PATCH \
  --url https://api.vocapable.com/v1/mobile/company-knowledge/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "expected_version": 1, "changes": [ { "source_index": 1, "fact": { "label": "example", "text": "example", "source_url": "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
required
string
<= 255 characters

Unique key for this draft change. Retry with the same key and body to replay the saved result instead of repeating the change. Stored for 24 hours; a replay carries Idempotent-Replay: true.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
MobileKnowledgeUpdate
object
expected_version
required
Expected Version
integer
changes
required
Changes
Array<object>
>= 1 items <= 100 items
MobileKnowledgeChange
object
source_index
Any of:
integer
fact
Any of:
MobileKnowledgeFact
object
label
required
Label
string
>= 1 characters <= 200 characters
text
required
Text
string
>= 1 characters <= 20000 characters
source_url
Any of:
string
>= 1 characters <= 2048 characters
reviewed
required
Reviewed
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MobileCompanyKnowledge
object
id
required
Id
string
name
required
Name
string
version
required
Version
integer
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
compiled_token_count
required
Any of:
integer
Example
{
  "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": {}
    }
  ]
}