Skip to main content
POST
Discover 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
url
string<uri>
required

The HTTP or HTTPS site to discover pages on.

Minimum string length: 1
limit
integer
default:100

Maximum number of pages to return, 1–100.

Required range: 1 <= x <= 100
search
string | null

Optional search text to narrow the discovered pages.

Response

Successful Response

data
KnowledgeWebsitePage · object[]
required

Discovered pages; mapping does not add them to the agent.

object
string
default:knowledge_website_map
required

The type of this object, always knowledge_website_map.

Allowed value: "knowledge_website_map"