API Documentation

Website Health Check

The Website Health Check endpoint performs a comprehensive technical review of a webpage and returns detailed information about the accessibility, availability, and technical condition of the requested URL.

This service can be used to verify that a page is publicly accessible, responds correctly to search engine crawlers, and does not contain common technical issues that could affect indexing or visibility.

The response includes HTTP status information, redirect chains, SSL validation status, response times, content type detection, canonical URL checks, and other technical diagnostics.

Endpoint

GET /api/health/check

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
url	Yes	Target webpage URL.

Example Request

GET /api/health/check?apikey=YOUR_API_KEY&url=https://example.com

Example Response

{
  "success": true,
  "statusCode": 200,
  "sslValid": true,
  "responseTimeMs": 184,
  "canonicalFound": true
}

SEO Page Analysis

The SEO Page Analysis endpoint performs a comprehensive on-page SEO audit of a webpage and returns detailed information about its search engine optimization status. This service is designed for developers, agencies, website owners, and SEO professionals who need fast and automated access to technical and content-related SEO metrics.

The analysis engine examines essential ranking signals including page titles, meta descriptions, heading hierarchy, canonical URLs, internal links, external links, image attributes, robots directives, structured data availability, and content structure. The endpoint also generates an overall SEO score together with actionable recommendations that can help improve the page's search engine compatibility.

This service can be integrated into dashboards, monitoring systems, content management platforms, website auditing tools, and automated SEO workflows. Results are returned in JSON format and can be processed programmatically by your applications.

This endpoint analyzes publicly accessible webpages. The target URL must be reachable over HTTP or HTTPS and must not block automated requests.

Endpoint

GET /api/seo/analyze

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
url	Yes	The webpage URL to analyze.
includeImages	No	Include image analysis data in the response.
includeLinks	No	Include internal and external link statistics.
includeSchema	No	Include structured data detection results.

Example Request

GET /api/seo/analyze?apikey=YOUR_API_KEY&url=https://example.com

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "seoScore": 91,
    "title": "Example Website",
    "titleLength": 15,
    "metaDescriptionLength": 142,
    "headings": {
      "h1": 1,
      "h2": 5,
      "h3": 8
    },
    "internalLinks": 24,
    "externalLinks": 3,
    "images": 17,
    "missingAltAttributes": 1,
    "canonicalFound": true,
    "structuredDataDetected": true
  }
}

Response Fields

Field	Type	Description
seoScore	Integer	Overall SEO score calculated from multiple ranking factors.
title	String	Detected page title.
titleLength	Integer	Length of the title tag.
metaDescriptionLength	Integer	Length of the meta description tag.
headings	Object	Heading count grouped by heading level.
internalLinks	Integer	Number of detected internal links.
externalLinks	Integer	Number of detected external links.
missingAltAttributes	Integer	Number of images without alt text.
canonicalFound	Boolean	Indicates whether a canonical URL was found.

Common Use Cases

Automated SEO audits.
Website quality monitoring.
Content publishing validation.
SEO dashboard integrations.
Agency reporting systems.
Large-scale website analysis.

SEO HTML Optimizer

The SEO HTML Optimizer endpoint accepts raw HTML content and returns an SEO-enhanced version of the document. The service analyzes the structure of the page and automatically improves technical SEO elements while preserving the original content and layout whenever possible.

This endpoint is ideal for content management systems, website builders, publishing platforms, agencies, and developers who need to automate SEO improvements across large numbers of pages. Instead of manually reviewing HTML documents, the optimizer can identify common SEO issues and generate a cleaner, search-engine-friendly version of the page.

The optimization engine can improve heading hierarchy, metadata, image accessibility attributes, canonical references, semantic markup, internal linking opportunities, content structure, and other elements that contribute to better crawlability and maintainability.

The optimizer does not modify the visual design of the page. It focuses exclusively on SEO-related HTML improvements and metadata generation.

Endpoint

POST /api/html/optimize

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
html	Yes	Raw HTML content to optimize.
keyword	No	Primary SEO keyword or phrase.
language	No	Language code of the content.
generateMeta	No	Automatically generate SEO metadata when missing.
generateCanonical	No	Generate canonical tag recommendations.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "keyword": "seo software",
  "language": "en",
  "generateMeta": true,
  "generateCanonical": true,
  "html": "<html>...</html>"
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "seoScoreBefore": 74,
    "seoScoreAfter": 92,
    "changesApplied": 12,
    "optimizedHtml": "<html>...optimized content...</html>"
  }
}

Optimization Features

Feature	Description
Title Optimization	Improves title length and structure.
Meta Description Generation	Creates or improves page descriptions.
Heading Structure Analysis	Reviews H1-H6 hierarchy for consistency.
Image Accessibility	Adds recommendations for missing alt attributes.
Semantic HTML	Improves usage of semantic elements.
Canonical Recommendations	Generates canonical URL suggestions.
Internal Linking Review	Identifies linking opportunities.
Content Structure Review	Evaluates readability and content organization.

Response Fields

Field	Type	Description
seoScoreBefore	Integer	SEO score before optimization.
seoScoreAfter	Integer	Estimated SEO score after optimization.
changesApplied	Integer	Total number of improvements applied.
optimizedHtml	String	SEO-enhanced HTML document.

Common Use Cases

Automated SEO optimization pipelines.
CMS content publishing workflows.
Website migration projects.
Large-scale content auditing.
SEO quality assurance systems.
Agency reporting and optimization tools.

Metadata Generator

The Metadata Generator endpoint automatically creates search-engine-friendly metadata for webpages, articles, landing pages, product pages, and other web content. By analyzing the provided content and optional keyword targets, the service generates optimized title tags, meta descriptions, Open Graph tags, and other metadata commonly used by search engines and social media platforms.

Proper metadata helps search engines understand page content and can improve how webpages appear in search results. It also enhances content sharing on platforms such as Facebook, LinkedIn, X (Twitter), and messaging applications that rely on Open Graph metadata when displaying shared links.

