inndx
GitHub

Artifacts

Read stored crawl artifacts and download their content.

An artifact is a stored output of a crawl, such as raw content, parsed data, or an asset. Each artifact is addressed by its ID.

These endpoints share the pagination and error conventions.

List artifacts

GET/v1/artifacts

Returns a page of stored artifacts.

Query parametersin: query
page
string

Pagination cursor. See pagination.

per_page
numberdefault: 10

Maximum number of artifacts to return.

min: 1max: 100
include_ids
string[]

Return only artifacts with these IDs.

format: uuid
exclude_ids
string[]

Omit artifacts with these IDs.

format: uuid
run_ids
string[]

Return only artifacts produced by these runs.

format: uuid
url_hashes
string[]

Return only artifacts for links with these hashes.

blob_keys
string[]

Return only artifacts with these blob keys.

kinds
string[]

Return only artifacts of these kinds.

rawparsedasset
pipeline_ids
string[]

Return only artifacts produced by these pipelines.

content_types
string[]

Return only artifacts with these MIME content types.

created_before
string

Return only artifacts created before this timestamp.

format: date-time
created_after
string

Return only artifacts created after this timestamp.

format: date-time
Responses

curl 'http://localhost:8022/v1/artifacts?per_page=20' \
  -H 'X-Tenant-Id: acme'

Get an artifact

GET/v1/artifacts/{artifact_id}

Returns the metadata for a single artifact by ID. The {artifact_id} path segment is the artifact's UUID.

Responses

curl 'http://localhost:8022/v1/artifacts/3f1a…' \
  -H 'X-Tenant-Id: acme'

Delete an artifact

DELETE/v1/artifacts/{artifact_id}

Deletes an artifact and its stored content.

Responses

curl -X DELETE 'http://localhost:8022/v1/artifacts/3f1a…' \
  -H 'X-Tenant-Id: acme'

Download an artifact's content

GET/v1/artifacts/{artifact_id}/blob

Downloads the artifact's binary content. Unlike the other endpoints, this responds with the raw artifact bytes rather than JSON, and sets the Content-Type header to the artifact's own content type.

Responses

curl 'http://localhost:8022/v1/artifacts/3f1a…/blob' \
  -H 'X-Tenant-Id: acme' \
  -o artifact.bin

Search docs

Search the Self-host documentation