> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# imgix

> Imgix Image Management

**Server path:** `/imgix` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                          | Description              |
| ------------------------------------------------------------- | ------------------------ |
| [`imgix_add_asset_from_origin`](#imgix_add_asset_from_origin) | Add asset from origin    |
| [`imgix_create_purge`](#imgix_create_purge)                   | Purge a cached asset     |
| [`imgix_create_source`](#imgix_create_source)                 | Create a new Source      |
| [`imgix_get_asset`](#imgix_get_asset)                         | Get a single asset       |
| [`imgix_get_report`](#imgix_get_report)                       | Get a single report      |
| [`imgix_get_source`](#imgix_get_source)                       | Get a single Source      |
| [`imgix_list_assets`](#imgix_list_assets)                     | List assets for a Source |
| [`imgix_list_reports`](#imgix_list_reports)                   | List all reports         |
| [`imgix_list_sources`](#imgix_list_sources)                   | List all Sources         |
| [`imgix_publish_asset`](#imgix_publish_asset)                 | Publish an asset         |
| [`imgix_refresh_asset`](#imgix_refresh_asset)                 | Refresh a cached asset   |
| [`imgix_unpublish_asset`](#imgix_unpublish_asset)             | Unpublish an asset       |
| [`imgix_update_asset`](#imgix_update_asset)                   | Update asset metadata    |
| [`imgix_update_source`](#imgix_update_source)                 | Update a Source          |

***

## imgix\_add\_asset\_from\_origin

Add asset from origin

**Parameters:**

| Parameter     | Type   | Required | Default | Description                          |
| ------------- | ------ | -------- | ------- | ------------------------------------ |
| `source_id`   | string | Yes      | —       | The ID of the Source.                |
| `origin_path` | string | Yes      | —       | The origin path of the asset to add. |
| `body`        | object | No       | —       | Request body                         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "source_id": {
        "type": "string",
        "description": "The ID of the Source."
      },
      "origin_path": {
        "type": "string",
        "description": "The origin path of the asset to add."
      },
      "body": {
        "type": "object",
        "description": "Request body"
      }
    },
    "required": [
      "PCID",
      "source_id",
      "origin_path"
    ]
  }
  ```
</Expandable>

***

## imgix\_create\_purge

Purge a cached asset

**Parameters:**

| Parameter | Type   | Required | Default | Description    |
| --------- | ------ | -------- | ------- | -------------- |
| `data`    | object | Yes      | —       | The data value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "data": {
        "type": "object",
        "description": "The data value",
        "properties": {
          "type": {
            "type": "string",
            "description": "Resource type, must be 'purges'.",
            "enum": [
              "purges"
            ]
          },
          "attributes": {
            "type": "object",
            "description": "The attributes value"
          }
        },
        "required": [
          "type",
          "attributes"
        ]
      }
    },
    "required": [
      "PCID",
      "data"
    ]
  }
  ```
</Expandable>

***

## imgix\_create\_source

Create a new Source

**Parameters:**

| Parameter | Type   | Required | Default | Description    |
| --------- | ------ | -------- | ------- | -------------- |
| `data`    | object | Yes      | —       | The data value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "data": {
        "type": "object",
        "description": "The data value",
        "properties": {
          "type": {
            "type": "string",
            "description": "Resource type, must be 'sources'.",
            "enum": [
              "sources"
            ]
          },
          "attributes": {
            "type": "object",
            "description": "The attributes value"
          }
        },
        "required": [
          "type",
          "attributes"
        ]
      }
    },
    "required": [
      "PCID",
      "data"
    ]
  }
  ```
</Expandable>

***

## imgix\_get\_asset

Get a single asset

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                              |
| ------------- | ------ | -------- | ------- | -------------------------------------------------------- |
| `source_id`   | string | Yes      | —       | The ID of the Source.                                    |
| `origin_path` | string | Yes      | —       | The origin path of the asset (URL-encoded if necessary). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "source_id": {
        "type": "string",
        "description": "The ID of the Source."
      },
      "origin_path": {
        "type": "string",
        "description": "The origin path of the asset (URL-encoded if necessary)."
      }
    },
    "required": [
      "PCID",
      "source_id",
      "origin_path"
    ]
  }
  ```
</Expandable>

***

## imgix\_get\_report

Get a single report

**Parameters:**

| Parameter   | Type   | Required | Default | Description                       |
| ----------- | ------ | -------- | ------- | --------------------------------- |
| `report_id` | string | Yes      | —       | The ID of the report to retrieve. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "report_id": {
        "type": "string",
        "description": "The ID of the report to retrieve."
      }
    },
    "required": [
      "PCID",
      "report_id"
    ]
  }
  ```
</Expandable>

***

## imgix\_get\_source

Get a single Source

**Parameters:**

| Parameter   | Type   | Required | Default | Description                       |
| ----------- | ------ | -------- | ------- | --------------------------------- |
| `source_id` | string | Yes      | —       | The ID of the Source to retrieve. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "source_id": {
        "type": "string",
        "description": "The ID of the Source to retrieve."
      }
    },
    "required": [
      "PCID",
      "source_id"
    ]
  }
  ```
</Expandable>

***

## imgix\_list\_assets

List assets for a Source

**Parameters:**

| Parameter             | Type    | Required | Default | Description                                                          |
| --------------------- | ------- | -------- | ------- | -------------------------------------------------------------------- |
| `source_id`           | string  | Yes      | —       | The ID of the Source.                                                |
| `filter[keyword]`     | string  | No       | —       | Search across multiple asset fields.                                 |
| `filter[tags]`        | string  | No       | —       | Filter by tags (comma-separated, AND logic).                         |
| `filter[categories]`  | string  | No       | —       | Filter by categories (comma-separated, AND logic).                   |
| `filter[media_kind]`  | string  | No       | —       | Filter by media kind (IMAGE, ANIMATION, DOCUMENT, VECTOR).           |
| `filter[origin_path]` | string  | No       | —       | Filter by asset origin path.                                         |
| `sort`                | string  | No       | —       | Sort results. Options: -date\_created, -date\_modified, -file\_size. |
| `page[cursor]`        | string  | No       | —       | Pagination cursor for result sets.                                   |
| `page[limit]`         | integer | No       | —       | Number of results per page.                                          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "source_id": {
        "type": "string",
        "description": "The ID of the Source."
      },
      "filter[keyword]": {
        "type": "string",
        "description": "Search across multiple asset fields."
      },
      "filter[tags]": {
        "type": "string",
        "description": "Filter by tags (comma-separated, AND logic)."
      },
      "filter[categories]": {
        "type": "string",
        "description": "Filter by categories (comma-separated, AND logic)."
      },
      "filter[media_kind]": {
        "type": "string",
        "description": "Filter by media kind (IMAGE, ANIMATION, DOCUMENT, VECTOR).",
        "enum": [
          "IMAGE",
          "ANIMATION",
          "DOCUMENT",
          "VECTOR"
        ]
      },
      "filter[origin_path]": {
        "type": "string",
        "description": "Filter by asset origin path."
      },
      "sort": {
        "type": "string",
        "description": "Sort results. Options: -date_created, -date_modified, -file_size."
      },
      "page[cursor]": {
        "type": "string",
        "description": "Pagination cursor for result sets."
      },
      "page[limit]": {
        "type": "integer",
        "description": "Number of results per page."
      }
    },
    "required": [
      "PCID",
      "source_id"
    ]
  }
  ```
</Expandable>

***

## imgix\_list\_reports

List all reports

**Parameters:**

| Parameter             | Type    | Required | Default | Description                                                                                                   |
| --------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `filter[completed]`   | boolean | No       | —       | Filter by completion status.                                                                                  |
| `filter[report_type]` | string  | No       | —       | Filter by report type (image\_analytics, source\_analytics, cdn\_logs, mild\_errors).                         |
| `sort`                | string  | No       | —       | Sort results. Options: period\_end, period\_start, report\_key, report\_type. Prefix with '-' for descending. |
| `page[number]`        | integer | No       | —       | Page number (zero-indexed).                                                                                   |
| `page[size]`          | integer | No       | —       | Number of results per page.                                                                                   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "filter[completed]": {
        "type": "boolean",
        "description": "Filter by completion status."
      },
      "filter[report_type]": {
        "type": "string",
        "description": "Filter by report type (image_analytics, source_analytics, cdn_logs, mild_errors).",
        "enum": [
          "image_analytics",
          "source_analytics",
          "cdn_logs",
          "mild_errors"
        ]
      },
      "sort": {
        "type": "string",
        "description": "Sort results. Options: period_end, period_start, report_key, report_type. Prefix with '-' for descending."
      },
      "page[number]": {
        "type": "integer",
        "description": "Page number (zero-indexed)."
      },
      "page[size]": {
        "type": "integer",
        "description": "Number of results per page."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## imgix\_list\_sources

List all Sources

**Parameters:**

| Parameter                 | Type    | Required | Default | Description                                                                           |
| ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------- |
| `filter[name]`            | string  | No       | —       | Filter sources by name (substring match).                                             |
| `filter[enabled]`         | boolean | No       | —       | Filter sources by enabled status.                                                     |
| `filter[deployment.type]` | string  | No       | —       | Filter by deployment type (azure, gcs, s3, webfolder, webproxy, s3\_compatible).      |
| `sort`                    | string  | No       | —       | Sort results. Prefix with '-' for descending. Options: date\_deployed, enabled, name. |
| `page[number]`            | integer | No       | —       | Page number (zero-indexed) for pagination.                                            |
| `page[size]`              | integer | No       | —       | Number of results per page.                                                           |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "filter[name]": {
        "type": "string",
        "description": "Filter sources by name (substring match)."
      },
      "filter[enabled]": {
        "type": "boolean",
        "description": "Filter sources by enabled status."
      },
      "filter[deployment.type]": {
        "type": "string",
        "description": "Filter by deployment type (azure, gcs, s3, webfolder, webproxy, s3_compatible).",
        "enum": [
          "azure",
          "gcs",
          "s3",
          "webfolder",
          "webproxy",
          "s3_compatible"
        ]
      },
      "sort": {
        "type": "string",
        "description": "Sort results. Prefix with '-' for descending. Options: date_deployed, enabled, name."
      },
      "page[number]": {
        "type": "integer",
        "description": "Page number (zero-indexed) for pagination."
      },
      "page[size]": {
        "type": "integer",
        "description": "Number of results per page."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## imgix\_publish\_asset

Publish an asset

**Parameters:**

| Parameter | Type   | Required | Default | Description    |
| --------- | ------ | -------- | ------- | -------------- |
| `data`    | object | Yes      | —       | The data value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "data": {
        "type": "object",
        "description": "The data value",
        "properties": {
          "type": {
            "type": "string",
            "description": "Resource type, must be 'publishes'.",
            "enum": [
              "publishes"
            ]
          },
          "attributes": {
            "type": "object",
            "description": "The attributes value"
          }
        },
        "required": [
          "type",
          "attributes"
        ]
      }
    },
    "required": [
      "PCID",
      "data"
    ]
  }
  ```
</Expandable>

***

## imgix\_refresh\_asset

Refresh a cached asset

**Parameters:**

| Parameter     | Type   | Required | Default | Description                              |
| ------------- | ------ | -------- | ------- | ---------------------------------------- |
| `source_id`   | string | Yes      | —       | The ID of the Source.                    |
| `origin_path` | string | Yes      | —       | The origin path of the asset to refresh. |
| `body`        | object | No       | —       | Request body                             |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "source_id": {
        "type": "string",
        "description": "The ID of the Source."
      },
      "origin_path": {
        "type": "string",
        "description": "The origin path of the asset to refresh."
      },
      "body": {
        "type": "object",
        "description": "Request body"
      }
    },
    "required": [
      "PCID",
      "source_id",
      "origin_path"
    ]
  }
  ```
</Expandable>

***

## imgix\_unpublish\_asset

Unpublish an asset

**Parameters:**

| Parameter | Type   | Required | Default | Description    |
| --------- | ------ | -------- | ------- | -------------- |
| `data`    | object | Yes      | —       | The data value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "data": {
        "type": "object",
        "description": "The data value",
        "properties": {
          "type": {
            "type": "string",
            "description": "Resource type, must be 'unpublishes'.",
            "enum": [
              "unpublishes"
            ]
          },
          "attributes": {
            "type": "object",
            "description": "The attributes value"
          }
        },
        "required": [
          "type",
          "attributes"
        ]
      }
    },
    "required": [
      "PCID",
      "data"
    ]
  }
  ```
</Expandable>

***

## imgix\_update\_asset

Update asset metadata

**Parameters:**

| Parameter     | Type   | Required | Default | Description                   |
| ------------- | ------ | -------- | ------- | ----------------------------- |
| `source_id`   | string | Yes      | —       | The ID of the Source.         |
| `origin_path` | string | Yes      | —       | The origin path of the asset. |
| `data`        | object | No       | —       | The data value                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "source_id": {
        "type": "string",
        "description": "The ID of the Source."
      },
      "origin_path": {
        "type": "string",
        "description": "The origin path of the asset."
      },
      "data": {
        "type": "object",
        "description": "The data value",
        "properties": {
          "id": {
            "type": "string",
            "description": "The asset ID (format: source_id/origin_path)."
          },
          "type": {
            "type": "string",
            "description": "Resource type, must be 'assets'.",
            "enum": [
              "assets"
            ]
          },
          "attributes": {
            "type": "object",
            "description": "Asset attributes to update."
          }
        }
      }
    },
    "required": [
      "PCID",
      "source_id",
      "origin_path"
    ]
  }
  ```
</Expandable>

***

## imgix\_update\_source

Update a Source

**Parameters:**

| Parameter   | Type   | Required | Default | Description                     |
| ----------- | ------ | -------- | ------- | ------------------------------- |
| `source_id` | string | Yes      | —       | The ID of the Source to update. |
| `data`      | object | No       | —       | The data value                  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "source_id": {
        "type": "string",
        "description": "The ID of the Source to update."
      },
      "data": {
        "type": "object",
        "description": "The data value",
        "properties": {
          "id": {
            "type": "string",
            "description": "The Source ID."
          },
          "type": {
            "type": "string",
            "description": "Resource type, must be 'sources'.",
            "enum": [
              "sources"
            ]
          },
          "attributes": {
            "type": "object",
            "description": "Source attributes to update. All fields are optional."
          }
        }
      }
    },
    "required": [
      "PCID",
      "source_id"
    ]
  }
  ```
</Expandable>