This endpoint is particularly useful for content management systems, SEO automation tools, publishing platforms, e-commerce applications, website builders, and agencies that need to generate metadata at scale without requiring manual optimization for every page.

Generated metadata should be reviewed before publication to ensure accuracy and consistency with your content and brand guidelines.

Endpoint

POST /api/meta/generate

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
content	Yes	Page content used for metadata generation.
keyword	No	Primary keyword or target search phrase.
brandName	No	Company or website name to include in metadata.
pageType	No	Page type such as article, product, category, or homepage.
url	No	Page URL used when generating social metadata.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "keyword": "seo software",
  "brandName": "Velsent",
  "pageType": "article",
  "url": "https://example.com/article",
  "content": "SEO software helps website owners analyze and improve search engine visibility..."
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "title": "Professional SEO Software for Website Optimization",
    "metaDescription": "Analyze, optimize, and improve website visibility using professional SEO tools and automation.",
    "keywords": [
      "seo software",
      "website optimization",
      "seo analysis"
    ],
    "openGraph": {
      "og:title": "Professional SEO Software for Website Optimization",
      "og:description": "Analyze, optimize, and improve website visibility.",
      "og:type": "website"
    }
  }
}

Generated Metadata Types

Metadata Type	Description
Title Tag	Optimized page title for search engines and browsers.
Meta Description	Page summary displayed in search engine results.
Meta Keywords	Relevant keyword suggestions extracted from content.
Open Graph Tags	Metadata used when sharing content on social platforms.
Twitter Card Tags	Metadata for enhanced content previews on X (Twitter).
Canonical Recommendations	Suggested canonical URL references.

Response Fields

Field	Type	Description
title	String	Generated SEO title.
metaDescription	String	Generated page description.
keywords	Array	Relevant keyword suggestions.
openGraph	Object	Generated Open Graph metadata.

Generated HTML Example

<title>Professional SEO Software for Website Optimization</title>

<meta name="description"
      content="Analyze, optimize, and improve website visibility using professional SEO tools." />

<meta property="og:title"
      content="Professional SEO Software for Website Optimization" />

<meta property="og:description"
      content="Analyze, optimize, and improve website visibility." />

Common Use Cases

Automated metadata generation for CMS platforms.
SEO optimization for blog posts and articles.
E-commerce product page metadata creation.
Landing page optimization workflows.
Bulk content publishing systems.
Social media sharing optimization.
Large-scale SEO automation projects.

Content Optimizer

The Content Optimizer endpoint analyzes existing website content and provides an optimized version designed to improve readability, content structure, keyword relevance, and overall SEO quality. This service helps website owners, publishers, agencies, and developers enhance content without manually reviewing every paragraph.

The optimization engine evaluates the content's organization, heading hierarchy, paragraph distribution, keyword placement, sentence length, and overall readability. Based on these factors, it generates recommendations and an improved version of the content that is easier for both users and search engines to understand.

This endpoint is particularly useful when updating older content, publishing new articles, improving landing pages, or maintaining large content libraries. The service focuses on improving content quality while preserving the original meaning and intent of the text.

Content optimization recommendations are intended to improve content quality and readability. Final publishing decisions should always be reviewed by the content owner.

Endpoint

POST /api/content/optimize

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
content	Yes	Original content to optimize.
keyword	No	Primary keyword or topic.
language	No	Content language code.
targetLength	No	Preferred content length in words.
tone	No	Preferred writing tone such as professional, educational, or marketing.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "keyword": "seo software",
  "language": "en",
  "targetLength": 1200,
  "tone": "professional",
  "content": "SEO tools help websites improve search engine visibility..."
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "scoreBefore": 71,
    "scoreAfter": 93,
    "wordCountBefore": 845,
    "wordCountAfter": 1187,
    "optimizedContent": "Improved content...",
    "recommendations": [
      "Add more descriptive headings",
      "Increase topic coverage",
      "Improve keyword distribution"
    ]
  }
}

Optimization Areas

Feature	Description
Readability Analysis	Evaluates sentence complexity and content clarity.
Keyword Distribution	Reviews keyword placement throughout the content.
Content Structure	Analyzes headings, sections, and paragraph organization.
Topic Coverage	Identifies missing or underrepresented content areas.
Content Length Review	Evaluates content depth and completeness.
SEO Recommendations	Provides actionable suggestions for improvement.

Response Fields

Field	Type	Description
scoreBefore	Integer	Content quality score before optimization.
scoreAfter	Integer	Estimated score after optimization.
wordCountBefore	Integer	Original content word count.
wordCountAfter	Integer	Optimized content word count.
optimizedContent	String	SEO-enhanced content output.
recommendations	Array	Suggested improvements identified during analysis.

Example Optimized Output

Original Score: 71

Optimizations Applied:
- Improved heading hierarchy
- Expanded topic coverage
- Enhanced keyword placement
- Improved readability
- Added missing content sections

Estimated SEO Score: 93

Common Use Cases

Blog post optimization.
Landing page improvements.
Content refresh projects.
SEO content audits.
Knowledge base enhancement.
Large-scale publishing workflows.
Agency content management systems.

Keyword Extractor

The Keyword Extractor endpoint analyzes webpage content and automatically identifies the most relevant keywords, phrases, and topics found within the supplied text. This service is designed for website owners, content creators, SEO professionals, agencies, and developers who need fast access to important keyword data without manually reviewing large amounts of content.

The analysis engine examines keyword frequency, contextual relevance, phrase relationships, and topic coverage to determine which terms are most strongly associated with the content. The extracted keywords can be used for SEO planning, content optimization, metadata generation, competitor research, internal linking strategies, and content auditing workflows.

In addition to individual keywords, the service can identify multi-word phrases and topic clusters that help describe the overall subject matter of the content. This makes it easier to understand how search engines may interpret the page and whether important topics are adequately represented.

