Skip to main content
Archive.org logo
  • Category: content & files
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 26
  • Triggers: 0
  • Slug: ARCHIVE_ORG
  • Version: 20261101_00

Tools

Slug: ARCHIVE_ORG_ADVANCED_SEARCH_ITEMSSearch Archive.org metadata with exact Advanced Search page semantics. Use Search Archive.org Items instead when cursor-based deep paging is needed.

Input Parameters

integer
One-based page number. Sorted searches must remain within the first 10,000 results; unsorted searches may page deeper.
integer
Number of items to return on this page (1-100).
array
Sort expressions accepted by Archive.org, in priority order.
string
required
Lucene-style Archive.org metadata query.
array
Metadata fields to return. The identifier field is always included so results can be used with item tools.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_CHECK_IDENTIFIER_AVAILABILITYCheck whether an Archive.org item identifier is available before attempting to create an item.

Input Parameters

string
required
Proposed Archive.org item identifier to check.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_CHECK_UPLOAD_LIMITCheck whether Archive.org’s ingest queue is likely to accept an upload or delete, using only the connection’s LOW Authorization header.

Input Parameters

string
Optional Archive.org item identifier for a bucket-specific upload preflight. Omit it for the connected account’s general state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_COPY_ITEM_FILECopy one Archive.org file server-side to a named path in an existing destination item. This creates the destination file when absent and overwrites it when present while preserving the prior destination under history/files. The source remains unchanged. This action never queues derivation; use DERIVE_ITEM for that separate irreversible effect. Catalog visibility may lag after IA-S3 accepts the copy.

Input Parameters

string
required
Exact source filename, optionally including nested path segments.
string
required
Archive.org item identifier containing the source file.
string
required
Destination filename, optionally including nested path segments. An existing file at this path is overwritten.
string
required
Existing Archive.org item identifier that will receive the copied file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_DELETE_ITEM_FILESubmit asynchronous deletion of one named file from an Archive.org item through IA-S3. An accepted response does not verify file absence; read item metadata later to verify it. This action cannot delete an item/bucket. Cascade deletion is disabled by default and must be explicitly enabled.

Input Parameters

boolean
Also delete originals and derivatives related to this file. Defaults to false; set true only when that broader destructive effect is intended.
string
required
Exact file to delete, optionally including nested path segments. A filename is required; deleting an item/bucket is not supported.
string
required
Archive.org item identifier containing the file.
boolean
Keep the deleted file under history/files instead of discarding its old version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_DELETE_MY_REVIEWPermanently delete the connected Archive.org user’s public review from one item. Archive.org queues the deletion and rejects the request if no such review exists.

Input Parameters

string
required
Archive.org item identifier whose connected-user review will be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_DERIVE_ITEMQueue Archive.org’s fixed derive.php task for an item owned or editable by the connected account. The task transforms source content into derived files asynchronously and may replace prior derivatives; this action never requests the untested remove_derived option.

Input Parameters

integer
Optional derive.php task priority from -10 to 10; default is 0.
string
required
Archive.org item identifier. The connected account must own the item or have permission to edit it.
integer
Send 1 to let Archive.org queue at a reduced priority instead of rate limiting when possible; send null to omit the header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_DOWNLOAD_ITEM_FILEDownload a public Archive.org item file or a bounded byte range and return a temporary downloadable file reference. Downloads are limited to 10 MiB.

Input Parameters

string
required
Exact file name from Get Item Metadata’s files list, including any nested path and extension.
string
Optional single HTTP byte range, such as ‘bytes=0-1023’, or ‘bytes=-1024’. The range must be bounded to at most 10 MiB; open-ended and multiple ranges are rejected.
string
required
Archive.org item identifier containing the file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_FIND_WAYBACK_SNAPSHOTSFind the closest archived Wayback Machine snapshot for each requested URL, using one before, after, or either direction for the batch.

Input Parameters

string ("either" | "before" | "after")
Direction applied to every URL in this batch: nearest capture on either side of its timestamp, only before, or only after.
number
Maximum seconds Archive.org should wait for its underlying CDX lookup; omit to use the documented five-second provider default.
array
required
URLs to check; each entry may specify its own timestamp preference and correlation tag.
array
Recorded HTTP statuses eligible for every result in the batch. Values are sent as the documented repeated status_code query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_GET_CONNECTED_USERReturn the authenticated Archive.org user’s identity and privileges without returning either IA-S3 credential.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_GET_DETAILED_VIEWSGet bounded geographic view analytics and, for items, top referrers over a recent window or date range. Collections support both timeframes; contributors support date ranges only and do not include referrers.

Input Parameters

