<commit_before>---
layout: page
title: JSON API
---

## Description

"JSON API" is a JSON-based read/write hypermedia-type designed to support
a smart client who wishes to build a data-store of information.

{% include status.md %}

## MIME Types

- [`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json)

## Format documentation

There are two JSON API styles:

* [The ID Style](/format#id-based-json-api)
* [The URL Style](/format#url-based-json-api)

The ID style is the easiest to get started with, but requires that your
clients be able to guess the URLs for related documents. It also locks
your API into a particular URL structure, which may become a problem as
your API grows.
<commit_msg>fix #135 - replace hypermedia-type with hypermedia media type<commit_after>---
layout: page
title: JSON API
---

## Description

"JSON API" is a JSON-based read/write hypermedia media type designed to support
a smart client who wishes to build a data-store of information.

{% include status.md %}

## MIME Types

- [`application/vnd.api+json`](http://www.iana.org/assignments/media-types/application/vnd.api+json)

## Format documentation

There are two JSON API styles:

* [The ID Style](/format#id-based-json-api)
* [The URL Style](/format#url-based-json-api)

The ID style is the easiest to get started with, but requires that your
clients be able to guess the URLs for related documents. It also locks
your API into a particular URL structure, which may become a problem as
your API grows.

{'fraction_non_alphanumeric': 0.10026041666666667, 'fraction_numerical': 0.001953125, 'mean_word_length': 4.157718120805369, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '840393', 'n_tokens_mistral': 456, 'n_tokens_neox': 443, 'n_words': 189}