Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Headers

Idempotency-Key
string

Client-supplied idempotency key on mutating POSTs. Retrying the same request with the same key returns the original result instead of creating a duplicate — send a fresh UUID per logical operation.

Path Parameters

agentId
string
required

The agent this resource is scoped to (the UUID returned by createAgent / listAgents).

Body

application/json

A new knowledge source. kind decides which content field is required: url → url (a website to crawl); file → file_id (an uploaded document from Uploads); text → text (pasted plain text); faq → text (Q&A content).

kind
enum<string>
required

Source type — decides which of url/file_id/text is required.

Available options:
url,
file,
text,
faq
label
string
required

Human label shown in the knowledge list.

url
string

Website to crawl (required when kind=url).

file_id
string

Uploaded document id from Uploads (required when kind=file).

text
string

Raw text/FAQ content (required when kind=text or kind=faq).

Response

Created source (status pending).

success
boolean
required
data
object
required
message
string
errors
object[]