Image Extractor

https://extract.pics/docs
Admin
Image Extractor is an API service that allows users to programmatically extract images from...
Tokens:7,604
Snippets:30
Trust Score:9.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Basic Extraction Data Example - JSON

Source: https://extract.pics/docs/api/extractions

An example of the JSON data structure returned when performing a basic extraction. This includes a unique ID and the full URL of the extracted image.

```json
{
  "id": "5cf067ca-1821-422e-92a2-a64f3f422c86",
  "url": "https://extract.pics/images/hello-world.png"
}
```

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

### Start Image Extraction via API

Source: https://extract.pics/docs/api/quickstart

Initiates an image extraction by sending a POST request to the API with the target URL and API key for authentication. Handles JSON responses for success or error.

```javascript
const res = await fetch('https://api.extract.pics/v0/extractions', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ url: 'https://example.com' }),
})

const json = await res.json()
```

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

### POST /v0/extractions - Start Image Extraction

Source: https://extract.pics/docs/api

Initiates an image extraction process by sending a POST request with the target URL and API key for authentication.

```APIDOC
## POST /v0/extractions

### Description
Initiates an image extraction from a given URL.

### Method
POST

### Endpoint
https://api.extract.pics/v0/extractions

### Parameters
#### Headers
- **Authorization** (string) - Required - The API key for authentication (e.g., `Bearer YOUR_API_KEY`).
- **Content-Type** (string) - Required - Must be `application/json`.

#### Request Body
- **url** (string) - Required - The URL of the webpage from which to extract images.

### Request Example
```json
{
  "url": "https://example.com"
}
```

### Response
#### Success Response (200)
Returns an object containing the extraction details, including ID, status, and the original URL.
```json
{
  "data": {
    "id": "123",
    "status": "pending",
    "url": "https://example.com",
    "images": [],
    "created_at": "2021-08-01T00:00:00.000000Z",
    "project_id": "1"
  }
}
```

**Status Field Values:**
- **pending**: The extraction is queued.
- **running**: The extraction is in progress.
- **done**: The extraction completed successfully.
- **error**: The extraction failed.

#### Error Response (422)
Returned when the provided URL format is invalid.
```json
{
  "message": "The url format is invalid.",
  "errors": {
    "url": [
      "The url format is invalid."
    ]
  }
}
```
```

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

### Start Extraction via API

Source: https://extract.pics/docs/api

Initiates an image extraction by sending a POST request to the Extract.Pics API. Requires an API key for authentication and a URL in the request body. Handles successful responses and potential 422 errors for invalid input.

```javascript
const res = await fetch('https://api.extract.pics/v0/extractions', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ url: 'https://example.com' }),
})

const json = await res.json()

```

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

### Advanced Extraction Data Example - JSON

Source: https://extract.pics/docs/api/extractions

An example of the JSON data structure returned for an advanced extraction. This includes image metadata such as name, size, dimensions, and format, in addition to the ID and URL.

```json
{
  "id": "5cf067ca-1821-422e-92a2-a64f3f422c86",
  "url": "https://extract.pics/images/hello-world.png",
  "name": "hello-world",
  "basename": "hello-world.png",
  "type": "png",
  "size": 185446,
  "width": 1690,
  "height": 420
}
```

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

### Start Image Extraction using JavaScript

Source: https://extract.pics/docs/index

Initiates an image extraction by sending a POST request to the Extract.Pics API. Requires an API key for authentication and a URL in the request body. Returns extraction details upon success or an error object for invalid input.

```javascript
const API_KEY = 'YOUR_API_KEY'; // Replace with your actual API key

async function startExtraction(urlToExtract) {
  try {
    const res = await fetch('https://api.extract.pics/v0/extractions', {
      method: 'POST',
      headers: {
        Authorization: `Bearer ${API_KEY}`,
        'Content-Type': 'application/json',
      },
      body: JSON.stringify({ url: urlToExtract }),
    });

    if (!res.ok) {
      // Handle non-2xx responses, e.g., 422 Unprocessable Entity
      const errorData = await res.json();
      console.error('Extraction failed:', errorData);
      return null;
    }

    const json = await res.json();
    console.log('Extraction started:', json);
    return json.data;
  } catch (error) {
    console.error('Error during extraction request:', error);
    return null;
  }
}

// Example usage:
// startExtraction('https://example.com');
```

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