string
required
Collection/item identifier or exact contributor value.
string
Exclusive ISO end date for range mode; range may span at most 31 days.
string ("recent" | "range")
required
Use recent for a last-N-days collection/item query or range for dates.
string
Inclusive ISO start date for range mode.
integer
Recent day count (1-31); valid only for collection or item subjects.
string ("collection" | "item" | "contributor")
required
Analytics subject: an Archive.org collection, item, or contributor.
integer
Maximum highest-score referrers to return for an item (0-100); collection and contributor analytics do not provide referrers.
integer
Maximum highest-count geographic bins to return (1-200).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_GET_IIIF_IMAGE_INFOGet normalized IIIF Image API capabilities through Archive.org’s fixed-host single-image convenience route or a live-proven versioned file route.

Input Parameters

string
Exact image filename. Omit to use Archive.org’s convenience route for a single-image item.
string
required
Archive.org item identifier containing the image.
integer ("2" | "3")
Live Image API route version; required with filename and otherwise omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_GET_IIIF_MANIFESTGet a compact IIIF Presentation manifest for an Archive.org item or one page of an Archive.org collection.

Input Parameters

string
required
Archive.org item or collection identifier.
string
Opaque collection-page cursor returned by a previous call; valid only for a collection manifest.
string ("item" | "collection")
Return an item Presentation manifest or one collection page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_GET_ITEM_METADATAGet a compact Archive.org item record including metadata, file inventory, public reviews and catalog tasks, or return one selected metadata field or array slice.

Input Parameters

integer
Maximum array elements to return when field_path selects an array.
integer
Zero-based start index when field_path selects an array; omit for non-array fields or a full record.
string
Slash-separated metadata path to return only one value, such as ‘metadata/title’ or ‘files’; omit for the full item record.
string
required
Archive.org item identifier.
boolean
For a full record, return only primary files when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_GET_ITEM_VIEW_COUNTSGet all-time, last-30-day, and last-7-day view counts for one or more Archive.org item or collection identifiers from the current or legacy counting pipeline.

Input Parameters

string ("current" | "legacy")
Counting pipeline to query. Use current for the recommended views data or legacy only when comparing against historical download-count metrics.
array
required
Archive.org item or collection identifiers whose summary view counts should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_GET_ITEM_VIEW_HISTORYGet a bounded daily view history for one Archive.org item or collection, split by robot classification.

Input Parameters

string
Last ISO date to return, inclusive; requires start_date.
integer
Most recent number of available days to return when no date range is set.
string
required
One Archive.org item or collection identifier.
string
First ISO date to return; requires end_date and allows at most 366 days.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_GET_MY_REVIEWGet the connected Archive.org user’s review for one item, if that user has reviewed it.

Input Parameters

string
required
Archive.org item identifier whose connected-user review should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_GET_TASK_LOGDownload a plain-text log for a task visible to the connected account. Optionally return only the first or last requested number of lines.

Input Parameters

integer
Optional documented line bound: positive returns the first N lines and negative returns the last N lines (up to 1000 either way).
integer
required
Resource-authorized Archive.org task identifier whose log to download.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_GET_TASK_RATE_LIMITSReport the connected account’s current task capacity and in-flight counts for one Archive.org catalog command.

Input Parameters

string
required
Catalog command whose current Archive.org task capacity should be checked, such as ‘derive.php’ or ‘modify_xml.php’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_LIST_TASKSReturn any documented combination of the connected account’s task summary, active catalog, and resource-authorized history, one page at a time.

Input Parameters

string
Filter the provider task argument list; ’*’ and ’%’ wildcards are allowed.
string ("summary" | "catalog" | "history")
Task data to return: aggregate summary, active catalog tasks, or item/task-specific history.
string
Filter by provider run-state color, such as green, blue, red, or brown.
integer
Maximum task records to return in this page (1-500).
string
Filter by the Archive.org execution node; ’*’ and ’%’ wildcards are allowed.
string
Filter catalog or history tasks by provider task status.
string
Filter tasks by command name, such as ‘derive.php’.
integer
Specific task identifier. For history, use it alone or with identifier to narrow the result.
integer
Filter by task priority, generally from -10 through 10.
string
Filter by submitting Archive.org user; ’*’ and ’%’ wildcards are allowed.
array
Task categories to combine in one response. Use any of summary, catalog, and history. Omit this field to retain the legacy single-category view.
string
Archive.org item identifier. History requires identifier, task_id, or both; this field is optional for catalog filtering.
integer ("0" | "1" | "2" | "9")
Filter by numeric run state: 0 queued, 1 running, 2 error, or 9 paused.
string
Opaque cursor from the previous List Archive.org Tasks response. It retains the original view and filters; omit it for the first page.
string
Filter to tasks submitted strictly after this provider-parseable date/time.
string
Filter to tasks submitted strictly before this provider-parseable date/time.
string
Filter to tasks submitted at or after this provider-parseable date/time.
string
Filter to tasks submitted at or before this provider-parseable date/time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_LIST_WAYBACK_CAPTURESReturn one bounded structured CDX page of Wayback captures for a URL or host.