Extracted keywords are generated automatically from the supplied content and should be reviewed before being used in production SEO campaigns.

Endpoint

POST /api/content/keywords

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
content	Yes	Content to analyze.
language	No	Content language code.
maxKeywords	No	Maximum number of keywords to return.
includePhrases	No	Include multi-word keyword phrases.
includeTopics	No	Include detected topic clusters.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "language": "en",
  "maxKeywords": 20,
  "includePhrases": true,
  "includeTopics": true,
  "content": "SEO software helps businesses improve website visibility and analyze search engine performance..."
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "keywords": [
      "seo",
      "website",
      "optimization",
      "search engine",
      "visibility"
    ],
    "phrases": [
      "seo software",
      "search engine optimization",
      "website visibility"
    ],
    "topics": [
      "SEO",
      "Digital Marketing",
      "Content Optimization"
    ]
  }
}

Extraction Features

Feature	Description
Keyword Detection	Identifies the most relevant words within the content.
Phrase Extraction	Detects meaningful multi-word keyword combinations.
Topic Identification	Groups related keywords into broader content topics.
Frequency Analysis	Measures how often important terms appear.
Relevance Scoring	Ranks keywords based on contextual importance.
Content Classification	Determines the primary subject areas of the content.

Response Fields

Field	Type	Description
keywords	Array	Detected keywords ordered by relevance.
phrases	Array	Detected keyword phrases.
topics	Array	Identified content topics and categories.

Example Output

Top Keywords:
1. seo
2. website optimization
3. search engine
4. organic traffic
5. metadata

Primary Topic:
SEO Software

Secondary Topics:
Content Optimization
Website Analysis
Technical SEO

Common Use Cases

Keyword research and planning.
Content optimization workflows.
Metadata generation.
SEO audits and reporting.
Competitor content analysis.
Topic discovery and clustering.
Content management system integrations.

Structured Data Generator

The Structured Data Generator endpoint creates Schema.org compliant JSON-LD markup that can be embedded into webpages to help search engines better understand page content. Structured data provides additional context about entities, products, organizations, articles, FAQs, events, and other content types, allowing search engines to process information more efficiently.

This service automatically generates valid structured data based on the information provided in the request. The generated output follows widely adopted Schema.org standards and can be integrated directly into websites, content management systems, ecommerce platforms, and publishing workflows.

Proper structured data implementation may improve content discoverability, enable enhanced search result features, and provide richer content context for search engines. The service supports multiple schema types and can be incorporated into automated SEO pipelines.

Generated schema markup should accurately represent the content available on the target page. Incorrect or misleading structured data should not be used.

Endpoint

POST /api/schema/generate

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
type	Yes	Schema type to generate.
name	Yes	Name of the entity or content.
url	No	Associated page URL.
description	No	Description of the entity.
image	No	Representative image URL.

Supported Schema Types

Schema Type	Description
Organization	Business and organization information.
WebSite	Website-level structured data.
Article	News articles and blog posts.
FAQPage	Frequently asked questions pages.
Product	E-commerce product information.
BreadcrumbList	Website navigation breadcrumbs.
Service	Professional services and offerings.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "type": "Organization",
  "name": "Velsent",
  "url": "https://velsent.net",
  "description": "Professional SEO Software Platform"
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "schemaType": "Organization",
    "jsonLd": {
      "@context": "https://schema.org",
      "@type": "Organization",
      "name": "Velsent",
      "url": "https://velsent.net"
    }
  }
}

Generated JSON-LD Example

{
  "@context": "https://schema.org",
  "@type": "Organization",
  "name": "Velsent",
  "url": "https://velsent.net",
  "description": "Professional SEO Software Platform"
}

Response Fields

Field	Type	Description
schemaType	String	Generated schema category.
jsonLd	Object	Generated Schema.org JSON-LD markup.
validationStatus	String	Schema generation status.

Benefits

Automates structured data creation.
Reduces implementation complexity.
Supports multiple Schema.org types.
Provides machine-readable content descriptions.
Integrates easily with websites and CMS platforms.
Suitable for large-scale SEO automation workflows.

Common Use Cases

Website schema deployment.
Blog and article publishing systems.
E-commerce product markup generation.
FAQ page schema creation.
Agency SEO automation platforms.
Website builders and content management systems.
Technical SEO auditing and implementation.

Robots.txt Generator

The Robots.txt Generator endpoint creates standards-compliant robots.txt files that help search engines understand which areas of a website may be crawled and indexed. This service simplifies the creation of robots.txt directives and helps website owners manage crawler access without manually writing rules.

The generated robots.txt content can be customized for different search engine crawlers, restricted directories, sitemap locations, and indexing preferences. This endpoint is useful for developers, SEO professionals, agencies, content management systems, and website automation platforms that need to generate robots.txt files programmatically.

The service validates submitted rules and returns a properly formatted robots.txt file that can be published directly to the root of a website. It can also generate recommendations for common SEO configurations based on website type.

Incorrect robots.txt rules may prevent search engines from accessing important pages. Always review generated rules before deployment.

Endpoint

POST /api/robots/generate

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
websiteUrl	Yes	Website URL associated with the robots.txt file.
sitemapUrl	No	XML sitemap location to include.
disallowPaths	No	List of paths that should not be crawled.
allowPaths	No	List of paths explicitly allowed.
userAgent	No	Target crawler user agent. Default: *

Example Request

{
  "apikey": "YOUR_API_KEY",
  "websiteUrl": "https://example.com",
  "sitemapUrl": "https://example.com/sitemap.xml",
  "userAgent": "*",
  "disallowPaths": [
    "/admin/",
    "/private/"
  ]
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "robotsTxt": "User-agent: *\nDisallow: /admin/\nDisallow: /private/\nSitemap: https://example.com/sitemap.xml"
  }
}

Generated robots.txt Example

User-agent: *

Disallow: /admin/
Disallow: /private/
Disallow: /temp/

