APIs.json Schema

The JSON Schema definitions that underpin the APIs.json format. These schemas describe the structure of indexes, API entries, properties, and all the metadata needed to properly describe API contracts and operations.

AID
AID A unique identifier for the collection, consisting of [root domain]:[string] (ie. apis.json:spec-example).
View
APIs AID
APIs AID A unique identifier for the api, consisting of [root domain]:[string] (ie. apis.json:spec-api).
View
APIs Base Url
APIs Base Url Web URL corresponding to the root URL of the API or primary endpoint.
View
APIs Contact
APIs Contact An object to describe a person.
View
APIs Name
APIs Name Human readable text description of the API.
View
APIs Human Url
APIs Human Url Web URL corresponding to human readable information about the API.
View
APIs Name
APIs Name URL of an image which can be used as an "icon" for the API if displayed by a search engine.
View
APIs Name
APIs Name Name of the API.
View
APIs Overlays Type
APIs Overlays Type The type of overlay being made available.
View
APIs Overlays URL
APIs Overlays URL The URL for the overlay.
View
APIs Overlays
APIs Overlays An optional list of overlays to apply to individual APIs.
View
APIs Properties Data
APIs Properties Data The data for the property. * must be url or data.
View
APIs Properties Media Type
APIs Properties Media Type IANA media type representing the property.
View
APIs Properties Name
APIs Properties Name The display name of the property.
View
APIs Properties Type
APIs Properties Type Different properties of an API, see the list of APIs.json properties for a complete list.
View
APIs Properties URL
APIs Properties URL The URL for the property. * must be url or data.
View
APIs Properties
APIs Properties The human and machine-readable properties of an API.
View
APIs Tags
APIs Tags This is a list of descriptive strings which identify the API.
View
APIs Version
APIs Version String representing the version number of the API this description refers to.
View
APIs
APIs List of APIs identified in the file.
View
Common Media Type
Common Media Type IANA media type representing the property.
View
Common Name
Common Name The display name of the property.
View
Common Type
Common Type Please see reserved keywords below.
View
Common URL
Common URL The URL for the common property.
View
Common
Common A list of common properties for use across all APIs and tools.
View
Created
Created Date of creation of the file.
View
Description
Description Text human readable description of the collection of APIs.
View
Image
Image Web URL leading to an image to be used to represent the collection of APIs defined in this file.
View
Include Name
Include Name The name of the APIs.json file referenced.
View
Include URL
Include URL The URL of the APIs.json file referenced.
View
Include
Include Additional APIs.json to include with the index.
View
Kind
Kind Classifies the entity the APIs.json document is about, separately from the document `type`. Conventional lowercase values include `company`, `opensource`, `government`, `topic`, `standard`, `protocol`, and `non-profit`. Replaces the prior `x-type` / `xType` vendor extensions; new files should use `kind`.
View
Maintainers
Maintainers Who is responsible for maintaining an APIs.json.
View
Modified
Modified Date of last modification of the file.
View
Name
Name Text string of human readable name for the collection of APIs.
View
Networks Name
Networks Name The name of network being made available.
View
Networks URL
Networks URL The URL for the network search node.
View
Networks
Networks A list of other APIs.json search indexes to include for discovery.
View
Overlays Type
Overlays Type The type of overlay being made available.
View
Overlays URL
Overlays URL The URL for the overlay.
View
Overlays
Overlays An optional list of overlays to apply to primary APIs.json.
View
Prompts
Prompts An optional collection of AI prompts that apply to the whole index (top level) or to an individual API. Each entry uses the same shape as a property (type, url or data, name, description, tags), with a type such as `Prompt`, `AgentPrompt`, or `PromptTemplate`. Introduced in 0.21.
View
Rules
Rules An optional collection of governance rulesets that apply to the whole index (top level) or to an individual API. Each entry uses the same shape as a property (type, url or data, name, description, tags), with a type such as `SpectralRules`, `Rules`, or `GovernanceRules`. Introduced in 0.21.
View
Specification Version
Specification Version Version of the APIs.json specification in use.
View
Tags
Tags This is a list of descriptive strings which identify the contents of the APIs.json file. Represented as an array.
View
Type
Type The document kind of this APIs.json file. Canonical value is `Index` — an index of one or more APIs and their associated properties. Reserved values are `Index`, `Collection` (multiple APIs), and `Blueprint` (a template for a new API). Use the separate `kind` field to classify the entity the document is about (company, government, opensource, topic, standard, etc.).
View
URL
URL Web URL indicating the location of the latest version of this file.
View
Workflows
Workflows An optional collection of multi-step API workflows that apply to the whole index (top level) or to an individual API. Each entry uses the same shape as a property (type, url or data, name, description, tags), with a type such as `Arazzo`, `ServerlessWorkflow`, or `Workflow`. Introduced in 0.21.
View