Skip to main content
POST
Schema Markup Generator

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ioType
enum<string>

Schema type

Available options:
article,
breadcrumb,
event,
faq,
howto,
jobposting,
localbusiness,
organization,
person,
product,
recipe,
video,
website
ioArticleType
enum<string>

Article @type

Available options:
Article,
NewsArticle,
BlogPosting
ioHeadline
string

Headline

ioArticleUrl
string

Article URL

ioArticleDescription
string

Description

ioArticleImage
string

Image URLs

ioAuthorType
enum<string>

Author @type

Available options:
Person,
Organization
ioAuthorName
string

Author name

ioAuthorUrl
string

Author URL

ioPublisherName
string

Publisher name

Publisher logo URL

ioDateModified
string

Date modified

ioBreadcrumbs
string

Breadcrumb trail

ioEventName
string

Event name

ioEventDescription
string

Description

ioEventImage
string

Image URLs

ioEventStart
string

Start date & time

ioEventEnd
string

End date & time

ioEventStatus
enum<string>

Event status

Available options:
EventScheduled,
EventCancelled,
EventPostponed,
EventRescheduled,
EventMovedOnline
ioEventAttendance
enum<string>

Attendance mode

Available options:
OfflineEventAttendanceMode,
OnlineEventAttendanceMode,
MixedEventAttendanceMode
ioEventLocationName
string

Venue name

ioEventStreamUrl
string

Stream URL

ioPerformerType
enum<string>

Performer @type

Available options:
PerformingGroup,
Person
ioPerformerName
string

Performer name

ioOrganizerName
string

Organizer name

ioOrganizerUrl
string

Organizer URL

ioOfferValidFrom
string

Tickets on sale from

ioFaq
string

Questions and answers

ioHowToName
string

How-to title

ioHowToDescription
string

Description

ioHowToImage
string

Image URLs

ioHowToTime
string

Total time

ioHowToCost
number

Estimated cost

ioHowToSupplies
string

Supplies

ioHowToTools
string

Tools

ioHowToSteps
string

Steps

ioJobTitle
string

Job title

ioJobDescription
string

Job description

ioJobDatePosted
string

Date posted

ioJobValidThrough
string

Valid through

ioJobEmploymentType
enum<string>

Employment type

Available options:
FULL_TIME,
PART_TIME,
CONTRACTOR,
TEMPORARY,
INTERN,
VOLUNTEER,
PER_DIEM,
OTHER
ioJobCompanyName
string

Hiring organization

ioJobCompanyUrl
string

Organization URL

Organization logo URL

ioJobSalaryMin
number

Salary minimum

ioJobSalaryMax
number

Salary maximum

ioJobSalaryUnit
enum<string>

Salary per

Available options:
HOUR,
DAY,
WEEK,
MONTH,
YEAR
ioJobRemote
boolean

Remote (telecommute)

ioBusinessType
enum<string>

Business @type

Available options:
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
ioBusinessName
string

Business name

ioBusinessUrl
string

Website URL

ioBusinessImage
string

Image URLs

ioBusinessPhone
string

Telephone

ioBusinessPriceRange
string

Price range

ioLatitude
string

Latitude

ioLongitude
string

Longitude

ioOpeningHours
string

Opening hours

ioOrgType
enum<string>

Organization @type

Available options:
Organization,
Airline,
Consortium,
Corporation,
EducationalOrganization,
GovernmentOrganization,
LibrarySystem,
MedicalOrganization,
NGO,
NewsMediaOrganization,
PerformingGroup,
Project,
ResearchOrganization,
SportsOrganization
ioOrgName
string

Organization name

ioOrgAlternateName
string

Alternate name

ioOrgUrl
string

Website URL

Logo URL

ioOrgPhone
string

Contact telephone

ioOrgContactType
enum<string>

Contact type

Available options:
customer support,
technical support,
billing support,
sales,
reservations,
credit card support,
emergency
ioPersonName
string

Full name

ioPersonUrl
string

Profile or homepage URL

ioPersonImage
string

Photo URL

ioPersonJobTitle
string

Job title

ioPersonCompany
string

Works for

ioProductName
string

Product name

ioProductDescription
string

Description

ioProductImage
string

Image URLs

ioProductBrand
string

Brand

ioProductSku
string

SKU

ioProductGtin
string

GTIN

ioProductMpn
string

MPN

ioProductCondition
enum<string>

Item condition

Available options:
NewCondition,
UsedCondition,
RefurbishedCondition,
DamagedCondition
ioPriceValidUntil
string

Price valid until

ioRecipeName
string

Recipe name

ioRecipeDescription
string

Description

ioRecipeImage
string

Image URLs

ioRecipeAuthor
string

Author

ioPrepTime
string

Prep time

ioCookTime
string

Cook time

ioRecipeYield
string

Yield

ioRecipeCategory
string

Category

ioRecipeCuisine
string

Cuisine

ioRecipeCalories
number

Calories per serving

ioIngredients
string

Ingredients

ioInstructions
string

Instructions

ioVideoName
string

Video title

ioVideoDescription
string

Description

ioVideoThumbnail
string

Thumbnail URLs

ioVideoDuration
string

Duration

ioVideoContentUrl
string

Content URL

ioVideoEmbedUrl
string

Embed URL

ioSiteName
string

Site name

ioSiteAlternateName
string

Alternate name

ioSiteUrl
string

Site URL

ioSiteSearchUrl
string

Search URL prefix

ioDatePublished
string

Date published

ioStreet
string

Street address

ioCity
string

City / locality

ioRegion
string

State / province / region

ioPostalCode
string

Postal code

ioCountry
string

Country

ioOfferPrice
number

Price

ioCurrency
string

Currency

ioOfferAvailability
enum<string>

Availability

Available options:
InStock,
OutOfStock,
PreOrder,
BackOrder,
LimitedAvailability,
SoldOut,
Discontinued
ioOfferUrl
string

Offer URL

ioRatingValue
number

Rating value

ioReviewCount
number

Review count

ioSameAs
string

Social profiles

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.