Input Parameters

string
required
URL or host to query in the Wayback CDX index. Wildcards are permitted as documented by CDX.
integer
Maximum captures in this page (1-1000).
array
Exact public CDX fields to return, in response-column order.
array
Documented field regular-expression filters, combined with AND semantics.
array
Documented adjacent-record collapse controls.
string ("exact" | "prefix" | "host" | "domain")
Scope of URL matching.
string
Opaque cursor from the previous call; it restores the original query.
string
Inclusive ending timestamp using 1 to 14 digits from year onward.
string
Inclusive starting timestamp using 1 to 14 digits from year onward.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_RENDER_IIIF_IMAGERender a bounded crop, resize, rotation, quality, and format from a fixed Archive.org IIIF image route.

Input Parameters

string
IIIF output size: ‘full’ for API 2 or ‘max’ for API 3; ‘pct:n’ with 0 < n <= 100; ‘width,’ or ‘,height’ preserving aspect ratio; ‘width,height’ for exact dimensions; or ‘!width,height’ to fit within a box without upscaling. Explicit dimensions are positive integers no larger than 4096; output is also capped at 4,000,000 pixels.
string ("jpg" | "png" | "gif" | "tif" | "jp2" | "pdf" | "webp")
IIIF output format.
string
IIIF crop region: ‘full’, centered ‘square’, pixel ‘x,y,width,height’ using nonnegative integers and positive dimensions, or percentage ‘pct:x,y,width,height’ whose coordinates and extent stay within 0-100.
string ("default" | "color" | "gray" | "bitonal")
IIIF output quality.
string
required
Exact source image filename.
string
Clockwise IIIF rotation from 0 through 360 degrees, optionally prefixed with ’!’ to mirror before rotating; use canonical integers or decimals.
string
required
Archive.org item identifier.
integer ("2" | "3")
required
Live IIIF Image API route version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_SEARCH_ITEMSSearch Archive.org item metadata with a Lucene-style query and return one cursor-paginated page of matching items, or request only the match count. On paginated searches, the reported total is the number remaining from the current cursor position, including the page.

Input Parameters

array
Sort expressions accepted by Archive.org search, in priority order.
integer
Number of matches to request in this page (100-10000).
string
required
Lucene-style Archive.org metadata query, such as ‘collection:opensource_movies AND mediatype:movies’.
array
Metadata fields to return for each item. The identifier field is always included so results can be used with item tools.
boolean
Return only the number of matching items. When true, items is empty and no continuation cursor is returned.
string
Opaque cursor returned by the previous Search Archive.org Items call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_UPDATE_ITEM_METADATAQueue JSON Patch changes to an editable Archive.org item’s ordinary metadata or named file metadata records. Remove deletes metadata values and move relocates them within a target; file bytes are unaffected and multiple target changes are atomic.

Input Parameters

array
required
Nonempty target-and-patch changes. One change uses Archive.org’s single-target form; multiple changes use its atomic multi-target form.
integer
Optional modify_xml.php task priority from -10 to 10; default is 0.
string
required
Archive.org item identifier. The connected account must own the item or have permission to edit it.
integer
Send 1 to let Archive.org queue at a reduced priority instead of rate limiting when possible; send null to omit the header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_UPLOAD_ITEM_FILECreate or replace one file through Archive.org IA-S3, explicitly choosing a new-item or existing-item upload. New-item uploads alone send item creation metadata. Overwrites preserve the prior file under history/files, and this action never queues derivation; use DERIVE_ITEM for that separate irreversible effect. Input buffering is limited by the platform-configured maximum file download size. Acceptance does not mean catalog ingest is complete.

Input Parameters

object
required
File whose raw bytes will be uploaded. The file is buffered subject to the platform-configured maximum file download size.
string
Human-readable title required when create_item=true.
string
required
Destination filename, optionally including nested path segments.
string ("audio" | "data" | "image" | "movies" | "software" | "texts" | "web")
Archive.org media type required when create_item=true. Use ‘data’ for a generic test item.
string
Archive.org collection required when create_item=true. Use ‘test_collection’ for disposable test items.
string
required
Destination Archive.org item identifier. Set create_item=true only when this identifier is known not to exist.
boolean
required
Set true to create a new persistent item, or false to upload into an existing item. Creation metadata is sent only when true.
boolean
Request interactive queue priority. Do not mix priority settings across transactions on the same item because operations may be reordered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ARCHIVE_ORG_UPSERT_MY_REVIEWQueue creation or replacement of the connected Archive.org user’s public review for an eligible item. The title, body, and optional rating are intended to be publicly visible on the item.

Input Parameters

string
required
Multiline body for the public review.
integer
Optional public star rating from 0 to 5; Archive.org defaults to 0.
string
required
Single-line title for the public review.
string
required
Archive.org item identifier. Collections and user items cannot be reviewed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not