ArchiveBox API
60
AI ReadinessAI-Aware (B-)60/100
Agent-ready OpenAPI document · curated by JenticDeveloper ToolsMonitoring Observabilitybearer, apiKey35 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Capture, list, and manage web archive snapshots on a self-hosted ArchiveBox instance, plus drive crawls and CLI operations.
Use for: I need to archive a web page to our self-hosted ArchiveBox, List all snapshots tagged with a specific keyword, Get the archive results for a specific snapshot, Delete an outdated snapshot from the ArchiveBox catalogue
Not supported: Does not handle hosted public archive lookups, content moderation, or external CDN delivery - use for self-hosted snapshot capture and management only.
Jentic publishes the only available OpenAPI specification for ArchiveBox API, keeping it validated and agent-ready. ArchiveBox is a self-hosted web archiving system that lets teams capture, search, and replay snapshots of web pages on infrastructure they control. The v1 ALPHA REST API exposes 35 endpoints covering snapshots, archive results, tags, crawls, CLI commands, and machine binary information. Authentication supports both bearer tokens and a cookie-based session for human users.
Install Jentic One Beta
Connect the ArchiveBox API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the ArchiveBox API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Farchivebox.io%2Farchivebox" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Farchivebox.io%2Farchivebox" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with ArchiveBox API.
Capture a new snapshot of a URL into an ArchiveBox instance
List and filter the snapshot catalogue across the archive
Update or delete an existing snapshot record
Read individual archive results (e.g. WARC, screenshot, PDF) for a snapshot
Tag snapshots and query the archive by tag
Drive crawls and execute archived CLI commands programmatically
Inspect machine and binary metadata for the archiving worker
Use Cases
Patterns agents use ArchiveBox API for, with concrete tasks.
★ Self-Hosted Web Archive for Compliance
Capture and retain full-fidelity snapshots of customer-facing pages under the team's control rather than relying on a third-party archive. Compliance and legal teams use ArchiveBox to keep WARC, screenshot, and PDF copies of pages on their own infrastructure. POST /core/snapshots queues a new capture and the resulting archive results endpoints expose the captured artefacts.
Call POST /core/snapshots with the target URL, then poll GET /core/snapshot/{snapshot_id} until the snapshot status is complete and return the artefact URLs.
Tag-Based Research Collections
Build curated research collections by tagging snapshots and querying the archive by tag. Researchers and journalists use this to group sources for a story or investigation without leaving the archive. The /core/tags endpoint exposes the tag taxonomy and tag-filter queries on snapshots return the matching subset.
Call GET /core/tags to confirm the tag exists, then list snapshots filtered by that tag and return the snapshot IDs.
Snapshot Maintenance and Cleanup
Periodically prune outdated or duplicate snapshots to keep an ArchiveBox instance manageable. Operations teams use the update and delete endpoints to expire snapshots that are no longer relevant or to correct metadata after the fact. PATCH and DELETE on /core/snapshot/{snapshot_id} drive these workflows.
List snapshots older than a target date via GET /core/snapshots, then call DELETE /core/snapshot/{snapshot_id} for each ID returned.
AI Agent Web Archiving via Jentic
An agent that captures evidence or research pages on behalf of a user can call ArchiveBox through Jentic to queue snapshots without managing the bearer token directly. The agent searches for the snapshot operation, loads the schema, and executes the create-snapshot call. Jentic resolves the bearer token from its credential vault.
Use Jentic search 'archive a web page in ArchiveBox', load the schema for POST /core/snapshots, then execute with the target URL and return the new snapshot ID.
Key Endpoints
35 endpoints — jentic publishes the only available openapi specification for archivebox api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/core/snapshots
List all snapshots
POST
/core/snapshots
Create a new snapshot
GET
/core/snapshot/{snapshot_id}
Get a snapshot by ID
PATCH
/core/snapshot/{snapshot_id}
Update a snapshot
DELETE
/core/snapshot/{snapshot_id}
Delete a snapshot
GET
/core/archiveresults
List archive result artefacts
GET
/core/tags
List tags applied across the archive
GET
/core/snapshots
List all snapshots
POST
/core/snapshots
Create a new snapshot
GET
/core/snapshot/{snapshot_id}
Get a snapshot by ID
PATCH
/core/snapshot/{snapshot_id}
Update a snapshot
DELETE
/core/snapshot/{snapshot_id}
Delete a snapshot
GET
/core/archiveresults
List archive result artefacts
GET
/core/tags
List tags applied across the archive
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
ArchiveBox API
- AI-Aware (B-)60/100
61
Foundational Compliance63
Developer Experience & Jentic Compatibility47
AI-Readiness & Agent Experience94
Agent Usability55
Security62
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
61
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: B-Signals: 4
93%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
50%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
47
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: DSignals: 4
31%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
56%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
55
Security
Trust, risk posture, and security compliance.
Grade: CSignals: 1
55%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
62
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B-Signals: 1
62%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring ArchiveBox by hand means learning its bearer and API-key auth, pointing at your self-hosted server URL, and threading snapshot ids through its paths yourself. Through Jentic you install once, import the ArchiveBox API from the API Directory, store the token once, and your agent calls it.
Permission scoping
ArchiveBox puts the snapshot id in the URL path (/core/snapshot/{snapshot_id}), so a rule can pin your agent to reading and updating specific snapshots. You choose the operations it may call, so destructive ones like deleting a snapshot are not included unless you add them.
Credential isolation
Your ArchiveBox bearer token is stored once, encrypted, by your own Jentic One instance and injected as the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'archive a web page in ArchiveBox', and Jentic returns the matching ArchiveBox operation with its input schema so the agent calls the right endpoint without browsing docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using ArchiveBox API through Jentic.
Why is there no official OpenAPI spec for ArchiveBox API?
ArchiveBox does not publish an OpenAPI specification for its v1 ALPHA REST API. Jentic generates and maintains this spec so that AI agents and developers can call ArchiveBox API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the ArchiveBox API use?
ArchiveBox supports two schemes: a bearer token in the Authorization header for machine-to-machine calls and a cookie-based session for human admin users. Through Jentic, the bearer token is stored encrypted in the vault and never enters the agent's context.
Can I create a new snapshot of a URL via the API?
Yes. POST /core/snapshots with the target URL queues a new capture. Poll GET /core/snapshot/{snapshot_id} until the status indicates completion to retrieve the resulting WARC, screenshot, and PDF artefact URLs.
How do I find all archive results for a snapshot?
Call GET /core/archiveresults with a filter on the snapshot ID, or fetch GET /core/archiveresult/{archiveresult_id} for an individual artefact. The archive results endpoints expose each captured format separately.
What are the rate limits for the ArchiveBox API?
Because ArchiveBox is self-hosted, rate limits are determined by the deployment's own configuration rather than a vendor-imposed quota. The OpenAPI spec does not declare hard limits - the practical ceiling is the worker concurrency you configure on your instance.
How do I archive a page through Jentic?
Install Jentic with pip install jentic, search for 'archive a web page in ArchiveBox', load the schema for POST /core/snapshots, then execute with the URL. Jentic injects the bearer token automatically.
Can I limit what my agent is allowed to do with the ArchiveBox API?
Yes. Because you run Jentic One yourself, your own rules decide which ArchiveBox operations and credentials the agent may use. ArchiveBox puts the snapshot id in the URL path (/core/snapshot/{snapshot_id}), so you can pin the agent to reading and updating specific snapshots while keeping destructive operations like DELETE /core/snapshot/{snapshot_id} out of its reach unless you explicitly add them. You choose whether it can capture new snapshots, drive crawls, or run CLI commands, and the bearer token you store stays under your control.
GET STARTED