get_any
Retrieve specific snapshots, archive results, or tags by their unique identifier from the ArchiveBox web archiving system to access archived content and metadata.
Instructions
Get a specific Snapshot, ArchiveResult, or Tag by abid.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| abid | Yes | The abid of the Snapshot, ArchiveResult, or Tag |
Implementation Reference
- archivebox_api/archivebox_mcp.py:490-543 (handler)Primary MCP tool handler for 'get_any': registers the tool with @mcp.tool(), defines input schema via Pydantic Field descriptions (abid required, auth/env params optional), creates Api client, calls underlying get_any, and returns JSON response.@mcp.tool( exclude_args=[ "archivebox_url", "username", "password", "token", "api_key", "verify", ], tags={"core"}, ) def get_any( abid: str = Field( description="The abid of the Snapshot, ArchiveResult, or Tag", ), archivebox_url: str = Field( default=os.environ.get("ARCHIVEBOX_URL", None), description="The URL of the ArchiveBox instance", ), username: Optional[str] = Field( default=os.environ.get("ARCHIVEBOX_USERNAME", None), description="Username for authentication", ), password: Optional[str] = Field( default=os.environ.get("ARCHIVEBOX_PASSWORD", None), description="Password for authentication", ), token: Optional[str] = Field( default=os.environ.get("ARCHIVEBOX_TOKEN", None), description="Bearer token for authentication", ), api_key: Optional[str] = Field( default=os.environ.get("ARCHIVEBOX_API_KEY", None), description="API key for authentication", ), verify: Optional[bool] = Field( default=to_boolean(os.environ.get("ARCHIVEBOX_VERIFY", "True")), description="Whether to verify SSL certificates", ), ) -> dict: """ Get a specific Snapshot, ArchiveResult, or Tag by abid. """ client = Api( url=archivebox_url, username=username, password=password, token=token, api_key=api_key, verify=verify, ) response = client.get_any(abid=abid) return response.json()
- Helper method in Api class: performs authenticated HTTP GET to ArchiveBox server endpoint `/api/v1/core/any/{abid}` to retrieve Snapshot, ArchiveResult, or Tag by abid.def get_any(self, abid: str) -> requests.Response: """ Get a specific Snapshot, ArchiveResult, or Tag by abid Args: abid: The abid of the Snapshot, ArchiveResult, or Tag. Returns: Response: The response object from the GET request. Raises: ParameterError: If the provided parameters are invalid. """ try: response = self._session.get( url=f"{self.url}/api/v1/core/any/{abid}", headers=self.headers, verify=self.verify, ) except ValidationError as e: raise ParameterError(f"Invalid parameters: {e.errors()}") return response