### GET /v0/extractions/{id}

Source: https://extract.pics/docs/api/quickstart

Retrieves the status and results of a specific extraction using its ID.

```APIDOC
## GET /v0/extractions/{id}

### Description
Fetches the current status and extracted image data for a specific extraction. This endpoint is typically polled until the extraction status is 'done' or 'error'.

### Method
GET

### Endpoint
`https://api.extract.pics/v0/extractions/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the extraction to check.

### Headers
- **Authorization** (string) - Required - Bearer token format: `Bearer YOUR_API_KEY`

### Response
#### Success Response (200)
- **data** (object) - Contains information about the extraction, including its status and extracted images.
  - **id** (string) - The unique identifier for the extraction.
  - **status** (string) - The current status of the extraction ('pending', 'running', 'done', 'error').
  - **url** (string) - The URL that was processed.
  - **images** (array) - A list of extracted image objects, each with a `url` and `id`, if the status is 'done'.
  - **created_at** (string) - Timestamp when the extraction was created.
  - **project_id** (string) - The ID of the project associated with the extraction.

#### Response Example
```json
{
  "data": {
    "id": "123",
    "status": "done",
    "url": "https://example.com",
    "images": [
      {
        "url": "https://example.com/images/hello-world.png",
        "id": "5cf067ca-1821-422e-92a2-a64f3f422c86"
      }
    ],
    "created_at": "2021-08-01T00:00:00.000000Z",
    "project_id": "1"
  }
}
```

### Rate Limiting
Be cautious not to send requests too frequently to avoid rate limiting (429 status code) and temporary blocking of your API key.
```

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

### Extraction Options JSON Payload

Source: https://extract.pics/docs/api/extractions/options

This JSON object represents the payload for starting an extraction with custom options. It includes the required 'url' and optional 'mode' and 'ignoreInlineImages' parameters. Ensure the URL is publicly accessible.

```json
{
  "url": "https://example.com",
  "mode": "advanced",
  "ignoreInlineImages": true
}
```

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

### GET /v0/extractions/{id}

Source: https://extract.pics/docs/index

Retrieves the status and results of a specific extraction using its ID. Requires an API key for authentication.

```APIDOC
## GET /v0/extractions/{id}

### Description
Retrieves the status and results of a specific extraction using its ID. Requires an API key for authentication.

### Method
GET

### Endpoint
https://api.extract.pics/v0/extractions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the extraction to check.

#### Headers
- **Authorization** (string) - Required - Bearer token with your API key

### Response
#### Success Response (200)
- **data** (object) - Contains information about the extraction.
  - **id** (string) - The unique identifier for the extraction.
  - **status** (string) - The current status of the extraction (pending, running, done, error).
  - **url** (string) - The original URL provided for extraction.
  - **images** (array) - An array of image objects if the extraction is done.
    - **url** (string) - The URL of the extracted image.
    - **id** (string) - The unique identifier for the image.
  - **created_at** (string) - The timestamp when the extraction was created.
  - **project_id** (string) - The ID of the project associated with the extraction.

#### Response Example
```json
{
  "data": {
    "id": "123",
    "status": "done",
    "url": "https://example.com",
    "images": [
      {
        "url": "https://example.com/images/hello-world.png",
        "id": "5cf067ca-1821-422e-92a2-a64f3f422c86"
      }
    ],
    "created_at": "2021-08-01T00:00:00.000000Z",
    "project_id": "1"
  }
}
```

#### Error Response (429)
Indicates that the rate limit has been exceeded. Avoid too many consecutive requests.
```

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

### Check Extraction Status via API

Source: https://extract.pics/docs/api/quickstart

Periodically checks the status of an ongoing image extraction by sending GET requests to the API using the extraction ID and API key. The loop continues until the status is 'done' or 'error'.

```javascript
const id = json.data.id;
let status = 'pending';

