Save Page Now 2 Public API

https://docs.google.com/document/d/1Nsv52MvSjbLb2PCpHlat0gkzw0EvtSgpKHu4mk0MnrA/edit
Admin
Save Page Now 2 is the Internet Archive's public API that enables developers to capture, archive,...
Tokens:1,908
Snippets:13
Trust Score:5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example PHP Script using SPN2 API

Source: https://docs.google.com/document/d/1Nsv52MvSjbLb2PCpHlat0gkzw0EvtSgpKHu4mk0MnrA/edit?tab=t.0#heading=h.1gmodju1d6p0

A sample PHP script demonstrating how to use the SPN2 API for capturing a URL.

```APIDOC
```php
<?php

$apiKey = 'YOUR_API_KEY';
$apiUrl = 'https://api.spn2.example.com'; // Replace with actual API endpoint

$urlToCapture = 'https://www.google.com';

// Prepare the capture request data
$data = json_encode([
    'url' => $urlToCapture,
    'options' => [
        'capture_type' => 'screenshot'
    ]
]);

// Initialize cURL session
$ch = curl_init($apiUrl . '/api/capture');

// Set cURL options
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $apiKey
]);

// Execute cURL session
$response = curl_exec($ch);

// Check for errors
if (curl_errno($ch)) {
    echo 'cURL Error: ' . curl_error($ch);
} else {
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    echo 'HTTP Status Code: ' . $httpCode . "\n";
    echo 'Response: ' . $response;

    // Process the response (e.g., get capture_id and check status later)
    $responseData = json_decode($response, true);
    if (isset($responseData['capture_id'])) {
        echo "\nCapture initiated with ID: " . $responseData['capture_id'];
        // You would typically poll the /api/status/{capture_id} endpoint here
    }
}

// Close cURL session
curl_close($ch);

?>
```
```

--------------------------------

### Capture URL using SPN2 API (PHP)

Source: https://docs.google.com/document/d/1Nsv52MvSjbLb2PCpHlat0gkzw0EvtSgpKHu4mk0MnrA/edit?tab=t.0#heading=h.1gmodju1d6p0

Example script demonstrating how to capture a URL using the SPN2 API. Ensure you have the necessary API credentials and endpoint configured.

```php
<?php

// SPN2 API endpoint
$api_endpoint = "https://api.example.com/spn2/capture";

// URL to capture
$url_to_capture = "https://www.example.com";

// API key or authentication token
$api_key = "YOUR_API_KEY";

// Prepare the data payload
$data = json_encode([
    "url" => $url_to_capture
]);

// Initialize cURL session
$ch = curl_init($api_endpoint);

// Set cURL options
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: Bearer " . $api_key
]);

// Execute cURL request
$response = curl_exec($ch);

// Check for cURL errors
if (curl_errno($ch)) {
    echo 'cURL Error: ' . curl_error($ch);
} else {
    // Process the API response
    $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    if ($http_code == 200) {
        echo "Capture successful!";
        // You can decode and use the $response JSON here
        // $result = json_decode($response, true);
    } else {
        echo "Capture failed. HTTP code: " . $http_code;
        echo "\nResponse: " . $response;
    }
}

// Close cURL session
c_url_close($ch);

?>
```

--------------------------------

### SPN2 API - Basic Reference

Source: https://docs.google.com/document/d/1Nsv52MvSjbLb2PCpHlat0gkzw0EvtSgpKHu4mk0MnrA/edit?tab=t.0#heading=h.1gmodju1d6p0

This section covers the fundamental aspects of the SPN2 Public API, including its core functionalities and general usage guidelines.

```APIDOC
## SPN2 Public API - Basic Reference

### Description
Provides an overview of the SPN2 Public API, its capabilities, and general usage.

### Key Sections
- Capture Request
- Status Request
- Error Codes
- User Status
- System Status
- Tips for Faster Captures
- Limitations
- Example PHP Script
- Frequently Asked Questions
```

--------------------------------

### SPN2 API - Capture Request

Source: https://docs.google.com/document/d/1Nsv52MvSjbLb2PCpHlat0gkzw0EvtSgpKHu4mk0MnrA/edit?tab=t.0#heading=h.1gmodju1d6p0

Details on how to initiate a capture request using the SPN2 API.

