> ## 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.

# docsumo

> Document Processing API

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

## Tools

| Tool                                                                              | Description                       |
| --------------------------------------------------------------------------------- | --------------------------------- |
| [`docsumo_delete_document`](#docsumo_delete_document)                             | Delete a document                 |
| [`docsumo_get_document_detail`](#docsumo_get_document_detail)                     | Get document details              |
| [`docsumo_get_documents_summary`](#docsumo_get_documents_summary)                 | Get documents summary             |
| [`docsumo_get_extracted_data_full`](#docsumo_get_extracted_data_full)             | Get extracted data (full)         |
| [`docsumo_get_extracted_data_simplified`](#docsumo_get_extracted_data_simplified) | Get extracted data (simplified)   |
| [`docsumo_get_folder_review_url`](#docsumo_get_folder_review_url)                 | Get folder review URL             |
| [`docsumo_get_table_data`](#docsumo_get_table_data)                               | Get database table data           |
| [`docsumo_get_user_details`](#docsumo_get_user_details)                           | Get user details and credit limit |
| [`docsumo_list_documents`](#docsumo_list_documents)                               | List all documents                |
| [`docsumo_update_review_status`](#docsumo_update_review_status)                   | Update document review status     |
| [`docsumo_upload_document_custom`](#docsumo_upload_document_custom)               | Upload document via URL or base64 |

***

## docsumo\_delete\_document

Delete a document

**Parameters:**

| Parameter | Type   | Required | Default | Description                 |
| --------- | ------ | -------- | ------- | --------------------------- |
| `doc_id`  | string | Yes      | —       | Unique document identifier. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "doc_id": {
        "type": "string",
        "description": "Unique document identifier."
      }
    },
    "required": [
      "PCID",
      "doc_id"
    ]
  }
  ```
</Expandable>

***

## docsumo\_get\_document\_detail

Get document details

**Parameters:**

| Parameter | Type   | Required | Default | Description                 |
| --------- | ------ | -------- | ------- | --------------------------- |
| `doc_id`  | string | Yes      | —       | Unique document identifier. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "doc_id": {
        "type": "string",
        "description": "Unique document identifier."
      }
    },
    "required": [
      "PCID",
      "doc_id"
    ]
  }
  ```
</Expandable>

***

## docsumo\_get\_documents\_summary

Get documents summary

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

***

## docsumo\_get\_extracted\_data\_full

Get extracted data (full)

**Parameters:**

| Parameter | Type   | Required | Default | Description                 |
| --------- | ------ | -------- | ------- | --------------------------- |
| `doc_id`  | string | Yes      | —       | Unique document identifier. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "doc_id": {
        "type": "string",
        "description": "Unique document identifier."
      }
    },
    "required": [
      "PCID",
      "doc_id"
    ]
  }
  ```
</Expandable>

***

## docsumo\_get\_extracted\_data\_simplified

Get extracted data (simplified)

**Parameters:**

| Parameter | Type   | Required | Default | Description                 |
| --------- | ------ | -------- | ------- | --------------------------- |
| `doc_id`  | string | Yes      | —       | Unique document identifier. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "doc_id": {
        "type": "string",
        "description": "Unique document identifier."
      }
    },
    "required": [
      "PCID",
      "doc_id"
    ]
  }
  ```
</Expandable>

***

## docsumo\_get\_folder\_review\_url

Get folder review URL

**Parameters:**

| Parameter   | Type   | Required | Default | Description               |
| ----------- | ------ | -------- | ------- | ------------------------- |
| `folder_id` | string | Yes      | —       | Unique folder identifier. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "folder_id": {
        "type": "string",
        "description": "Unique folder identifier."
      }
    },
    "required": [
      "PCID",
      "folder_id"
    ]
  }
  ```
</Expandable>

***

## docsumo\_get\_table\_data

Get database table data

**Parameters:**

| Parameter | Type   | Required | Default | Description        |
| --------- | ------ | -------- | ------- | ------------------ |
| `ddid`    | string | Yes      | —       | Database table ID. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "ddid": {
        "type": "string",
        "description": "Database table ID."
      }
    },
    "required": [
      "PCID",
      "ddid"
    ]
  }
  ```
</Expandable>

***

## docsumo\_get\_user\_details

Get user details and credit limit

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

***

## docsumo\_list\_documents

List all documents

**Parameters:**

| Parameter      | Type    | Required | Default | Description                                                                                                                                  |
| -------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `view`         | string  | No       | —       | Controls document filtering. Use 'files' for files only, 'folder' for folder contents (requires folder\_id), or 'all\_files' for everything. |
| `folder_id`    | string  | No       | —       | Folder ID to list documents from. Required when view is 'folder'.                                                                            |
| `limit`        | integer | No       | —       | Maximum number of documents to return per page (0-20).                                                                                       |
| `offset`       | integer | No       | —       | Number of records to skip for pagination.                                                                                                    |
| `doc_type`     | string  | No       | —       | Filter by document type (obtain available types from getUserDetails).                                                                        |
| `status`       | string  | No       | —       | Filter by processing status.                                                                                                                 |
| `q`            | string  | No       | —       | Search query to filter documents by title (partial matching).                                                                                |
| `sort_by`      | string  | No       | —       | Sort order for results.                                                                                                                      |
| `created_date` | string  | No       | —       | Date range filter. Use format 'gte:YYYY-MM-DD' or 'lte:YYYY-MM-DD'.                                                                          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "view": {
        "type": "string",
        "description": "Controls document filtering. Use 'files' for files only, 'folder' for folder contents (requires folder_id), or 'all_files' for everything.",
        "enum": [
          "files",
          "folder",
          "all_files"
        ]
      },
      "folder_id": {
        "type": "string",
        "description": "Folder ID to list documents from. Required when view is 'folder'."
      },
      "limit": {
        "type": "integer",
        "description": "Maximum number of documents to return per page (0-20)."
      },
      "offset": {
        "type": "integer",
        "description": "Number of records to skip for pagination."
      },
      "doc_type": {
        "type": "string",
        "description": "Filter by document type (obtain available types from getUserDetails)."
      },
      "status": {
        "type": "string",
        "description": "Filter by processing status.",
        "enum": [
          "reviewing",
          "processed",
          "erred"
        ]
      },
      "q": {
        "type": "string",
        "description": "Search query to filter documents by title (partial matching)."
      },
      "sort_by": {
        "type": "string",
        "description": "Sort order for results.",
        "enum": [
          "created_date.asc",
          "created_date.desc"
        ]
      },
      "created_date": {
        "type": "string",
        "description": "Date range filter. Use format 'gte:YYYY-MM-DD' or 'lte:YYYY-MM-DD'."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## docsumo\_update\_review\_status

Update document review status

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                             |
| --------- | ------- | -------- | ------- | ----------------------------------------------------------------------- |
| `doc_id`  | string  | Yes      | —       | Unique document identifier.                                             |
| `action`  | string  | Yes      | —       | Review action to perform.                                               |
| `forced`  | boolean | No       | —       | Forces status change even with validation errors.                       |
| `strict`  | boolean | No       | —       | Fails if validation errors exist. Only applicable when action is 'end'. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "doc_id": {
        "type": "string",
        "description": "Unique document identifier."
      },
      "action": {
        "type": "string",
        "description": "Review action to perform.",
        "enum": [
          "start",
          "end",
          "skip"
        ]
      },
      "forced": {
        "type": "boolean",
        "description": "Forces status change even with validation errors."
      },
      "strict": {
        "type": "boolean",
        "description": "Fails if validation errors exist. Only applicable when action is 'end'."
      }
    },
    "required": [
      "PCID",
      "doc_id",
      "action"
    ]
  }
  ```
</Expandable>

***

## docsumo\_upload\_document\_custom

Upload document via URL or base64

**Parameters:**

| Parameter       | Type    | Required | Default | Description                                                                         |
| --------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------- |
| `doc_meta_data` | string  | No       | —       | JSON string with additional metadata to attach to the document.                     |
| `file`          | string  | Yes      | —       | Public URL of the document or base64-encoded file content.                          |
| `file_type`     | string  | Yes      | —       | Indicates whether the file field contains a URL or base64-encoded content.          |
| `filename`      | string  | No       | —       | File name with extension. Required when file\_type is 'base64'.                     |
| `password`      | string  | No       | —       | Password for password-protected documents.                                          |
| `review_token`  | boolean | No       | —       | When true, generates a shareable review URL for the document.                       |
| `type`          | string  | Yes      | —       | Document type for processing (obtain available types from getUserDetails endpoint). |
| `user_doc_id`   | string  | No       | —       | Internal tracking identifier for the document.                                      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "doc_meta_data": {
        "type": "string",
        "description": "JSON string with additional metadata to attach to the document."
      },
      "file": {
        "type": "string",
        "description": "Public URL of the document or base64-encoded file content."
      },
      "file_type": {
        "type": "string",
        "description": "Indicates whether the file field contains a URL or base64-encoded content.",
        "enum": [
          "url",
          "base64"
        ]
      },
      "filename": {
        "type": "string",
        "description": "File name with extension. Required when file_type is 'base64'."
      },
      "password": {
        "type": "string",
        "description": "Password for password-protected documents."
      },
      "review_token": {
        "type": "boolean",
        "description": "When true, generates a shareable review URL for the document."
      },
      "type": {
        "type": "string",
        "description": "Document type for processing (obtain available types from getUserDetails endpoint)."
      },
      "user_doc_id": {
        "type": "string",
        "description": "Internal tracking identifier for the document."
      }
    },
    "required": [
      "PCID",
      "file",
      "file_type",
      "type"
    ]
  }
  ```
</Expandable>