while (status !== 'done' && status !== 'error') {

  const res = await fetch(`https://api.extract.pics/v0/extractions/${id}`, {
    method: 'GET',
    headers: {
      Authorization: `Bearer ${API_KEY}`,
    },
  })

  status = (await res.json()).data.status;

  // Wait a seconds before checking again
  await new Promise((resolve) => setTimeout(resolve, 1000));
}
```

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

### GET /v0/extractions/{id} - Check Extraction Status

Source: https://extract.pics/docs/api

Retrieves the current status and details of a previously initiated image extraction using its unique ID.

```APIDOC
## GET /v0/extractions/{id}

### Description
Checks the status and retrieves details of a specific image extraction.

### Method
GET

### Endpoint
https://api.extract.pics/v0/extractions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the extraction.

#### Headers
- **Authorization** (string) - Required - The API key for authentication (e.g., `Bearer YOUR_API_KEY`).

### Response
#### Success Response (200)
Returns an object containing the extraction details, including the current status and extracted images if available.
```json
{
  "data": {
    "id": "123",
    "status": "done",
    "images": [
      {
        "url": "https://example.com/images/hello-world.png",
        "id": "5cf067ca-1821-422e-92a2-a64f3f422c86"
      }
    ],
    "created_at": "2021-08-01T00:00:00.000000Z",
    "project_id": "1"
  }
}
```

**Note:** It is recommended to poll this endpoint periodically until the status is 'done' or 'error', with a delay between requests to avoid rate limiting.
```

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

### Check Extraction Status via API

Source: https://extract.pics/docs/api

Periodically checks the status of an ongoing extraction using its ID. Sends GET requests to the Extract.Pics API until the extraction status is 'done' or 'error'. Includes a delay between checks to avoid rate limiting.

```javascript
const id = json.data.id;
let status = 'pending';

while (status !== 'done' && status !== 'error') {

  const res = await fetch(`https://api.extract.pics/v0/extractions/${id}`, {
    method: 'GET',
    headers: {
      Authorization: `Bearer ${API_KEY}`,
    },
  })

  status = (await res.json()).data.status;

  // Wait a seconds before checking again
  await new Promise((resolve) => setTimeout(resolve, 1000));
}

```

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

### Check Extraction Status using JavaScript

Source: https://extract.pics/docs/index

Periodically checks the status of an ongoing image extraction. It makes GET requests to the API using the extraction ID. The loop continues until the status is 'done' or 'error', with a one-second delay between checks to avoid rate limiting. Requires the API key and the extraction ID.

```javascript
const API_KEY = 'YOUR_API_KEY'; // Replace with your actual API key

async function checkExtractionStatus(extractionId) {
  let status = 'pending';
  console.log(`Checking status for extraction ID: ${extractionId}`);

  while (status !== 'done' && status !== 'error') {
    try {
      const res = await fetch(`https://api.extract.pics/v0/extractions/${extractionId}`, {
        method: 'GET',
        headers: {
          Authorization: `Bearer ${API_KEY}`,
        },
      });

      if (!res.ok) {
        console.error(`Error checking status for ${extractionId}:`, res.status, await res.text());
        // Decide how to handle errors, maybe break or retry later
        status = 'error'; // Assume error if response is not OK
        break;
      }

      const responseData = await res.json();
      status = responseData.data.status;
      console.log(`Current status for ${extractionId}: ${status}`);

      if (status !== 'done' && status !== 'error') {
        // Wait for 1 second before the next check
        await new Promise((resolve) => setTimeout(resolve, 1000));
      }
    } catch (error) {
      console.error(`Exception checking status for ${extractionId}:`, error);
      status = 'error'; // Assume error on network issues
      break;
    }
  }

  if (status === 'done') {
    console.log(`Extraction ${extractionId} completed successfully.`);
    // Optionally, fetch the final result here
  } else {
    console.log(`Extraction ${extractionId} finished with status: ${status}`);
  }
  return status;
}

