> ## Documentation Index
> Fetch the complete documentation index at: https://iotools.cloud/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Schema Markup Generator

> Generate schema.org JSON-LD structured data for Article, FAQ, Product, Recipe, Event, Local Business, How-to, Job Posting and more — with a checklist of the properties Google needs for the rich result.

[Try Schema Markup Generator in your browser →](https://iotools.cloud/tool/schema-markup-generator/)



## OpenAPI

````yaml https://api.iotools.cloud/v1/openapi post /v1/tool/schema-markup-generator
openapi: 3.1.0
info:
  title: iotools.cloud API
  version: 1.0.0
  description: >-
    Run any iotools.cloud tool over HTTP.


    Authenticate with `Authorization: Bearer iot_live_…`.


    **Only `POST /v1/tool/{slug}` costs credits.** Every GET here — the catalog,
    a tool's schema, your balance — is free. A tool call is charged its own
    weight or your plan's per-call minimum, whichever is larger;
    `x-iotools-credit-cost` on each operation is quoted at the free-tier
    minimum, and `GET /v1/tools/list` returns the exact figure for your key.
    `GET /v1/me/credits` reports what you have left, and `GET /v1/me/usage`
    reports what it went on.


    Failures are RFC 9457 problem documents — branch on `code`.
servers:
  - url: https://api.iotools.cloud
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Catalog
    description: Find a tool and read its contract. Free.
  - name: Converters
    description: >-
      Convert between formats, encodings, and units — Base64, CSV and JSON,
      timestamps, and more. Fast, free, and processed right in your browser.
  - name: Formatters
    description: >-
      Format, beautify, minify, and validate code and data — JSON, HTML, CSS,
      SQL, and regex. Clean up messy input in one click, with nothing to upload.
  - name: Generators
    description: >-
      Generate exactly what you need and on demand — passwords, UUIDs, QR codes,
      hashes, random numbers, and more. Secure, instant, and free.
  - name: Calculators
    description: >-
      Crunch the numbers fast — from everyday math to specialized conversions
      and unit work. Free online calculators that run entirely in your browser.
  - name: Editors
    description: >-
      Edit and transform text, code, and images with quick, focused editors that
      run entirely in your browser — nothing to install, and no sign-up needed.
  - name: Utilities
    description: >-
      Everyday developer and web utilities — DNS and IP lookups, redirect and
      certificate checkers, and other quick diagnostics. Free and
      privacy-friendly.
  - name: Account
    description: Your key's allowance, limits and usage history.
paths:
  /v1/tool/schema-markup-generator:
    post:
      tags:
        - Generators
      summary: Schema Markup Generator
      description: >-
        Generate schema.org JSON-LD structured data for Article, FAQ, Product,
        Recipe, Event, Local Business, How-to, Job Posting and more — with a
        checklist of the properties Google needs for the rich result.


        [Try Schema Markup Generator in your browser
        →](https://iotools.cloud/tool/schema-markup-generator/)
      operationId: run_schema_markup_generator
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                ioType:
                  enum:
                    - article
                    - breadcrumb
                    - event
                    - faq
                    - howto
                    - jobposting
                    - localbusiness
                    - organization
                    - person
                    - product
                    - recipe
                    - video
                    - website
                  description: Schema type
                ioArticleType:
                  enum:
                    - Article
                    - NewsArticle
                    - BlogPosting
                  description: Article @type
                ioHeadline:
                  type: string
                  description: Headline
                ioArticleUrl:
                  type: string
                  description: Article URL
                ioArticleDescription:
                  type: string
                  description: Description
                ioArticleImage:
                  type: string
                  description: Image URLs
                ioAuthorType:
                  enum:
                    - Person
                    - Organization
                  description: Author @type
                ioAuthorName:
                  type: string
                  description: Author name
                ioAuthorUrl:
                  type: string
                  description: Author URL
                ioPublisherName:
                  type: string
                  description: Publisher name
                ioPublisherLogo:
                  type: string
                  description: Publisher logo URL
                ioDateModified:
                  type: string
                  description: Date modified
                ioBreadcrumbs:
                  type: string
                  description: Breadcrumb trail
                ioEventName:
                  type: string
                  description: Event name
                ioEventDescription:
                  type: string
                  description: Description
                ioEventImage:
                  type: string
                  description: Image URLs
                ioEventStart:
                  type: string
                  description: Start date & time
                ioEventEnd:
                  type: string
                  description: End date & time
                ioEventStatus:
                  enum:
                    - EventScheduled
                    - EventCancelled
                    - EventPostponed
                    - EventRescheduled
                    - EventMovedOnline
                  description: Event status
                ioEventAttendance:
                  enum:
                    - OfflineEventAttendanceMode
                    - OnlineEventAttendanceMode
                    - MixedEventAttendanceMode
                  description: Attendance mode
                ioEventLocationName:
                  type: string
                  description: Venue name
                ioEventStreamUrl:
                  type: string
                  description: Stream URL
                ioPerformerType:
                  enum:
                    - PerformingGroup
                    - Person
                  description: Performer @type
                ioPerformerName:
                  type: string
                  description: Performer name
                ioOrganizerName:
                  type: string
                  description: Organizer name
                ioOrganizerUrl:
                  type: string
                  description: Organizer URL
                ioOfferValidFrom:
                  type: string
                  description: Tickets on sale from
                ioFaq:
                  type: string
                  description: Questions and answers
                ioHowToName:
                  type: string
                  description: How-to title
                ioHowToDescription:
                  type: string
                  description: Description
                ioHowToImage:
                  type: string
                  description: Image URLs
                ioHowToTime:
                  type: string
                  description: Total time
                ioHowToCost:
                  type: number
                  description: Estimated cost
                ioHowToSupplies:
                  type: string
                  description: Supplies
                ioHowToTools:
                  type: string
                  description: Tools
                ioHowToSteps:
                  type: string
                  description: Steps
                ioJobTitle:
                  type: string
                  description: Job title
                ioJobDescription:
                  type: string
                  description: Job description
                ioJobDatePosted:
                  type: string
                  description: Date posted
                ioJobValidThrough:
                  type: string
                  description: Valid through
                ioJobEmploymentType:
                  enum:
                    - FULL_TIME
                    - PART_TIME
                    - CONTRACTOR
                    - TEMPORARY
                    - INTERN
                    - VOLUNTEER
                    - PER_DIEM
                    - OTHER
                  description: Employment type
                ioJobCompanyName:
                  type: string
                  description: Hiring organization
                ioJobCompanyUrl:
                  type: string
                  description: Organization URL
                ioJobCompanyLogo:
                  type: string
                  description: Organization logo URL
                ioJobSalaryMin:
                  type: number
                  description: Salary minimum
                ioJobSalaryMax:
                  type: number
                  description: Salary maximum
                ioJobSalaryUnit:
                  enum:
                    - HOUR
                    - DAY
                    - WEEK
                    - MONTH
                    - YEAR
                  description: Salary per
                ioJobRemote:
                  type: boolean
                  description: Remote (telecommute)
                ioBusinessType:
                  enum:
                    - LocalBusiness
                    - AccountingService
                    - AutoRepair
                    - Bakery
                    - BarOrPub
                    - BeautySalon
                    - CafeOrCoffeeShop
                    - ChildCare
                    - Dentist
                    - DryCleaningOrLaundry
                    - Electrician
                    - EmploymentAgency
                    - FinancialService
                    - Florist
                    - FoodEstablishment
                    - GeneralContractor
                    - HairSalon
                    - HealthClub
                    - HomeAndConstructionBusiness
                    - Hotel
                    - InsuranceAgency
                    - LegalService
                    - Locksmith
                    - MedicalBusiness
                    - MovingCompany
                    - Notary
                    - Optician
                    - Physician
                    - Plumber
                    - ProfessionalService
                    - RealEstateAgent
                    - Restaurant
                    - RoofingContractor
                    - SelfStorage
                    - ShoppingCenter
                    - SportsClub
                    - Store
                    - TravelAgency
                    - VeterinaryCare
                  description: Business @type
                ioBusinessName:
                  type: string
                  description: Business name
                ioBusinessUrl:
                  type: string
                  description: Website URL
                ioBusinessImage:
                  type: string
                  description: Image URLs
                ioBusinessPhone:
                  type: string
                  description: Telephone
                ioBusinessPriceRange:
                  type: string
                  description: Price range
                ioLatitude:
                  type: string
                  description: Latitude
                ioLongitude:
                  type: string
                  description: Longitude
                ioOpeningHours:
                  type: string
                  description: Opening hours
                ioOrgType:
                  enum:
                    - Organization
                    - Airline
                    - Consortium
                    - Corporation
                    - EducationalOrganization
                    - GovernmentOrganization
                    - LibrarySystem
                    - MedicalOrganization
                    - NGO
                    - NewsMediaOrganization
                    - PerformingGroup
                    - Project
                    - ResearchOrganization
                    - SportsOrganization
                  description: Organization @type
                ioOrgName:
                  type: string
                  description: Organization name
                ioOrgAlternateName:
                  type: string
                  description: Alternate name
                ioOrgUrl:
                  type: string
                  description: Website URL
                ioOrgLogo:
                  type: string
                  description: Logo URL
                ioOrgPhone:
                  type: string
                  description: Contact telephone
                ioOrgContactType:
                  enum:
                    - customer support
                    - technical support
                    - billing support
                    - sales
                    - reservations
                    - credit card support
                    - emergency
                  description: Contact type
                ioPersonName:
                  type: string
                  description: Full name
                ioPersonUrl:
                  type: string
                  description: Profile or homepage URL
                ioPersonImage:
                  type: string
                  description: Photo URL
                ioPersonJobTitle:
                  type: string
                  description: Job title
                ioPersonCompany:
                  type: string
                  description: Works for
                ioProductName:
                  type: string
                  description: Product name
                ioProductDescription:
                  type: string
                  description: Description
                ioProductImage:
                  type: string
                  description: Image URLs
                ioProductBrand:
                  type: string
                  description: Brand
                ioProductSku:
                  type: string
                  description: SKU
                ioProductGtin:
                  type: string
                  description: GTIN
                ioProductMpn:
                  type: string
                  description: MPN
                ioProductCondition:
                  enum:
                    - NewCondition
                    - UsedCondition
                    - RefurbishedCondition
                    - DamagedCondition
                  description: Item condition
                ioPriceValidUntil:
                  type: string
                  description: Price valid until
                ioRecipeName:
                  type: string
                  description: Recipe name
                ioRecipeDescription:
                  type: string
                  description: Description
                ioRecipeImage:
                  type: string
                  description: Image URLs
                ioRecipeAuthor:
                  type: string
                  description: Author
                ioPrepTime:
                  type: string
                  description: Prep time
                ioCookTime:
                  type: string
                  description: Cook time
                ioRecipeYield:
                  type: string
                  description: Yield
                ioRecipeCategory:
                  type: string
                  description: Category
                ioRecipeCuisine:
                  type: string
                  description: Cuisine
                ioRecipeCalories:
                  type: number
                  description: Calories per serving
                ioIngredients:
                  type: string
                  description: Ingredients
                ioInstructions:
                  type: string
                  description: Instructions
                ioVideoName:
                  type: string
                  description: Video title
                ioVideoDescription:
                  type: string
                  description: Description
                ioVideoThumbnail:
                  type: string
                  description: Thumbnail URLs
                ioVideoDuration:
                  type: string
                  description: Duration
                ioVideoContentUrl:
                  type: string
                  description: Content URL
                ioVideoEmbedUrl:
                  type: string
                  description: Embed URL
                ioSiteName:
                  type: string
                  description: Site name
                ioSiteAlternateName:
                  type: string
                  description: Alternate name
                ioSiteUrl:
                  type: string
                  description: Site URL
                ioSiteSearchUrl:
                  type: string
                  description: Search URL prefix
                ioDatePublished:
                  type: string
                  description: Date published
                ioStreet:
                  type: string
                  description: Street address
                ioCity:
                  type: string
                  description: City / locality
                ioRegion:
                  type: string
                  description: State / province / region
                ioPostalCode:
                  type: string
                  description: Postal code
                ioCountry:
                  type: string
                  description: Country
                ioOfferPrice:
                  type: number
                  description: Price
                ioCurrency:
                  type: string
                  description: Currency
                ioOfferAvailability:
                  enum:
                    - InStock
                    - OutOfStock
                    - PreOrder
                    - BackOrder
                    - LimitedAvailability
                    - SoldOut
                    - Discontinued
                  description: Availability
                ioOfferUrl:
                  type: string
                  description: Offer URL
                ioRatingValue:
                  type: number
                  description: Rating value
                ioReviewCount:
                  type: number
                  description: Review count
                ioSameAs:
                  type: string
                  description: Social profiles
              required: []
      responses:
        '200':
          description: Tool output
          content:
            application/json:
              schema:
                type: object
                required:
                  - tool
                  - tool_version
                  - outputs
                  - credits_used
                properties:
                  request_id:
                    type: string
                  tool:
                    type: string
                  tool_version:
                    type: string
                    description: >-
                      Output-contract version for this tool. Currently "1" for
                      all tools.
                  outputs:
                    type: object
                    properties:
                      ioScript:
                        type: string
                        description: JSON-LD script tag
                      ioChecks:
                        type: string
                        description: Google rich-result checklist
                      ioSchema:
                        type: string
                        description: JSON-LD
                  credits_used:
                    type: integer
                    description: >-
                      Credits this call consumed, after any settlement refund. 0
                      when metering is disabled.
                  credits_remaining:
                    type:
                      - integer
                      - 'null'
                    description: >-
                      Credits left in the current monthly allowance, or null
                      when metering is disabled.
        '400':
          description: Invalid request.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://iotools.cloud/docs/errors/validation_error
                title: Invalid request
                status: 400
                code: validation_error
                detail: One or more inputs are invalid — see `fields`.
                request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
        '401':
          description: Missing or invalid API key.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://iotools.cloud/docs/errors/invalid_api_key
                title: Invalid API key
                status: 401
                code: invalid_api_key
                detail: 'Provide ''Authorization: Bearer <key>''.'
                request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
        '402':
          description: Monthly credit allowance exhausted.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://iotools.cloud/docs/errors/insufficient_credits
                title: Insufficient credits
                status: 402
                code: insufficient_credits
                detail: >-
                  This call costs 1 credit and 0 remain in this month's
                  allowance.
                request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
        '403':
          description: Tool exists but has no API surface.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://iotools.cloud/docs/errors/tool_not_allowed
                title: Tool not available over the API
                status: 403
                code: tool_not_allowed
                detail: >-
                  "Background Remover" is available on iotools.cloud but has no
                  API endpoint.
                request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
        '404':
          description: No such tool.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://iotools.cloud/docs/errors/tool_not_found
                title: Tool not found
                status: 404
                code: tool_not_found
                detail: No tool with that slug. See GET /v1/tools.
                request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
        '413':
          description: Body too large.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://iotools.cloud/docs/errors/payload_too_large
                title: Payload too large
                status: 413
                code: payload_too_large
                detail: Request body exceeds this tool's size limit.
                request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
        '429':
          description: Per-minute rate limit exceeded.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://iotools.cloud/docs/errors/rate_limited
                title: Rate limit exceeded
                status: 429
                code: rate_limited
                detail: Too many requests. Retry in 30s.
                request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
        '500':
          description: Tool failed to run.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://iotools.cloud/docs/errors/processing_error
                title: Tool failed to run
                status: 500
                code: processing_error
                detail: The tool failed to run. Please try again.
                request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
        '503':
          description: Tool temporarily disabled.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://iotools.cloud/docs/errors/tool_disabled
                title: Tool temporarily disabled
                status: 503
                code: tool_disabled
                detail: This tool is temporarily unavailable. Try again shortly.
                request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11
      security:
        - bearerAuth: []
components:
  schemas:
    Problem:
      type: object
      description: >-
        RFC 9457 problem document, served as application/problem+json. Branch on
        `code`; `title` is human prose and may be reworded without notice.
      required:
        - type
        - title
        - status
        - code
      properties:
        type:
          type: string
          format: uri
          description: Stable documentation URI for this failure.
          examples:
            - https://iotools.cloud/docs/errors/invalid_api_key
            - https://iotools.cloud/docs/errors/api_unconfigured
            - https://iotools.cloud/docs/errors/validation_error
            - https://iotools.cloud/docs/errors/payload_too_large
            - https://iotools.cloud/docs/errors/tool_not_found
            - https://iotools.cloud/docs/errors/tool_not_allowed
            - https://iotools.cloud/docs/errors/tool_disabled
            - https://iotools.cloud/docs/errors/rate_limited
            - https://iotools.cloud/docs/errors/insufficient_credits
            - https://iotools.cloud/docs/errors/processing_error
            - https://iotools.cloud/docs/errors/internal_error
        title:
          type: string
          examples:
            - Invalid API key
            - API not configured
            - Invalid request
            - Payload too large
            - Tool not found
            - Tool not available over the API
            - Tool temporarily disabled
            - Rate limit exceeded
            - Insufficient credits
            - Tool failed to run
            - Internal error
        status:
          type: integer
        code:
          type: string
          enum:
            - invalid_api_key
            - api_unconfigured
            - validation_error
            - payload_too_large
            - tool_not_found
            - tool_not_allowed
            - tool_disabled
            - rate_limited
            - insufficient_credits
            - processing_error
            - internal_error
        detail:
          type: string
          description: Human explanation of this occurrence.
        request_id:
          type: string
          description: Correlation id, also sent as x-request-id.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: iot_live_…

````