Allow: /

Sitemap: https://example.com/sitemap.xml

Supported Directives

Directive	Description
User-agent	Specifies which crawler the rules apply to.
Disallow	Prevents crawlers from accessing specific paths.
Allow	Permits crawler access to specific locations.
Sitemap	Provides the location of XML sitemaps.

Response Fields

Field	Type	Description
robotsTxt	String	Generated robots.txt file content.
validationStatus	String	Generation and validation result.
warnings	Array	Potential configuration concerns detected during generation.

Benefits

Automates robots.txt creation.
Reduces configuration mistakes.
Supports crawler-specific rules.
Simplifies sitemap integration.
Validates generated directives.
Suitable for large-scale website deployments.

Common Use Cases

New website launches.
SEO automation platforms.
CMS integrations.
Agency website management.
Website migration projects.
Automated sitemap deployments.
Technical SEO configuration audits.

Open Graph Generator

The Open Graph Generator endpoint creates complete Open Graph metadata for webpages, blog posts, product pages, landing pages, and other website content. Open Graph tags allow social media platforms and messaging applications to display rich previews when a URL is shared.

Without proper Open Graph tags, shared links may display incomplete titles, missing images, incorrect descriptions, or inconsistent branding. This service automatically generates standardized Open Graph metadata that can be embedded directly into the HTML head section of a webpage.

The generated output follows Open Graph protocol specifications and is suitable for websites, content management systems, ecommerce platforms, SEO automation tools, and social media optimization workflows.

In addition to standard Open Graph tags, the endpoint can also generate complementary Twitter Card metadata to improve link previews across multiple social platforms using a single API request.

For best results, ensure that the provided image URL is publicly accessible and uses a high-quality image suitable for social sharing previews.

Endpoint

POST /api/opengraph/generate

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
url	Yes	Canonical page URL.
title	Yes	Page title displayed in social previews.
description	Yes	Short description used in social cards.
image	Yes	Image URL displayed when the page is shared.
siteName	No	Website or brand name.
type	No	Open Graph type such as website, article, product, or profile.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "url": "https://example.com/blog/seo-guide",
  "title": "Complete SEO Guide for Beginners",
  "description": "Learn how to improve website visibility and search engine rankings.",
  "image": "https://example.com/images/seo-guide.jpg",
  "siteName": "Example",
  "type": "article"
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "openGraphTags": "<meta property='og:title' ... />",
    "twitterCardTags": "<meta name='twitter:card' ... />"
  }
}

Generated Open Graph Markup

<meta property="og:title"
      content="Complete SEO Guide for Beginners" />

<meta property="og:description"
      content="Learn how to improve website visibility and search engine rankings." />

<meta property="og:image"
      content="https://example.com/images/seo-guide.jpg" />

<meta property="og:url"
      content="https://example.com/blog/seo-guide" />

<meta property="og:type"
      content="article" />

<meta property="og:site_name"
      content="Example" />

Optional Twitter Card Output

<meta name="twitter:card"
      content="summary_large_image" />

<meta name="twitter:title"
      content="Complete SEO Guide for Beginners" />

<meta name="twitter:description"
      content="Learn how to improve website visibility and search engine rankings." />

<meta name="twitter:image"
      content="https://example.com/images/seo-guide.jpg" />

Supported Open Graph Types

Type	Description
website	General website pages.
article	Blog posts, news articles, and publications.
product	Ecommerce product pages.
profile	User and company profiles.
book	Books and publications.

Response Fields

Field	Type	Description
openGraphTags	String	Generated Open Graph HTML markup.
twitterCardTags	String	Generated Twitter Card metadata.
validationStatus	String	Generation and validation status.
warnings	Array	Potential issues identified during generation.

Benefits

Improves social media link previews.
Enhances content sharing experience.
Ensures consistent branding across platforms.
Supports Open Graph and Twitter Card standards.
Reduces manual metadata creation.
Suitable for SEO and social media automation.

Common Use Cases

Blog and article publishing systems.
Content management platforms.
SEO automation tools.
E-commerce product pages.
Landing page optimization.
Social media marketing campaigns.
Agency website management solutions.

Internal Link Suggestions

The Internal Link Suggestions endpoint analyzes webpage content and generates intelligent internal linking opportunities based on keywords, topics, semantic relevance, and page relationships. Internal linking is an essential component of technical SEO because it helps search engines discover content, distribute link equity, and better understand website structure.

This service evaluates the source page and compares it against a collection of target pages supplied by the client. The analysis engine identifies contextual linking opportunities, recommends anchor text variations, and determines which pages are the most relevant destinations for internal links.

The generated recommendations help improve website navigation, strengthen topical authority, increase content discoverability, and enhance the overall user experience. The service can be integrated into content management systems, SEO auditing platforms, publishing workflows, and automated optimization tools.

Suggestions are generated using content similarity, keyword relevance, semantic relationships, page importance signals, and contextual placement opportunities. This allows website owners to scale internal linking strategies across large websites without manual review.

Internal link recommendations should be reviewed before implementation to ensure they provide value to visitors and fit naturally within page content.

Endpoint

POST /api/internal-links/suggestions

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
sourceUrl	Yes	Page URL to analyze.
sourceContent	Yes	Content of the source page.
targetPages	Yes	Collection of pages eligible for internal linking.
maxSuggestions	No	Maximum number of recommendations to return.
includeAnchors	No	Generate suggested anchor texts.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "sourceUrl": "https://example.com/seo-guide",
  "maxSuggestions": 10,
  "includeAnchors": true,
  "targetPages": [
    {
      "url": "https://example.com/keyword-research",
      "title": "Keyword Research Guide"
    },
    {
      "url": "https://example.com/on-page-seo",
      "title": "On-Page SEO Techniques"
    }
  ]
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "totalSuggestions": 2,
    "suggestions": [
      {
        "anchorText": "keyword research",
        "targetUrl": "https://example.com/keyword-research",
        "relevanceScore": 97
      },
      {
        "anchorText": "on-page SEO",
        "targetUrl": "https://example.com/on-page-seo",
        "relevanceScore": 93
      }
    ]
  }
}