// Example usage (assuming 'json' is the result from startExtraction):
// const extractionId = json.data.id;
// checkExtractionStatus(extractionId);
```

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

### POST /v0/extractions

Source: https://extract.pics/docs/api/quickstart

Initiates an image extraction from a given URL. Requires authentication with an API key.

```APIDOC
## POST /v0/extractions

### Description
Starts an image extraction process for a specified URL. You need to include your API key in the Authorization header and the target URL in the request body.

### Method
POST

### Endpoint
`https://api.extract.pics/v0/extractions`

### Parameters
#### Request Body
- **url** (string) - Required - The URL of the website from which to extract images.

### Request Example
```json
{
  "url": "https://example.com"
}
```

### Headers
- **Authorization** (string) - Required - Bearer token format: `Bearer YOUR_API_KEY`
- **Content-Type** (string) - Required - `application/json`

### Response
#### Success Response (200)
- **data** (object) - Contains information about the extraction.
  - **id** (string) - The unique identifier for the extraction.
  - **status** (string) - The current status of the extraction (e.g., 'pending', 'running', 'done', 'error').
  - **url** (string) - The URL that was processed.
  - **images** (array) - A list of extracted images (initially empty).
  - **created_at** (string) - Timestamp when the extraction was created.
  - **project_id** (string) - The ID of the project associated with the extraction.

#### Response Example
```json
{
  "data": {
    "id": "123",
    "status": "pending",
    "url": "https://example.com",
    "images": [],
    "created_at": "2021-08-01T00:00:00.000000Z",
    "project_id": "1"
  }
}
```

#### Error Response (422)
- **message** (string) - Describes the validation error.
- **errors** (object) - Contains specific field errors.
  - **url** (array) - An array of error messages for the 'url' field.

#### Error Response Example
```json
{
  "message": "The url format is invalid.",
  "errors": {
    "url": [
      "The url format is invalid."
    ]
  }
}
```
```

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

### POST /websites/extract_pics

Source: https://extract.pics/docs/api/extractions/options

Initiates an image extraction process for a given URL with customizable options.

```APIDOC
## POST /websites/extract_pics

### Description
Initiates an image extraction process for a given URL with customizable options. You can specify the extraction mode and whether to ignore inline images.

### Method
POST

### Endpoint
/websites/extract_pics

### Parameters
#### Request Body
- **url** (string) - Required - The URL of the publicly accessible webpage you want to extract images from.
- **mode** (string) - Optional - The extraction mode to use. Can be 'basic' (default) or 'advanced'.
- **ignoreInlineImages** (boolean) - Optional - Controls if inline/embedded images should be ignored. Can be true or false (default).

### Request Example
```json
{
  "url": "https://example.com",
  "mode": "advanced",
  "ignoreInlineImages": true
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the extraction initiation.

#### Response Example
```json
{
  "message": "Extraction started successfully."
}
```
```

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

### POST /downloads/multiple

Source: https://extract.pics/docs/api/downloads

Downloads multiple images from a specified extraction as a ZIP archive. Requires the extraction ID and an array of image IDs. The response is a ZIP file.

```APIDOC
## POST /downloads/multiple

### Description
Downloads multiple images from a specified extraction and returns them as a ZIP archive.

### Method
POST

### Endpoint
https://api.extract.pics/v0/downloads/multiple

### Parameters
#### Request Body
- **extraction** (string) - Required - The ID of the extraction.
- **images** (array of strings) - Required - An array of image IDs to download.

### Request Example
```json
{
  "extraction": "123",
  "images": ["xyz", "abc", "123"]
}
```

### Response
#### Success Response (200)
- **ZIP Archive** (binary) - A ZIP file containing the requested images. May include images even if some failed to download.

#### Response Example
(Binary ZIP archive data)
```

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

### POST /v0/extractions

Source: https://extract.pics/docs/index

