Structured Data & Schema Markup for AI — API products

{
  "@context": "https://schema.org",
  "@type": "APIProduct",
  "name": "[API Product Name]",
  "description": "[Concise, feature-rich description of the API]",
  "url": "[URL to API documentation/landing page]",
  "operatingSystem": "Cloud/Web",
  "applicationCategory": "DeveloperApplication",
  "offers": {
    "@type": "Offer",
    "price": "[Pricing Tier - e.g., 'Free Tier', 'Usage-Based']",
    "priceCurrency": "USD",
    "validFrom": "[YYYY-MM-DD]"
  },
  "aggregateRating": {
    "@type": "AggregateRating",
    "ratingValue": "4.7",
    "reviewCount": "950"
  }
}

{
  "@context": "https://schema.org",
  "@type": "Product",
  "name": "[API Plan Name] - [Specific Endpoint Group]",
  "description": "Detailed breakdown of features and usage limits for the [Specific Endpoint Group] plan.",
  "offers": {
    "@type": "AggregateOffer",
    "lowPrice": "0.01",
    "highPrice": "100",
    "priceCurrency": "USD",
    "offerCount": "5",
    "itemOffered": {
      "@type": "Service",
      "serviceType": "API Access",
      "provider": "[Your Company Name]"
    }
  }
}

{
  "@context": "https://schema.org",
  "@type": "FAQPage",
  "mainEntity": [{
    "@type": "Question",
    "name": "What is the rate limit for the [Specific API Endpoint] endpoint?",
    "acceptedAnswer": {
      "@type": "Answer",
      "text": "The [Specific API Endpoint] endpoint has a rate limit of [Number] requests per minute per API key. Exceeding this limit will result in a 429 Too Many Requests error. Refer to our [Rate Limiting Documentation Link] for advanced strategies."
    }
  }, {
    "@type": "Question",
    "name": "How do I authenticate with the [API Product Name] API?",
    "acceptedAnswer": {
      "@type": "Answer",
      "text": "Authentication for the [API Product Name] API is handled via OAuth 2.0. You will need to obtain an API key from your developer dashboard and include it in the 'Authorization' header of your requests. Detailed steps are available in our [Authentication Guide Link]."
    }
  }]
}

{
  "@context": "https://schema.org",
  "@type": "BreadcrumbList",
  "itemListElement": [{
    "@type": "ListItem",
    "position": 1,
    "name": "API Documentation",
    "item": "https://docs.example.com/"
  }, {
    "@type": "ListItem",
    "position": 2,
    "name": "[API Category - e.g., Payments API]",
    "item": "https://docs.example.com/payments"
  }, {
    "@type": "ListItem",
    "position": 3,
    "name": "[Specific Endpoint - e.g., Create Charge Endpoint]",
    "item": "https://docs.example.com/payments/create-charge"
  }]
}

{
  "@context": "https://schema.org",
  "@type": "APIReference",
  "name": "[API Product Name] - [Specific Endpoint]",
  "description": "Documentation and performance metrics for the [Specific Endpoint] API call.",
  "aggregateRating": {
    "@type": "AggregateRating",
    "ratingValue": "4.9",
    "reviewCount": "720",
    "bestRating": "5"
  }
}

{
  "@context": "https://schema.org",
  "@type": "HowTo",
  "name": "How to integrate [Feature] using the [API Product Name] API",
  "step": [
    {
      "@type": "HowToStep",
      "text": "Step 1: Obtain your API key from the developer portal.",
      "url": "https://docs.example.com/getting-started#step1"
    },
    {
      "@type": "HowToStep",
      "text": "Step 2: Make a POST request to the [Specific Endpoint] endpoint with your authentication token.",
      "url": "https://docs.example.com/payments/create-charge#step2"
    },
    {
      "@type": "HowToStep",
      "text": "Step 3: Parse the JSON response to extract the [Key Data Point].",
      "url": "https://docs.example.com/payments/create-charge#step3"
    }
  ]
}

{
  "@context": "https://schema.org",
  "@type": "APIReference",
  "name": "[API Endpoint Documentation Title]",
  "author": {
    "@type": "Person",
    "name": "[Lead Developer Name]",
    "jobTitle": "Senior API Engineer at [Your Company]",
    "sameAs": ["[Developer's LinkedIn/GitHub URL]"]
  },
  "publisher": {
    "@type": "Organization",
    "name": "[Your Company Name]",
    "logo": "[Your Company Logo URL]"
  }
}

{
  "@context": "https://schema.org",
  "@type": "Dataset",
  "name": "[API Product Name] - Monthly Usage Statistics",
  "description": "Aggregated, anonymized usage data for the [API Product Name] API, including call volume by endpoint and average response times.",
  "keywords": "API usage, performance metrics, developer analytics, [API Category]",
  "creator": {
    "@type": "Organization",
    "name": "[Your Company Name]"
  },
  "distribution": {
    "@type": "DataDownload",
    "contentUrl": "[URL to CSV/JSON dataset]",
    "encodingFormat": "text/csv"
  }
}

{
  "@context": "https://schema.org",
  "@type": "Organization",
  "name": "[Your Company Name]",
  "url": "https://www.example.com",
  "logo": "https://www.example.com/logo.png",
  "sameAs": [
    "https://twitter.com/[YourTwitterHandle]",
    "https://linkedin.com/company/[YourLinkedInHandle]",
    "https://github.com/[YourGitHubOrg]"
  ],
  "api": {
    "@type": "APIReference",
    "name": "[API Product Name]",
    "url": "[URL to main API product page]"
  }
}

{
  "@context": "https://schema.org",
  "@type": "WebPage",
  "name": "[API Endpoint Documentation Title]",
  "speakable": {
    "@type": "SpeakableSpecification",
    "xpath": [
      "/html/body/div[@class='api-docs']//h1",
      "/html/body/div[@class='api-docs']//p[@class='endpoint-description']",
      "/html/body/div[@class='api-docs']//h2[contains(text(), 'Request Parameters')]",
      "/html/body/div[@class='api-docs']//pre[@class='code-example']"
    ]
  }
}