Suggested Output Example

{
  "anchorText": "technical SEO audit",
  "targetUrl": "https://example.com/technical-seo-audit",
  "position": "Paragraph 4",
  "relevanceScore": 95,
  "reason": "Strong topical similarity"
}

Analysis Features

Feature	Description
Topic Matching	Matches related pages using semantic analysis.
Anchor Generation	Suggests contextual anchor text variations.
Relevance Scoring	Ranks opportunities by topical similarity.
Content Mapping	Identifies relationships between pages.
Link Distribution	Helps improve internal link equity flow.
Placement Suggestions	Recommends optimal insertion locations.

Response Fields

Field	Type	Description
totalSuggestions	Integer	Total generated recommendations.
anchorText	String	Suggested anchor text.
targetUrl	String	Destination URL for the link.
relevanceScore	Integer	Relationship score between pages.
reason	String	Explanation of why the recommendation was generated.

Benefits

Strengthens website architecture.
Improves search engine crawlability.
Increases page discoverability.
Enhances topical authority.
Supports large-scale SEO automation.
Improves user navigation and engagement.
Reduces manual internal linking effort.

Common Use Cases

SEO audits and optimization projects.
Content publishing workflows.
Large website internal linking automation.
Blog and knowledge base management.
CMS integrations.
Agency reporting platforms.
Enterprise SEO solutions.

SEO Audit

The SEO Audit endpoint performs a comprehensive analysis of a webpage and identifies technical, on-page, content, metadata, performance, accessibility, and search engine optimization issues that may affect visibility in search results. This service is designed for website owners, agencies, developers, marketers, and SEO professionals who need actionable recommendations for improving website quality and search engine performance.

The audit engine crawls the specified page, evaluates critical SEO elements, validates metadata, analyzes heading structures, checks image optimization, reviews internal linking, identifies indexing issues, and measures overall optimization quality. Each finding is categorized by severity and accompanied by practical recommendations.

The generated report can be used for routine SEO monitoring, technical audits, client reporting, website migrations, content reviews, and automated quality assurance workflows. Results are returned in a structured format suitable for dashboards, reporting systems, and third-party integrations.

Every audit includes an overall SEO score together with categorized warnings, errors, opportunities, and optimization recommendations to help prioritize improvement efforts.

SEO Audit results are based on the analyzed page at the time of the request. Scores and recommendations may change when content, metadata, or technical configurations are updated.

Endpoint

POST /api/seo/audit

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
url	Yes	Page URL to audit.
checkPerformance	No	Include performance-related analysis.
checkImages	No	Analyze image optimization opportunities.
checkLinks	No	Evaluate internal and external links.
checkAccessibility	No	Include accessibility recommendations.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "url": "https://example.com",
  "checkPerformance": true,
  "checkImages": true,
  "checkLinks": true,
  "checkAccessibility": true
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "score": 88,
    "grade": "B",
    "errors": 2,
    "warnings": 5,
    "recommendations": 11
  }
}

Audit Categories

Category	Description
Metadata	Title, description, canonical tags, robots directives and Open Graph tags.
Headings	H1-H6 structure, hierarchy and content relevance.
Content	Content quality, readability and keyword coverage.
Images	Alt attributes, image sizes and optimization opportunities.
Links	Internal links, external links and broken links.
Technical SEO	Indexability, crawlability and technical configuration.
Performance	Page size, loading speed and optimization recommendations.
Accessibility	Basic accessibility checks and usability improvements.

Example Findings

{
  "severity": "Warning",
  "category": "Metadata",
  "title": "Meta Description Missing",
  "description": "The page does not contain a meta description tag.",
  "recommendation": "Add a unique description between 120 and 160 characters."
}

SEO Score Scale

Score	Grade	Assessment
90 - 100	A	Excellent optimization level.
80 - 89	B	Good optimization with minor issues.
70 - 79	C	Average optimization requiring improvements.
60 - 69	D	Significant optimization opportunities detected.
0 - 59	F	Critical issues affecting SEO performance.

Response Fields

Field	Type	Description
score	Integer	Overall SEO score.
grade	String	SEO rating grade.
errors	Array	Critical issues requiring immediate attention.
warnings	Array	Potential optimization issues.
recommendations	Array	Suggested improvements.
auditDate	DateTime	Audit generation timestamp.

Benefits

Comprehensive SEO health assessment.
Automated technical SEO auditing.
Prioritized optimization recommendations.
Performance and metadata validation.
Suitable for agencies and enterprise workflows.
Easy integration with reporting platforms.
Continuous website monitoring capabilities.

Common Use Cases

Website SEO audits.
Client reporting dashboards.
Technical SEO monitoring.
Content publishing validation.
Website migration reviews.
Agency automation platforms.
Enterprise SEO management systems.

Competitor Snapshot

The Competitor Snapshot endpoint provides a high-level SEO comparison between your website and one or more competing websites. The service analyzes publicly available page information and generates a concise report highlighting strengths, weaknesses, opportunities, and potential optimization areas.

This endpoint is designed for marketers, agencies, SEO professionals, content creators, and website owners who need a quick overview of competitor positioning without performing a full technical audit. The generated report helps identify content gaps, metadata differences, keyword opportunities, and technical SEO advantages that may influence search visibility.

The analysis includes page structure, metadata quality, content metrics, heading hierarchy, image optimization, keyword targeting, page size, internal linking indicators, and other publicly accessible SEO signals. Results can be used for competitive research, reporting dashboards, lead generation tools, and SEO strategy planning.

The endpoint returns both raw comparison data and summarized insights, allowing developers to build custom reports, dashboards, and automated monitoring systems.

Competitor Snapshot provides a comparative overview and should be used as a starting point for deeper SEO analysis and strategic planning.