Initiates an image extraction from a given URL. Requires an API key for authentication and the target URL in the request body.

```APIDOC
## POST /v0/extractions

### Description
Initiates an image extraction from a given URL. Requires an API key for authentication and the target URL in the request body.

### Method
POST

### Endpoint
https://api.extract.pics/v0/extractions

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token with your API key
- **Content-Type** (string) - Required - application/json

#### Request Body
- **url** (string) - Required - The URL of the website to extract images from.

### Request Example
```json
{
  "url": "https://example.com"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains information about the extraction request.
  - **id** (string) - The unique identifier for the extraction.
  - **status** (string) - The current status of the extraction (pending, running, done, error).
  - **url** (string) - The original URL provided for extraction.
  - **images** (array) - An array of image objects (initially empty).
  - **created_at** (string) - The timestamp when the extraction was created.
  - **project_id** (string) - The ID of the project associated with the extraction.

#### Response Example
```json
{
  "data": {
    "id": "123",
    "status": "pending",
    "url": "https://example.com",
    "images": [],
    "created_at": "2021-08-01T00:00:00.000000Z",
    "project_id": "1"
  }
}
```

#### Error Response (422)
- **message** (string) - Describes the error.
- **errors** (object) - Contains specific field errors.
  - **url** (array) - An array of error messages for the 'url' field.

#### Error Response Example
```json
{
  "message": "The url format is invalid.",
  "errors": {
    "url": [
      "The url format is invalid."
    ]
  }
}
```
```

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

### POST /v0/extractions

Source: https://extract.pics/docs/api/extractions/modes

Initiates an image extraction process from a given URL. Supports 'basic' and 'advanced' modes, with 'advanced' providing more detailed image metadata.

```APIDOC
## POST /v0/extractions

### Description
Initiates an image extraction from a specified URL. You can choose between 'basic' mode for simple image URLs or 'advanced' mode for detailed image analysis and metadata.

### Method
POST

### Endpoint
/v0/extractions

### Parameters
#### Request Body
- **url** (string) - Required - The URL of the website from which to extract images.
- **mode** (string) - Optional - The extraction mode. Accepts 'basic' (default) or 'advanced'.

### Request Example
```json
{
  "url": "https://extract.pics",
  "mode": "advanced"
}
```

### Response
#### Success Response (200)
- **id** (string) - A unique identifier for the extraction.
- **url** (string) - The URL of the extracted image.
- **name** (string) - Optional - The file name of the image without the extension (available in 'advanced' mode).
- **basename** (string) - Optional - The full file name of the image including the extension (available in 'advanced' mode).
- **type** (string) - Optional - The file type of the image (available in 'advanced' mode).
- **size** (integer) - Optional - The size of the image in bytes (available in 'advanced' mode).
- **width** (integer) - Optional - The width of the image in pixels (available in 'advanced' mode).
- **height** (integer) - Optional - The height of the image in pixels (available in 'advanced' mode).

#### Response Example
```json
{
  "id": "5cf067ca-1821-422e-92a2-a64f3f422c86",
  "url": "https://extract.pics/images/hello-world.png",
  "name": "hello-world",
  "basename": "hello-world.png",
  "type": "png",
  "size": 185446,
  "width": 1690,
  "height": 420
}
```
```

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

### Set Advanced Extraction Mode in API Request - JavaScript

Source: https://extract.pics/docs/api/extractions

Demonstrates how to initiate an extraction using the 'advanced' mode by setting the 'mode' parameter in the request body. Requires an API key for authorization.

```javascript
fetch('https://api.extract.pics/v0/extractions', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${API_KEY}`
  },
  body: JSON.stringify({
    url: 'https://extract.pics',
    mode: 'advanced',
  })
})
```

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

### POST /v0/extractions

Source: https://extract.pics/docs/api/extractions

Initiates an image extraction from a given URL. Supports 'basic' and 'advanced' modes, affecting the analysis and metadata returned.

```APIDOC
## POST /v0/extractions

### Description
Initiates an image extraction from a specified URL. The extraction can be performed in 'basic' mode (default) or 'advanced' mode. 'Basic' mode retrieves all images without analysis, while 'advanced' mode analyzes images for validity and includes metadata such as dimensions, file size, and format.

### Method
POST

### Endpoint
/v0/extractions

### Parameters
#### Request Body
- **url** (string) - Required - The URL of the webpage from which to extract images.
- **mode** (string) - Optional - The extraction mode. Accepts 'basic' (default) or 'advanced'.

### Request Example
```json
{
  "url": "https://extract.pics",
  "mode": "advanced"
}
```

### Response
#### Success Response (200)
- **id** (string) - A unique identifier for the extraction.
- **url** (string) - The URL of the extracted image.
- **name** (string) - Optional. The file name of the image without the extension (available in 'advanced' mode).
- **basename** (string) - Optional. The full file name of the image including the extension (available in 'advanced' mode).
- **type** (string) - Optional. The file type of the image (available in 'advanced' mode).
- **size** (integer) - Optional. The size of the image in bytes (available in 'advanced' mode).
- **width** (integer) - Optional. The width of the image in pixels (available in 'advanced' mode).
- **height** (integer) - Optional. The height of the image in pixels (available in 'advanced' mode).

#### Response Example (Advanced Mode)
```json
{
  "id": "5cf067ca-1821-422e-92a2-a64f3f422c86",
  "url": "https://extract.pics/images/hello-world.png",
  "name": "hello-world",
  "basename": "hello-world.png",
  "type": "png",
  "size": 185446,
  "width": 1690,
  "height": 420
}
```

#### Response Example (Basic Mode)
```json
{
  "id": "5cf067ca-1821-422e-92a2-a64f3f422c86",
  "url": "https://extract.pics/images/hello-world.png"
}
```
```

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

### Download Multiple Images via API (JavaScript)

Source: https://extract.pics/docs/api/downloads

This snippet shows how to download multiple images from an extraction as a ZIP archive using the extract.pics API. It requires the extraction ID and an array of image IDs, sending a POST request with authentication to the '/downloads/multiple' endpoint.

```javascript
const extractionId = '123'
const imageIds = ['xyz', 'abc', '123']

fetch('https://api.extract.pics/v0/downloads/multiple', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${API_KEY}`,
  },
  body: JSON.stringify({
    extraction: extractionId,
    images: imageIds,
  })
})
```

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

### Set Advanced Extraction Mode using Fetch API

Source: https://extract.pics/docs/api/extractions/modes

This JavaScript code snippet demonstrates how to initiate an extraction request using the Fetch API and set the extraction mode to 'advanced' by including the 'mode' parameter in the request body.

```javascript
fetch('https://api.extract.pics/v0/extractions', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${API_KEY}`,
  },
  body: JSON.stringify({
    url: 'https://extract.pics',
    mode: 'advanced',
  })
})
```

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

### POST /downloads/single

Source: https://extract.pics/docs/api/downloads

Downloads a single image from a specified extraction. Requires the extraction ID and image ID. The image is returned directly in the response.

```APIDOC
## POST /downloads/single

### Description
Downloads a single image from a specified extraction.

### Method
POST

### Endpoint
https://api.extract.pics/v0/downloads/single

### Parameters
#### Request Body
- **extraction** (string) - Required - The ID of the extraction.
- **image** (string) - Required - The ID of the image to download.

### Request Example
```json
{
  "extraction": "123",
  "image": "456"
}
```

### Response
#### Success Response (200)
- **Image Data** (binary) - The image file content.

#### Response Example
(Binary image data)
```

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

### Download Single Image via API (JavaScript)

Source: https://extract.pics/docs/api/downloads

This snippet demonstrates how to download a single image from an extraction using the extract.pics API. It requires the extraction ID and image ID, and sends a POST request with authentication to the '/downloads/single' endpoint.

```javascript
const extractionId = '123'
const imageId = '456'

fetch('https://api.extract.pics/v0/downloads/single', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${API_KEY}`,
  },
  body: JSON.stringify({
    extraction: extractionId,
    image: imageId,
  })
})
```

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

### API Authentication

Source: https://extract.pics/docs/api/authentication

Learn how to authenticate your requests to the Extract.pics API using your API key.

```APIDOC
## API Authentication

