Skip to content
vocapable.Docs

Turn an evaluation into a coaching draft with the clip (human-initiated)

POST
/v1/workspace/quality/evaluations/{evaluation_id}/coaching
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/quality/evaluations/example/coaching \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "body": "example", "clip_start_ms": 1, "clip_end_ms": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
evaluation_id
required
Evaluation 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
QualityCoachingCreate

A person turns a low score into a coaching item with the clip attached (CC5-R5: human-initiated, never automatic).

object
body
required
Body
string
>= 1 characters <= 4000 characters
clip_start_ms
Any of:
integer
clip_end_ms
Any of:
integer
Examplegenerated
{
  "body": "example",
  "clip_start_ms": 1,
  "clip_end_ms": 1
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
QualityCoachingCreated
object
coaching_item_id
required
Coaching Item Id
string
evaluation_id
required
Evaluation Id
string
Examplegenerated
{
  "coaching_item_id": "example",
  "evaluation_id": "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": {}
    }
  ]
}