Skip to main content
POST
Plan internal links from page + targets

Authorizations

Authorization
string
header
required

Bearer citedy_agent_* key

Body

application/json
url
string<uri>
required

Source page URL to analyze.

Maximum string length: 2000
targetUrls
string<uri>[]

Known target URLs for internal link opportunity analysis.

Maximum array length: 50
sitemapUrl
string<uri>

Optional sitemap URL used when targetUrls are not provided.

Maximum string length: 2000

Response

Success

success
boolean
required
Example:

true

tool
string
required
Example:

"meta-tags"

data
object
required

Tool-specific diagnostics payload.

credits_charged
integer
required
Required range: x >= 0
Example:

1