v3

latestOpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Storage/Key-value stores

Get record

Gets a value stored in the key-value store under a specific key.

The response body has the same Content-Encoding header as it was set in Put record.

If the request does not define the Accept-Encoding HTTP header with the right encoding, the record will be decompressed.

Most HTTP clients support decompression by default. After using the HTTP client with decompression support, the Accept-Encoding header is set by the client and body is decompressed automatically.

Please note that for security reasons, Apify API can perform small modifications to HTML documents before they are served via this endpoint. To fetch the raw HTML content without any modifications, use the attachment query parameter.

get/v2/key-value-stores/{storeId}/records/{recordKey}

Path parameters

storeIdstring required
Example:WkzbQMuFYuamGv3YF

Key-value store ID or username~store-name.

recordKeystring required
Example:someKey

Key of the record.

Query parameters

attachmentboolean
Example:true

If true or 1, the response will be served with Content-Disposition: attachment header, causing web browsers to offer downloading HTML records instead of displaying them.

signaturestring
Example:2wTI46Bg8qWQrV7tavlPI

Signature used for the access.

Response

RecordResponse required

The response body contains the value of the record. The content type of the response is determined by the Content-Type header stored with the record.

Example response

{
  "message": "Hello, world!",
  "count": 42
}