Sign in
Raw Search

Retrieve a raw entry part

Fetch the textual content for a specific raw entry block. If the block is not unlocked, the content is censored unless auto_unlock=true succeeds.

Query parameters

  • container_id: Required container identifier.
  • entry_path: Path of the entry inside the container.
  • seq: Block sequence number (0-based).
  • trim_overlap: When true, drop the overlapping prefix shared with the previous block.
  • overlap_chars: Number of characters to trim when trim_overlap=true (default from configuration).
  • auto_unlock: Attempt to unlock the block using points when necessary.

Response Returns PartResponse describing the block and its (possibly censored) content.

get/search/raw/part

Query parameters

container_idinteger required

Container identifier.

Container identifier.

entry_pathstring required

Path of the entry inside the container.

Path of the entry inside the container.

seqinteger required

Block sequence number (0-based).

Block sequence number (0-based).

trim_overlapboolean

Drop the overlapping prefix shared with the previous block.

Drop the overlapping prefix shared with the previous block.

overlap_charsinteger

Characters to trim when trim_overlap=true.

Characters to trim when trim_overlap=true.

auto_unlockboolean

Attempt to unlock the block using points when necessary.

Attempt to unlock the block using points when necessary.

Response

Block returned successfully (content censored unless unlocked).

container_idstring required

Identifier of the container that owns the part.

entry_pathstring required

Entry path that contains the part.

seqinteger required

Sequential part number requested.

offsetinteger required

Byte offset of the part inside the entry.

size_bytesinteger nullable

Size of the returned block in bytes, if available.

ingested_atstring nullable

ISO timestamp of the ingestion time for the block.

trim_overlapboolean required

True if the overlapping prefix was trimmed from the returned content.

overlap_charsinteger required

Number of characters trimmed from the start when trim_overlap=true.

textstring required

Text content of the block. May be censored.

censoredboolean required

True if the user has not unlocked the content and it was redacted.

Changes

No recorded changes to this endpoint across all 1 revision of this API.