Delete a document

DELETE

/api/v1/documents

const url = 'http://localhost:11044/api/v1/documents?uri=example';
const options = {method: 'DELETE', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url 'http://localhost:11044/api/v1/documents?uri=example' \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Delete a document by its URI.

Authorizations

apiKeyAuth
basicAuth

Parameters

Query Parameters

uri

required

string

The document URI, as returned by list or ingest

Responses

200

Document deleted

*/*

object

key

additional properties

string

404

Document not found

*/*

A delete that found no document at that URI in the caller’s world

object

status

required

Always not_found

string

Example

not_found

uri

required

The URI asked for, echoed back unchanged

string