Skip to content
vocapable.Docs

Which agents a publish would affect, and how

GET
/v1/workspace/knowledge/reviews/{review_id}/impact
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/knowledge/reviews/example/impact \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
review_id
required
Review Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceKnowledgeImpact
object
review_id
required
Review Id
string
pack_id
required
Pack Id
string
current_version
required
Any of:
integer
agents
required
Agents
Array<object>
WorkspaceKnowledgeAffectedAgent
object
agent_id
required
Agent Id
string
name
required
Name
string
follows_latest
required
Follows Latest
boolean
pinned_version
required
Any of:
integer
live_version
required
Any of:
integer
effect
required
Effect
string
before
required
Any of:
string
after
required
Any of:
string
Examplegenerated
{
  "review_id": "example",
  "pack_id": "example",
  "current_version": 1,
  "agents": [
    {
      "agent_id": "example",
      "name": "example",
      "follows_latest": true,
      "pinned_version": 1,
      "live_version": 1,
      "effect": "example"
    }
  ],
  "before": "example",
  "after": "example"
}

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": {}
    }
  ]
}