### Description
To authenticate your requests with the Extract.pics API, you need to include your API key in the `Authorization` header as a `Bearer` token.

### Method
All HTTP requests to the API require authentication.

### Endpoint
All API endpoints.

### Parameters
#### Headers
- **Authorization** (string) - Required - Your API key in the format `Bearer YOUR_API_KEY`.

### Request Example
```javascript
fetch('https://api.extract.pics/v0', {
  headers: {
    Authorization: `Bearer YOUR_API_KEY`
  }
})
```

### Response
Authentication is handled via headers. A successful request will proceed to the intended endpoint, while an unauthorized request will typically result in a 401 or 403 error.
```

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

### Include API Key in Request Header (JavaScript)

Source: https://extract.pics/docs/api/authentication

Demonstrates how to include the API key in the Authorization header of a fetch request using JavaScript. This is essential for authenticating your API calls.

```javascript
fetch('https://api.extract.pics/v0', {
  headers: {
    Authorization: `Bearer ${API_KEY}`,
  }
})
```

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

### Webhook Notification

Source: https://extract.pics/docs/api/webhooks

Receives extraction results in real-time via POST requests when an extraction is completed or fails.

```APIDOC
## POST /webhooks

### Description
This endpoint is called by the system to notify your application about the status of an extraction. It is triggered automatically upon completion or failure of an extraction task initiated via the API.

