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

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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
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_-]*$
assistant
string

Attach the ready base to your named assistant on the same source.

Required string length: 1 - 40
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$
text
string

Document text; may contain personal data, up to 100,000 characters.

Required string length: 1 - 100000
fileId
string

Id of an uploaded file holding An uploaded document, at most 20 MB., in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
urls
string[]

Up to ten public pages fetched by our server; at most 100,000 characters in total.

Required array length: 1 - 10 elements
refresh
boolean
default:false

Enable recurring source refresh when supported.

minChunkSize
integer

Minimum text chunk length in characters.

Required range: 200 <= x <= 2000
maxChunkSize
integer

Maximum text chunk length in characters.

Required range: 600 <= x <= 6000

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.