Generate Article

Suggest internal links for an article

Changed on

Suggest the most relevant existing SnowSEO articles to link to from a new article, ranked by relevance. Pass the returned target slugs to create_article / generate_article as internalLinkTargetSlugs.

get/v3/generate-article/generate-internal-links

Request

  • Base URL: https://api.snowseo.com
  • URL: https://api.snowseo.com/v3/generate-article/generate-internal-links
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

current_titlestring required

Title of the article that will link out.

topic_idstring

Topic cluster id (required when content_article_type is set).

content_article_type'pillar' | 'cluster'

Omit for a standalone post.

exclude_article_slugstring

Slug to exclude from suggestions (e.g. the article itself).

team_idstring

Response

Default Response

Changes

  • e0163b1c37cbRevision changes
    • breaking

      api path removed without deprecation

    • info

      endpoint added

  • 8f92b00b75d6Revision changes
    • breaking

      the query request parameter content_article_type was restricted to a list of enum values

    • info

      added the new enum value cluster to the query request parameter content_article_type

    • info

      added the new enum value pillar to the query request parameter content_article_type