Skip to content
vocapable.Docs

Save the workspace goal (and optional steps skipped)

PUT
/v1/workspace/setup
curl --request PUT \
  --url https://api.vocapable.com/v1/workspace/setup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "goal": "receptionist", "skipped": [ "records" ], "expected_revision": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceSetupUpdate
object
goal
required
Goal
string
Allowed values: receptionist sales_team people_ai
skipped
Skipped
Array<string>
expected_revision
Any of:
integer
>= 1

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceSetup

Progress derived from real records; next_missing replaces any percentage.

object
goal
required
Any of:
string
Allowed values: receptionist sales_team people_ai
steps
required
Steps
Array<object>
WorkspaceSetupStep
object
key
required
Key
string
Allowed values: company knowledge goal people phone routing records test launch
title
required
Title
string
description
required
Description
string
state
required
State
string
Allowed values: done missing optional skipped not_needed
required
required
Required
boolean
evidence
required
Evidence
string
link
required
Link
string
next_missing
required
Any of:
WorkspaceSetupStep
object
key
required
Key
string
Allowed values: company knowledge goal people phone routing records test launch
title
required
Title
string
description
required
Description
string
state
required
State
string
Allowed values: done missing optional skipped not_needed
required
required
Required
boolean
evidence
required
Evidence
string
link
required
Link
string
ready
required
Ready
boolean
revision
required
Any of:
integer
can_edit
required
Can Edit
boolean
Example
{
  "goal": "receptionist",
  "steps": [
    {
      "key": "company",
      "state": "done"
    }
  ],
  "next_missing": {
    "key": "company",
    "state": "done"
  }
}

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