Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
type
enum<string>

Schema type

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

Article @type

Available options:
Article,
NewsArticle,
BlogPosting
headline
string

Headline

articleUrl
string

Article URL

articleDescription
string

Description

articleImage
string

Image URLs

authorType
enum<string>

Author @type

Available options:
Person,
Organization
authorName
string

Author name

authorUrl
string

Author URL

publisherName
string

Publisher name

Publisher logo URL

dateModified
string

Date modified

breadcrumbs
string

Breadcrumb trail

eventName
string

Event name

eventDescription
string

Description

eventImage
string

Image URLs

eventStart
string

Start date & time

eventEnd
string

End date & time

eventStatus
enum<string>

Event status

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

Attendance mode

Available options:
OfflineEventAttendanceMode,
OnlineEventAttendanceMode,
MixedEventAttendanceMode
eventLocationName
string

Venue name

eventStreamUrl
string

Stream URL

performerType
enum<string>

Performer @type

Available options:
PerformingGroup,
Person
performerName
string

Performer name

organizerName
string

Organizer name

organizerUrl
string

Organizer URL

offerValidFrom
string

Tickets on sale from

faq
string

Questions and answers

howToName
string

How-to title

howToDescription
string

Description

howToImage
string

Image URLs

howToTime
string

Total time

howToCost
number

Estimated cost

howToSupplies
string

Supplies

howToTools
string

Tools

howToSteps
string

Steps

jobTitle
string

Job title

jobDescription
string

Job description

jobDatePosted
string

Date posted

jobValidThrough
string

Valid through

jobEmploymentType
enum<string>

Employment type

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

Hiring organization

jobCompanyUrl
string

Organization URL

Organization logo URL

jobSalaryMin
number

Salary minimum

jobSalaryMax
number

Salary maximum

jobSalaryUnit
enum<string>

Salary per

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

Remote (telecommute)

businessType
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
businessName
string

Business name

businessUrl
string

Website URL

businessImage
string

Image URLs

businessPhone
string

Telephone

businessPriceRange
string

Price range

latitude
string

Latitude

longitude
string

Longitude

openingHours
string

Opening hours

orgType
enum<string>

Organization @type

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

Organization name

orgAlternateName
string

Alternate name

orgUrl
string

Website URL

Logo URL

orgPhone
string

Contact telephone

orgContactType
enum<string>

Contact type

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

Full name

personUrl
string

Profile or homepage URL

personImage
string

Photo URL

personJobTitle
string

Job title

personCompany
string

Works for

productName
string

Product name

productDescription
string

Description

productImage
string

Image URLs

productBrand
string

Brand

productSku
string

SKU

productGtin
string

GTIN

productMpn
string

MPN

productCondition
enum<string>

Item condition

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

Price valid until

recipeName
string

Recipe name

recipeDescription
string

Description

recipeImage
string

Image URLs

recipeAuthor
string

Author

prepTime
string

Prep time

cookTime
string

Cook time

recipeYield
string

Yield

recipeCategory
string

Category

recipeCuisine
string

Cuisine

recipeCalories
number

Calories per serving

ingredients
string

Ingredients

instructions
string

Instructions

videoName
string

Video title

videoDescription
string

Description

videoThumbnail
string

Thumbnail URLs

videoDuration
string

Duration

videoContentUrl
string

Content URL

videoEmbedUrl
string

Embed URL

siteName
string

Site name

siteAlternateName
string

Alternate name

siteUrl
string

Site URL

siteSearchUrl
string

Search URL prefix

datePublished
string

Date published

street
string

Street address

city
string

City / locality

region
string

State / province / region

postalCode
string

Postal code

country
string

Country

offerPrice
number

Price

currency
string

Currency

offerAvailability
enum<string>

Availability

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

Offer URL

ratingValue
number

Rating value

reviewCount
number

Review count

sameAs
string

Social profiles

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

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

credits_remaining
integer | null
required

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

request_id
string

Correlation id, also sent as x-request-id.