API docs by Redocly

Enhancely API (1.0.0)

Download OpenAPI specification:

jsonld

Endpoints dealing with JSON-LD generation and retrieval.

Retrieve the list of JSON-LD URLs

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "code": "string"
}

Create and retrieve JSON-LD for a page

Accept a page URL and return JSON-LD.

  • 201: new JSON-LD was created (didn't exist before).
  • 200: existing JSON-LD returned.
  • 415 returned if Content-Type is not supported.
Authorizations:
BearerAuth
Request Body schema: application/json
required

JSON body with the URL to generate JSON-LD for.

url
required
string <uri>

The target page URL to generate JSON-LD for. Example: https://example.com/blog/automatic-jsonld-with-enhancely.

Responses

Request samples

Content type
application/json
[]

Response samples

Content type
{ }

Retrieve a JSON-LD entry by ID

Returns the JSON-LD document for a previously crawled URL, identified by its MD5 (lowercase hex) of the URL. Supports conditional GETs via If-None-Match and returns 304 Not Modified when appropriate.

Authorizations:
BearerAuth
path Parameters
id
required
string^[a-f0-9]{32}$

MD5 of the absolute URL (32 lowercase hexadecimal characters). Example: 7c165c13f93d7ca168bcfbd73cf563e3.

header Parameters
If-None-Match
string

Conditional request. Return 304 Not Modified if the supplied ETag matches the current resource ETag.

Responses

Response samples

Content type
application/json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "code": "string"
}