Skip to content
vocapable.Docs

Knowledge suggestions for the person handling this live call

GET
/v1/mobile/workspace/calls/{call_id}/assist/suggestions
curl --request GET \
  --url https://api.vocapable.com/v1/mobile/workspace/calls/example/assist/suggestions \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
call_id
required
Call Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcAssistPanel
object
call_id
required
Call Id
string
status
required
Status
string
Allowed values: unavailable not_enabled waiting live paused ended
suggestions
required
Suggestions
Array<object>
CcAssistSuggestion

A card: the knowledge section’s own words (never model-written) and its source.

object
id
required
Id
string
title
required
Title
string
snippet
required
Snippet
string
source
required
CcAssistSource
object
kind
Kind
string
default: knowledge_pack
Allowed value: knowledge_pack
pack_id
required
Pack Id
string
version_id
required
Version Id
string
section_index
required
Section Index
integer
label
required
Label
string
matched
required
Matched
string
trigger_turn_seq
required
Trigger Turn Seq
integer
ranker
required
Ranker
string
Allowed values: llm lexical
state
required
State
string
Allowed values: shown pinned dismissed
feedback
required
Any of:
string
Allowed values: up down
latency_ms
required
Latency Ms
integer
created_at
required
Created At
string format: date-time
revision
required
Revision
integer
latency_budget_ms
required
Latency Budget Ms
integer
poll_ms
required
Poll Ms
integer
auto_speak
Auto Speak
boolean
Example
{
  "status": "unavailable",
  "suggestions": [
    {
      "source": {
        "kind": "knowledge_pack"
      },
      "ranker": "llm",
      "state": "shown",
      "feedback": "up"
    }
  ],
  "auto_speak": false
}

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