Skip to main content
POST
Add knowledge website pages

Authorizations

Authorization
string
header
required

An org API key: Authorization: Bearer phk_…

Headers

Phonely-Organization
string | null

Optional. Must be the key's org.

Path Parameters

id
string
required

The agent's ID.

Body

application/json
urls
string<uri>[]
required

One to 50 HTTP or HTTPS pages to add.

Required array length: 1 - 50 elements
Minimum string length: 1
max_age_ms
integer
default:86400000

Maximum cached page age in milliseconds. Used only for a single URL.

Required range: x >= 0

Response

Successful Response

data
KnowledgeSource · object[]
required

The sources successfully added by this request.

errors
KnowledgeWebsiteError · object[]
required

Failures per page. Empty when every page was added.

object
string
default:knowledge_source_batch
required

The type of this object, always knowledge_source_batch.

Allowed value: "knowledge_source_batch"