Load S3 Agent (HTTP API)
The LCP data agent
About
s3-load-agent is a data agent built on top of HyperBEAM [email protected] temporal data storage device. This agent orchestrates the location of the data moving it from temporal to permanent (Arweave).
N.B: beta testing release, unstable and subject to breaking changes, use in testing enviroments only.
Agent API
GET
/: agent infoGET
/stats: storage statsGET
/:dataitem_id: generate a presigned get_object URL to access the ANS-104 DataItem data - DEPRECATED since v0.7.0 - usegateway.s3-node-1.load.network/resolve/$DATAITEM_IDinsteadGET
/tags/query: query dataitems for a given tags KV pairs.POST
/upload: post data (or signed dataitem) to store a public offchain DataItem on[email protected]POST
/upload/private: post data (or signed dataitem) to store a private offchain DataItem on[email protected]POST
/post/:dataitem_id: post an[email protected]public DataItem to Arweave via Turbo (N.B: Turbo covers any dataitem cost with size <= 100KB).
Upload data and return an agent public signed DataItem
echo -n "hello world" | curl -X POST https://load-s3-agent.load.network/upload \
-H "Authorization: Bearer $load_acc_api_key" \
-F "file=@-;type=text/plain" \
-F "content_type=text/plain"Or optionally add custom tags KVs that will be included in the ANS-104 DataItem construction
Optional: have the agent publish an offchain provenance record for the uploaded DataItem (the API returns the provenance transaction id in offchain_provenance_proof):
onchain provenance example: https://viewblock.io/arweave/tx/b6kTeJISHCmKTqaq_GK5g6hCGPWmMgfR7W4FcJwBwGU
offchain dataitem: https://gateway.s3-node-1.load.network/resolve/qvnTWVz4QqVAa7DsiiPER3HMArN88clg_SZc1BIS63s
Upload data and return an agent private signed DataItem
*** N.B: any private DataItem does not have the tags indexed nor is queryable ***
Upload signed dataitem to a private bucket (private dataitem)
Upload a signed DataItem and store it in Load S3
Tags are extracted from the ANS-104 DataItem, indexed and queryable
Post offchain DataItem to Arweave
example: for offchain dataitem = eoNAO-HlYasHJt3QFDuRrMVdLUxq5B8bXe4N_kboNWs
Querying DataItems by Tags
all dataitems pushed after agent's v0.6.0 release are queryable by the dataitem's tags KVs:
Pagination follows Arweave's GQL schema: optional
first(default 25, max 100) and a cursorafter.full_metadataflag (Optional<bool>) to return the full tags associated with a query's dataitemcreated_after/created_before(ISO-8601/RFC3339 strings) filter items by theircreated_attimestamp (inclusive bounds).
if page_info.has_next_page returns true, reuse the page_info.next_cursor string as the next after.
count reflects the number of items returned in the current page, while total_count includes every dataitem that matches the filters across all pages.
Load S3 Agent library
Adding load-s3-agent library
Example
Last updated