Endpoint

POST /api/competitor/snapshot

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
websiteUrl	Yes	Your website URL.
competitorUrls	Yes	List of competitor URLs to compare against.
keyword	No	Target keyword used for contextual comparison.
includeContentAnalysis	No	Include content-based comparison metrics.
includeTechnicalMetrics	No	Include technical SEO comparison data.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "websiteUrl": "https://example.com",
  "competitorUrls": [
    "https://competitor1.com",
    "https://competitor2.com"
  ],
  "keyword": "seo software",
  "includeContentAnalysis": true,
  "includeTechnicalMetrics": true
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "yourScore": 87,
    "averageCompetitorScore": 81,
    "opportunities": 12,
    "strengths": 8,
    "weaknesses": 4
  }
}

Comparison Metrics

Metric	Description
SEO Score	Overall optimization quality score.
Title Quality	Comparison of title tag effectiveness.
Meta Description	Metadata completeness and optimization.
Content Length	Comparison of visible page content volume.
Heading Structure	Evaluation of heading hierarchy usage.
Image Optimization	Alt attributes and image SEO signals.
Page Size	HTML and resource footprint comparison.
Keyword Coverage	Keyword presence and topical relevance.

Example Competitor Summary

{
  "website": "example.com",
  "seoScore": 87,
  "strengths": [
    "Optimized title tag",
    "Strong heading structure",
    "Fast page size"
  ],
  "weaknesses": [
    "Missing Open Graph tags",
    "Limited internal linking"
  ]
}

Response Fields

Field	Type	Description
yourScore	Integer	Overall SEO score for your website.
competitorScore	Integer	SEO score for an individual competitor.
strengths	Array	Areas where the analyzed website performs well.
weaknesses	Array	Areas requiring improvement.
opportunities	Array	Potential optimization opportunities.
recommendations	Array	Actionable SEO suggestions.

Benefits

Quick competitor benchmarking.
Identifies content and SEO gaps.
Highlights competitive advantages.
Supports strategic SEO planning.
Provides actionable optimization insights.
Useful for agencies and consultants.
Easy integration into reporting dashboards.

Common Use Cases

Competitor research.
SEO campaign planning.
Client reporting platforms.
Lead generation tools.
Website benchmarking.
Market analysis workflows.
SEO monitoring dashboards.

Image SEO Analyzer

The Image SEO Analyzer endpoint evaluates all images found on a webpage and identifies optimization opportunities that may improve search engine visibility, page performance, accessibility, and user experience. Images often represent a significant portion of page weight and can directly impact page loading speed, Core Web Vitals metrics, and image search rankings.

This service scans image resources and validates critical SEO attributes such as alternative text, image dimensions, file sizes, image formats, lazy-loading configuration, responsive image implementation, filename quality, and indexing readiness. The analysis helps website owners discover images that may negatively affect page performance or miss valuable organic search opportunities.

The generated report provides detailed recommendations for each image together with an overall optimization score. Results can be integrated into SEO dashboards, automated audits, content management systems, quality assurance pipelines, and website monitoring solutions.

The endpoint is suitable for blogs, ecommerce stores, corporate websites, landing pages, news portals, and any platform where image optimization is important for organic visibility and performance.

Optimizing image metadata, dimensions, and file sizes can significantly improve page speed, accessibility compliance, and image search visibility.

Endpoint

POST /api/image-seo/analyze

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
url	Yes	Webpage URL to analyze.
checkPerformance	No	Analyze image performance metrics.
checkAccessibility	No	Validate accessibility-related attributes.
includeRecommendations	No	Include optimization recommendations.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "url": "https://example.com",
  "checkPerformance": true,
  "checkAccessibility": true,
  "includeRecommendations": true
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "score": 91,
    "imagesFound": 24,
    "optimizedImages": 19,
    "issuesFound": 5
  }
}

Analyzed Image Factors

Factor	Description
Alt Text	Checks for descriptive and meaningful alternative text.
Filename Quality	Validates SEO-friendly image filenames.
Image Size	Detects oversized image resources.
Dimensions	Evaluates image width and height attributes.
File Format	Reviews image format suitability and efficiency.
Lazy Loading	Checks implementation of lazy-loading techniques.
Responsive Images	Validates srcset and responsive image usage.
Accessibility	Evaluates compliance with accessibility best practices.

Example Image Analysis

{
  "imageUrl": "https://example.com/images/product.jpg",
  "altText": "",
  "fileSizeKb": 1820,
  "width": 2400,
  "height": 1600,
  "score": 62,
  "issues": [
    "Missing alt text",
    "Image file size is too large"
  ]
}

Image Score Scale

Score	Rating	Assessment
90 - 100	Excellent	Fully optimized image.
80 - 89	Good	Minor improvements recommended.
70 - 79	Average	Several optimization opportunities detected.
60 - 69	Poor	Requires significant improvements.
0 - 59	Critical	Major SEO and performance issues detected.

Response Fields

Field	Type	Description
score	Integer	Overall image SEO score.
imagesFound	Integer	Total number of images analyzed.
optimizedImages	Integer	Images meeting optimization standards.
issuesFound	Integer	Total detected issues.
recommendations	Array	Optimization recommendations.
images	Array	Detailed image analysis results.

Benefits

Improves image search visibility.
Enhances page loading performance.
Identifies oversized image resources.
Improves accessibility compliance.
Supports Core Web Vitals optimization.
Automates image SEO auditing.
Provides actionable recommendations.

Common Use Cases

Ecommerce product image optimization.
Website SEO audits.
Performance monitoring platforms.
Content management systems.
Accessibility reviews.
Agency reporting dashboards.
Automated quality assurance workflows.

Content Readability Analyzer

The Content Readability Analyzer endpoint evaluates written content and measures how easy it is for users to read, understand, and engage with. Readability is an important SEO and user experience factor because content that is easier to consume generally results in longer session durations, lower bounce rates, higher engagement, and improved conversion rates.

