Skip to content
Kheelona Voice

Ends a live session (reason `partner_ended`; the live connection closes within 10 s) or cancels a reserved one. Ending a finished session is a no-op

POST /v1/sessions/{id}/end

Property Value
Operation endSession
Scope sessions:write

Parameters

Section titled “Parameters”
Name In Type Required Description Rules
id path string yes The session ID (ses_…)

Responses

Section titled “Responses”

204

Section titled “204”

Ended, cancelled, or already finished

Header Type Description
RateLimit-Limit integer Requests allowed at once for this key
RateLimit-Remaining integer Requests left right now
RateLimit-Reset integer Seconds until the limit is full again
X-Request-Id string The request’s ID (req_…); quote it in reports.

401

Section titled “401”

Missing or invalid API key

Header Type Description
RateLimit-Limit integer Requests allowed at once for this key
RateLimit-Remaining integer Requests left right now
RateLimit-Reset integer Seconds until the limit is full again
X-Request-Id string The request’s ID (req_…); quote it in reports.
Field Type Required Description Rules
error object yes The error.
error.code string yes one of invalid_request, unauthenticated, secret_expired, forbidden, origin_not_allowed, voice_not_found, session_not_found, capacity_exhausted, partner_limit_reached, rate_limited, internal, not_found, conflict, unavailable
error.message string yes A short, fixed description. Never quotes the request.
error.request_id string yes The request’s ID (also in the X-Request-Id header); quote it when reporting a problem. pattern ^req_[0-9A-HJKMNP-TV-Z]{26}$
error.details any no Structured detail, e.g. {"field": "languages[1]"} or {"reason": "quota_exhausted"}.

403

Section titled “403”

The key lacks sessions:write

Header Type Description
RateLimit-Limit integer Requests allowed at once for this key
RateLimit-Remaining integer Requests left right now
RateLimit-Reset integer Seconds until the limit is full again
X-Request-Id string The request’s ID (req_…); quote it in reports.
Field Type Required Description Rules
error object yes The error.
error.code string yes one of invalid_request, unauthenticated, secret_expired, forbidden, origin_not_allowed, voice_not_found, session_not_found, capacity_exhausted, partner_limit_reached, rate_limited, internal, not_found, conflict, unavailable
error.message string yes A short, fixed description. Never quotes the request.
error.request_id string yes The request’s ID (also in the X-Request-Id header); quote it when reporting a problem. pattern ^req_[0-9A-HJKMNP-TV-Z]{26}$
error.details any no Structured detail, e.g. {"field": "languages[1]"} or {"reason": "quota_exhausted"}.

404

Section titled “404”

session_not_found

Header Type Description
RateLimit-Limit integer Requests allowed at once for this key
RateLimit-Remaining integer Requests left right now
RateLimit-Reset integer Seconds until the limit is full again
X-Request-Id string The request’s ID (req_…); quote it in reports.
Field Type Required Description Rules
error object yes The error.
error.code string yes one of invalid_request, unauthenticated, secret_expired, forbidden, origin_not_allowed, voice_not_found, session_not_found, capacity_exhausted, partner_limit_reached, rate_limited, internal, not_found, conflict, unavailable
error.message string yes A short, fixed description. Never quotes the request.
error.request_id string yes The request’s ID (also in the X-Request-Id header); quote it when reporting a problem. pattern ^req_[0-9A-HJKMNP-TV-Z]{26}$
error.details any no Structured detail, e.g. {"field": "languages[1]"} or {"reason": "quota_exhausted"}.

429

Section titled “429”

Rate limited

Header Type Description
RateLimit-Limit integer Requests allowed at once for this key
RateLimit-Remaining integer Requests left right now
RateLimit-Reset integer Seconds until the limit is full again
Retry-After integer Seconds to wait before retrying
X-Request-Id string The request’s ID (req_…); quote it in reports.
Field Type Required Description Rules
error object yes The error.
error.code string yes one of invalid_request, unauthenticated, secret_expired, forbidden, origin_not_allowed, voice_not_found, session_not_found, capacity_exhausted, partner_limit_reached, rate_limited, internal, not_found, conflict, unavailable
error.message string yes A short, fixed description. Never quotes the request.
error.request_id string yes The request’s ID (also in the X-Request-Id header); quote it when reporting a problem. pattern ^req_[0-9A-HJKMNP-TV-Z]{26}$
error.details any no Structured detail, e.g. {"field": "languages[1]"} or {"reason": "quota_exhausted"}.