```APIDOC
## POST /api/capture

### Description
Initiates a capture request for a given URL.

### Method
POST

### Endpoint
/api/capture

### Request Body
- **url** (string) - Required - The URL to be captured.
- **options** (object) - Optional - Additional capture options.
  - **capture_type** (string) - Optional - Type of capture (e.g., 'full_page', 'screenshot').
  - **delay** (integer) - Optional - Delay in milliseconds before capture.

### Request Example
```json
{
  "url": "https://example.com",
  "options": {
    "capture_type": "full_page",
    "delay": 2000
  }
}
```

### Response
#### Success Response (200)
- **capture_id** (string) - The unique identifier for the capture request.
- **status** (string) - The current status of the capture.

#### Response Example
```json
{
  "capture_id": "cap_12345abcde",
  "status": "pending"
}
```
```

--------------------------------

### SPN2 API - System Status

Source: https://docs.google.com/document/d/1Nsv52MvSjbLb2PCpHlat0gkzw0EvtSgpKHu4mk0MnrA/edit?tab=t.0#heading=h.1gmodju1d6p0

Information regarding the overall status of the SPN2 system.

```APIDOC
## GET /api/system/status

### Description
Retrieves the current operational status of the SPN2 system.

### Method
GET

### Endpoint
/api/system/status

### Response
#### Success Response (200)
- **system_status** (string) - The overall status of the system (e.g., 'operational', 'degraded', 'maintenance').
- **message** (string) - Optional - A message providing more details about the system status.

#### Response Example
```json
{
  "system_status": "operational",
  "message": "All systems are functioning normally."
}
```
```

--------------------------------

### SPN2 API - Status Request

Source: https://docs.google.com/document/d/1Nsv52MvSjbLb2PCpHlat0gkzw0EvtSgpKHu4mk0MnrA/edit?tab=t.0#heading=h.1gmodju1d6p0

Information on how to check the status of a capture request using the SPN2 API.

```APIDOC
## GET /api/status/{capture_id}

### Description
Retrieves the status of a specific capture request.

### Method
GET

### Endpoint
/api/status/{capture_id}

### Parameters
#### Path Parameters
- **capture_id** (string) - Required - The unique identifier of the capture request.

### Response
#### Success Response (200)
- **capture_id** (string) - The unique identifier for the capture request.
- **status** (string) - The current status of the capture (e.g., 'processing', 'completed', 'failed').
- **result_url** (string) - Optional - The URL to the captured content if completed.

#### Response Example
```json
{
  "capture_id": "cap_12345abcde",
  "status": "completed",
  "result_url": "https://storage.example.com/captures/cap_12345abcde.pdf"
}
```
```

--------------------------------

### SPN2 API - Error Codes

Source: https://docs.google.com/document/d/1Nsv52MvSjbLb2PCpHlat0gkzw0EvtSgpKHu4mk0MnrA/edit?tab=t.0#heading=h.1gmodju1d6p0

A reference for error codes returned by the SPN2 API.

```APIDOC
## Error Codes

### Description
This section lists common error codes returned by the SPN2 API and their meanings.

### Common Error Codes
- **400 Bad Request**: The request was malformed or invalid.
- **401 Unauthorized**: Authentication credentials are required or invalid.
- **404 Not Found**: The requested resource could not be found.
- **500 Internal Server Error**: An unexpected error occurred on the server.
- **ERR_INVALID_URL**: The provided URL is not valid.
- **ERR_CAPTURE_FAILED**: The capture process failed for the given URL.
```

--------------------------------

### SPN2 API - User Status

Source: https://docs.google.com/document/d/1Nsv52MvSjbLb2PCpHlat0gkzw0EvtSgpKHu4mk0MnrA/edit?tab=t.0#heading=h.1gmodju1d6p0

Information regarding the status of a user account within the SPN2 system.

```APIDOC
## GET /api/user/status

### Description
Retrieves the status of the authenticated user account.

### Method
GET

### Endpoint
/api/user/status

### Response
#### Success Response (200)
- **user_id** (string) - The unique identifier for the user.
- **account_status** (string) - The status of the user's account (e.g., 'active', 'suspended').
- **quota_remaining** (integer) - The remaining quota for the user.

#### Response Example
```json
{
  "user_id": "user_xyz789",
  "account_status": "active",
  "quota_remaining": 950
}
```
```
Tokens:
Raw