Skip to main content
POST
voice.knowledge-base.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by voice.knowledge-base.create or voice.knowledge-bases.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

name
string
required

Your unique name for this configuration, up to 40 letters, digits, underscores or hyphens.

Required string length: 1 - 40
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$
status
enum<string>
required

Document indexing state.

Available options:
processing,
ready,
failed
sourceCount
integer
required

Number of document sources.

Required range: 1 <= x <= 10