This service analyzes sentence structure, paragraph length, vocabulary complexity, passive voice usage, readability scores, heading distribution, content flow, and overall writing quality. The generated report helps writers, marketers, publishers, and SEO professionals identify areas that may reduce content effectiveness or create unnecessary reading difficulty.

The endpoint supports content quality assurance workflows, editorial review systems, content optimization tools, AI content pipelines, and SEO auditing platforms. Results include both numerical scoring and actionable recommendations that can be implemented immediately.

The analyzer can process articles, blog posts, landing pages, product descriptions, documentation, knowledge base content, and other forms of web content intended for human readers.

Readability improvements can increase user engagement while helping search engines better understand page content and topical relevance.

Endpoint

POST /api/content/readability

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
content	Yes	Content to analyze.
language	No	Content language code.
targetAudience	No	Intended audience type.
includeSuggestions	No	Include writing improvement recommendations.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "language": "en",
  "targetAudience": "general",
  "includeSuggestions": true,
  "content": "Search engine optimization is a process used to improve website visibility within search engine results pages."
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "readabilityScore": 86,
    "gradeLevel": "Easy",
    "wordCount": 1254,
    "sentenceCount": 61,
    "averageSentenceLength": 20.6
  }
}

Analyzed Factors

Factor	Description
Sentence Length	Measures average sentence complexity.
Paragraph Length	Identifies oversized content blocks.
Vocabulary Complexity	Evaluates word difficulty and readability.
Passive Voice	Detects excessive passive sentence usage.
Transition Words	Measures content flow and readability.
Heading Structure	Evaluates content organization.
Reading Difficulty	Calculates overall reading complexity.
Content Flow	Analyzes logical structure and progression.

Example Analysis Result

{
  "issue": "Long Sentences",
  "severity": "Warning",
  "affectedSentences": 12,
  "recommendation": "Break long sentences into shorter, easier-to-read segments."
}

Readability Score Scale

Score	Rating	Assessment
90 - 100	Excellent	Very easy to read and understand.
80 - 89	Good	Suitable for a broad audience.
70 - 79	Average	Moderately readable with minor issues.
60 - 69	Difficult	Requires simplification.
0 - 59	Very Difficult	Likely challenging for most readers.

Response Fields

Field	Type	Description
readabilityScore	Integer	Overall readability score.
gradeLevel	String	Estimated reading difficulty level.
wordCount	Integer	Total number of words analyzed.
sentenceCount	Integer	Total number of sentences.
averageSentenceLength	Decimal	Average words per sentence.
recommendations	Array	Suggested readability improvements.
issues	Array	Detected readability concerns.

Benefits

Improves user engagement and retention.
Enhances content quality and clarity.
Supports SEO content optimization.
Identifies readability bottlenecks.
Reduces content complexity.
Improves accessibility for wider audiences.
Automates editorial quality assurance.

Common Use Cases

SEO content optimization.
Blog and article publishing workflows.
Content quality audits.
Editorial review systems.
Landing page optimization.
AI-generated content validation.
Enterprise content management platforms.

Bulk URL Analyzer

The Bulk URL Analyzer endpoint allows clients to analyze multiple webpages within a single request. Instead of submitting individual SEO analysis jobs for each page, this service processes entire URL collections and generates a consolidated report containing technical SEO metrics, content quality indicators, metadata validation results, performance statistics, and optimization recommendations.

This endpoint is ideal for websites with dozens, hundreds, or even thousands of pages. Agencies, enterprise SEO teams, content publishers, ecommerce businesses, and website owners can use the service to identify large-scale optimization opportunities without manually auditing pages one by one.

Each submitted URL is analyzed independently and assigned its own SEO score, issue count, warning count, metadata status, content quality assessment, image optimization score, and technical SEO evaluation. Results are returned both individually and as aggregated statistics for the entire URL collection.

The Bulk URL Analyzer is commonly used for site-wide audits, migration projects, content reviews, quality assurance workflows, scheduled SEO monitoring, and large-scale reporting dashboards.

Large URL collections may be processed asynchronously. In such cases the API returns a job identifier that can be used to retrieve results later.

Endpoint

POST /api/bulk-url/analyze

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
urls	Yes	Collection of URLs to analyze.
maxPages	No	Maximum number of URLs to process.
includeImages	No	Analyze image SEO metrics.
includePerformance	No	Include page performance analysis.
includeContent	No	Include content quality evaluation.
includeRecommendations	No	Generate SEO recommendations.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "urls": [
    "https://example.com",
    "https://example.com/about",
    "https://example.com/contact",
    "https://example.com/blog/seo-guide"
  ],
  "includeImages": true,
  "includePerformance": true,
  "includeContent": true,
  "includeRecommendations": true
}

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "jobId": "bulk_7d42f1",
    "totalUrls": 4,
    "averageScore": 87,
    "errors": 8,
    "warnings": 23
  }
}

Per-URL Analysis Example

{
  "url": "https://example.com/about",
  "seoScore": 91,
  "titleStatus": "Valid",
  "descriptionStatus": "Valid",
  "headingStatus": "Valid",
  "imageIssues": 1,
  "performanceScore": 88,
  "warnings": 2,
  "errors": 0
}

Available Analysis Modules

Module	Description
Metadata Analysis	Validates title tags, descriptions, canonical tags and robots directives.
Content Analysis	Evaluates content quality, readability and keyword coverage.
Image Analysis	Reviews image optimization and accessibility attributes.
Technical SEO	Checks crawlability, indexability and technical issues.
Performance Analysis	Measures loading efficiency and page size metrics.
Link Analysis	Examines internal and external linking structures.
Structured Data	Validates schema markup implementation.

Aggregate Report Example

{
  "summary": {
    "totalPages": 250,
    "averageSeoScore": 84,
    "criticalIssues": 17,
    "warnings": 126,
    "optimizedPages": 188,
    "pagesNeedingAttention": 62
  }
}