### Method
POST

### Endpoint
/webhooks

### Parameters
#### Request Body
- **data** (object) - Required - Contains the details of the extraction.
  - **id** (string) - Required - The ID of the extraction.
  - **status** (string) - Required - The status of the extraction (e.g., "done", "failed").
  - **images** (array) - Required - A list of extracted images.
    - **url** (string) - Required - The URL of the extracted image.
    - **name** (string) - Required - The name of the extracted image.
    - **size** (integer) - Required - The size of the extracted image in bytes.
    - **type** (string) - Required - The file type of the extracted image (e.g., "png").
    - **id** (string) - Required - The unique identifier for the image.
    - **width** (integer) - Required - The width of the image in pixels.
    - **height** (integer) - Required - The height of the image in pixels.
  - **created_at** (string) - Required - The timestamp when the extraction was created in ISO 8601 format.
  - **project_id** (string) - Required - The ID of the project associated with the extraction.

### Request Example
```json
{
  "data": {
    "id": "123",
    "status": "done",
    "images": [
      {
        "url": "https://extract.pics/images/hello-world.png",
        "name": "hello-world",
        "size": 185446,
        "type": "png",
        "id": "5cf067ca-1821-422e-92a2-a64f3f422c86",
        "width": 1690,
        "height": 420
      }
    ],
    "created_at": "2021-08-01T00:00:00.000000Z",
    "project_id": "1"
  }
}
```

### Response
#### Success Response (200)
Respond with a 200 OK status code to acknowledge receipt of the webhook. Failure to do so may result in retries.

#### Response Example
```json
{
  "message": "Webhook received successfully"
}
```
```

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

### Webhook Request Body Structure

Source: https://extract.pics/docs/api/webhooks

This JSON object represents the data structure sent in a webhook POST request when an extraction is completed or fails. It includes details about the extraction status, image data, creation timestamp, and project ID.

```json
{
  "data": {
    "id": "123",
    "status": "done",
    "images": [
      {
        "url": "https://extract.pics/images/hello-world.png",
        "name": "hello-world",
        "size": 185446,
        "type": "png",
        "id": "5cf067ca-1821-422e-92a2-a64f3f422c86",
        "width": 1690,
        "height": 420
      }
    ],
    "created_at": "2021-08-01T00:00:00.000000Z",
    "project_id": "1"
  }
}
```
Tokens:
Raw