Response Fields

Field	Type	Description
jobId	String	Unique identifier for the analysis job.
totalUrls	Integer	Total number of submitted URLs.
processedUrls	Integer	Total successfully analyzed URLs.
averageScore	Decimal	Average SEO score across all URLs.
results	Array	Detailed analysis for every URL.
summary	Object	Site-wide statistics and insights.
recommendations	Array	Consolidated SEO recommendations.

Benefits

Analyze hundreds or thousands of pages in a single request.
Generate site-wide SEO reports automatically.
Identify recurring SEO problems across large websites.
Reduce manual auditing effort.
Improve quality assurance workflows.
Monitor website health over time.
Support enterprise SEO operations.

Common Use Cases

Large-scale website audits.
SEO agency reporting platforms.
Enterprise SEO monitoring systems.
Content publishing quality control.
Website migration validation.
Ecommerce catalog optimization.
Scheduled technical SEO assessments.

Complete SEO Optimization Engine

Flagship API
This is the primary endpoint of the platform. It combines all SEO analysis, auditing, optimization, metadata generation, structured data generation, content enhancement, image optimization recommendations, internal linking suggestions, readability improvements, and technical SEO checks into a single request.

The Complete SEO Optimization Engine is designed for developers, agencies, website owners, content teams, SaaS platforms, and enterprise systems that require a fully optimized HTML page without manually calling multiple APIs.

After receiving a webpage URL or raw HTML document, the engine performs hundreds of SEO validations and optimization procedures. The service analyzes technical SEO, content quality, metadata quality, page structure, image optimization opportunities, schema markup, Open Graph tags, readability scores, internal linking opportunities, crawlability signals, indexing directives, and many additional ranking factors.

Once the analysis is completed, the engine automatically generates an optimized version of the HTML document. The returned HTML can be stored, published, rendered, or processed further by your applications.

Instead of manually using SEO Page Analysis, SEO Audit, Metadata Generator, Content Optimizer, Structured Data Generator, Open Graph Generator, Internal Link Suggestions, Image SEO Analyzer, Keyword Extractor, Content Readability Analyzer, and all other endpoints individually, this service executes them together and produces a unified optimized result.

Endpoint

POST /api/seo/optimize

Parameters

Parameter	Required	Description
apikey	Yes	Your API authentication key.
url	No	Target page URL for analysis and optimization.
html	No	Raw HTML source code.
keywords	No	Primary target keywords.
language	No	Content language code.
optimizeContent	No	Improve content structure and readability.
generateMetadata	No	Generate optimized SEO metadata.
generateSchema	No	Generate structured data markup.
generateOpenGraph	No	Generate Open Graph and social metadata.
optimizeImages	No	Analyze and optimize image SEO.
optimizeLinks	No	Generate internal linking suggestions.
returnHtml	No	Return fully optimized HTML output.

Example Request

{
  "apikey": "YOUR_API_KEY",
  "url": "https://example.com/article",
  "keywords": [
    "seo optimization",
    "technical seo",
    "content optimization"
  ],
  "language": "en",
  "optimizeContent": true,
  "generateMetadata": true,
  "generateSchema": true,
  "generateOpenGraph": true,
  "optimizeImages": true,
  "optimizeLinks": true,
  "returnHtml": true
}

Optimization Pipeline

Step	Description
SEO Audit	Detects technical SEO issues.
Metadata Analysis	Evaluates titles and descriptions.
Content Optimization	Improves content quality.
Keyword Optimization	Analyzes keyword usage.
Readability Optimization	Improves content readability.
Image SEO	Optimizes image attributes.
Structured Data	Generates schema markup.
Open Graph	Creates social sharing metadata.
Internal Linking	Suggests contextual links.
HTML Optimization	Generates final optimized HTML.

Example Response

{
  "success": true,
  "message": null,
  "data": {
    "optimizationScore": 96,
    "issuesFixed": 42,
    "warningsRemaining": 3,
    "optimizedHtml": "<!DOCTYPE html>..."
  }
}

Example Optimized HTML Output

<title>Professional SEO Optimization Guide</title>

<meta name="description"
      content="Learn how to optimize your website for search engines." />

<meta property="og:title"
      content="Professional SEO Optimization Guide" />

<script type="application/ld+json">
{
  "@context":"https://schema.org",
  "@type":"Article"
}
</script>

Response Fields

Field	Type	Description
optimizationScore	Integer	Overall optimization score.
issuesFixed	Integer	Total automatically resolved issues.
warningsRemaining	Integer	Issues requiring manual review.
optimizedHtml	String	Fully optimized HTML output.
metadata	Object	Generated SEO metadata.
schema	Object	Generated structured data.
recommendations	Array	Additional SEO recommendations.

Included Technologies

SEO Page Analysis
SEO HTML Optimizer
Metadata Generator
Content Optimizer
Keyword Extractor
Structured Data Generator
Robots.txt Generator
Open Graph Generator
Internal Link Suggestions
SEO Audit
Competitor Snapshot
Image SEO Analyzer
Content Readability Analyzer
Bulk URL Analyzer

Benefits

Single API call instead of multiple requests.
Complete SEO optimization workflow.
Automatically generated optimized HTML.
Enterprise-grade SEO auditing.
Consistent optimization standards.
Reduced development complexity.
Ideal for CMS, SaaS, and agency platforms.

Authentication

All API requests require a valid API Key. API keys can be generated from your account dashboard and must be included in every request.

X-API-KEY: YOUR_API_KEY

Base URL

All API endpoints documented on this page are relative to the following base URL:

https://velsent.net/api

For example, if an endpoint is documented as:

POST /seo/optimize

The full request URL becomes:

POST https://velsent.net/api/seo/optimize

All requests and responses use the JSON format and must be transmitted over HTTPS.

Support

Need help integrating our API? Contact our support team at:

support@velsent.net