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

# mistral-libraries

> Mistral Libraries - knowledge libraries and documents

**Server path:** `/mistral-libraries` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                            | Description                                                      |
| ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| [`mistral_libraries_create_v1`](#mistral_libraries_create_v1)                                                                   | Create a new Library.                                            |
| [`mistral_libraries_delete_v1`](#mistral_libraries_delete_v1)                                                                   | Delete a library and all of it's document.                       |
| [`mistral_libraries_documents_delete_v1`](#mistral_libraries_documents_delete_v1)                                               | Delete a document.                                               |
| [`mistral_libraries_documents_get_extracted_text_signed_url_v1`](#mistral_libraries_documents_get_extracted_text_signed_url_v1) | Retrieve the signed URL of text extracted from a given document. |
| [`mistral_libraries_documents_get_signed_url_v1`](#mistral_libraries_documents_get_signed_url_v1)                               | Retrieve the signed URL of a specific document.                  |
| [`mistral_libraries_documents_get_status_v1`](#mistral_libraries_documents_get_status_v1)                                       | Retrieve the processing status of a specific document.           |
| [`mistral_libraries_documents_get_text_content_v1`](#mistral_libraries_documents_get_text_content_v1)                           | Retrieve the text content of a specific document.                |
| [`mistral_libraries_documents_get_v1`](#mistral_libraries_documents_get_v1)                                                     | Retrieve the metadata of a specific document.                    |
| [`mistral_libraries_documents_list_v1`](#mistral_libraries_documents_list_v1)                                                   | List documents in a given library.                               |
| [`mistral_libraries_documents_reprocess_v1`](#mistral_libraries_documents_reprocess_v1)                                         | Reprocess a document.                                            |
| [`mistral_libraries_documents_update_v1`](#mistral_libraries_documents_update_v1)                                               | Update the metadata of a specific document.                      |
| [`mistral_libraries_documents_upload_v1`](#mistral_libraries_documents_upload_v1)                                               | Upload a new document.                                           |
| [`mistral_libraries_get_v1`](#mistral_libraries_get_v1)                                                                         | Detailed information about a specific Library.                   |
| [`mistral_libraries_list_v1`](#mistral_libraries_list_v1)                                                                       | List all libraries you have access to.                           |
| [`mistral_libraries_share_create_v1`](#mistral_libraries_share_create_v1)                                                       | Create or update an access level.                                |
| [`mistral_libraries_share_delete_v1`](#mistral_libraries_share_delete_v1)                                                       | Delete an access level.                                          |
| [`mistral_libraries_share_list_v1`](#mistral_libraries_share_list_v1)                                                           | List all of the access to this library.                          |
| [`mistral_libraries_update_v1`](#mistral_libraries_update_v1)                                                                   | Update a library.                                                |

***

## mistral\_libraries\_create\_v1

Create a new Library.

**Parameters:**

| Parameter     | Type    | Required | Default | Description    |                       |
| ------------- | ------- | -------- | ------- | -------------- | --------------------- |
| `chunk_size`  | integer | null     | No      | —              | Chunk Size            |
| `description` | string  | null     | No      | —              | The description value |
| `name`        | string  | Yes      | —       | The name value |                       |

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

***

## mistral\_libraries\_delete\_v1

Delete a library and all of it's document.

**Parameters:**

| Parameter    | Type   | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `library_id` | string | Yes      | —       | Library Id  |

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

***

## mistral\_libraries\_documents\_delete\_v1

Delete a document.

**Parameters:**

| Parameter     | Type   | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------- |
| `library_id`  | string | Yes      | —       | Library Id  |
| `document_id` | string | Yes      | —       | Document Id |

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

***

## mistral\_libraries\_documents\_get\_extracted\_text\_signed\_url\_v1

Retrieve the signed URL of text extracted from a given document.

**Parameters:**

| Parameter     | Type   | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------- |
| `library_id`  | string | Yes      | —       | Library Id  |
| `document_id` | string | Yes      | —       | Document Id |

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

***

## mistral\_libraries\_documents\_get\_signed\_url\_v1

Retrieve the signed URL of a specific document.

**Parameters:**

| Parameter     | Type   | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------- |
| `library_id`  | string | Yes      | —       | Library Id  |
| `document_id` | string | Yes      | —       | Document Id |

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

***

## mistral\_libraries\_documents\_get\_status\_v1

Retrieve the processing status of a specific document.

**Parameters:**

| Parameter     | Type   | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------- |
| `library_id`  | string | Yes      | —       | Library Id  |
| `document_id` | string | Yes      | —       | Document Id |

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

***

## mistral\_libraries\_documents\_get\_text\_content\_v1

Retrieve the text content of a specific document.

**Parameters:**

| Parameter     | Type   | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------- |
| `library_id`  | string | Yes      | —       | Library Id  |
| `document_id` | string | Yes      | —       | Document Id |

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

***

## mistral\_libraries\_documents\_get\_v1

Retrieve the metadata of a specific document.

**Parameters:**

| Parameter     | Type   | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------- |
| `library_id`  | string | Yes      | —       | Library Id  |
| `document_id` | string | Yes      | —       | Document Id |

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

***

## mistral\_libraries\_documents\_list\_v1

List documents in a given library.

**Parameters:**

| Parameter            | Type    | Required | Default | Description                |
| -------------------- | ------- | -------- | ------- | -------------------------- |
| `library_id`         | string  | Yes      | —       | Library Id                 |
| `search`             | string  | No       | —       | The search value           |
| `page_size`          | integer | No       | —       | Number of results per page |
| `page`               | integer | No       | —       | Page number for pagination |
| `filters_attributes` | string  | No       | —       | Filters Attributes         |
| `sort_by`            | string  | No       | —       | Sort By                    |
| `sort_order`         | string  | No       | —       | Sort Order                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "library_id": {
        "type": "string",
        "description": "Library Id"
      },
      "search": {
        "type": "string",
        "description": "The search value"
      },
      "page_size": {
        "type": "integer",
        "description": "Number of results per page"
      },
      "page": {
        "type": "integer",
        "description": "Page number for pagination"
      },
      "filters_attributes": {
        "type": "string",
        "description": "Filters Attributes"
      },
      "sort_by": {
        "type": "string",
        "description": "Sort By"
      },
      "sort_order": {
        "type": "string",
        "description": "Sort Order"
      }
    },
    "required": [
      "PCID",
      "library_id"
    ]
  }
  ```
</Expandable>

***

## mistral\_libraries\_documents\_reprocess\_v1

Reprocess a document.

**Parameters:**

| Parameter     | Type   | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------- |
| `library_id`  | string | Yes      | —       | Library Id  |
| `document_id` | string | Yes      | —       | Document Id |

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

***

## mistral\_libraries\_documents\_update\_v1

Update the metadata of a specific document.

**Parameters:**

| Parameter     | Type   | Required | Default | Description          |                |
| ------------- | ------ | -------- | ------- | -------------------- | -------------- |
| `library_id`  | string | Yes      | —       | Library Id           |                |
| `document_id` | string | Yes      | —       | Document Id          |                |
| `attributes`  | object | No       | —       | The attributes value |                |
| `name`        | string | null     | No      | —                    | The name value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "library_id": {
        "type": "string",
        "description": "Library Id"
      },
      "document_id": {
        "type": "string",
        "description": "Document Id"
      },
      "attributes": {
        "type": "object",
        "description": "The attributes value"
      },
      "name": {
        "type": [
          "string",
          "null"
        ],
        "description": "The name value"
      }
    },
    "required": [
      "PCID",
      "library_id",
      "document_id"
    ]
  }
  ```
</Expandable>

***

## mistral\_libraries\_documents\_upload\_v1

Upload a new document.

**Parameters:**

| Parameter    | Type   | Required | Default | Description                                                                                                                                                                                                                                                                                                 |
| ------------ | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `library_id` | string | Yes      | —       | Library Id                                                                                                                                                                                                                                                                                                  |
| `file`       | string | Yes      | —       | The File object (not file name) to be uploaded.  To upload a file and specify a custom file name you should format your request as such:  `bash  file=@path/to/your/file.jsonl;filename=custom_name.jsonl  `  Otherwise, you can just keep the original file name:  `bash  file=@path/to/your/file.jsonl  ` |

<Expandable title="inputSchema">
  ````json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "library_id": {
        "type": "string",
        "description": "Library Id"
      },
      "file": {
        "type": "string",
        "description": "The File object (not file name) to be uploaded.  To upload a file and specify a custom file name you should format your request as such:  ```bash  file=@path/to/your/file.jsonl;filename=custom_name.jsonl  ```  Otherwise, you can just keep the original file name:  ```bash  file=@path/to/your/file.jsonl  ```"
      }
    },
    "required": [
      "PCID",
      "library_id",
      "file"
    ]
  }
  ````
</Expandable>

***

## mistral\_libraries\_get\_v1

Detailed information about a specific Library.

**Parameters:**

| Parameter    | Type   | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `library_id` | string | Yes      | —       | Library Id  |

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

***

## mistral\_libraries\_list\_v1

List all libraries you have access to.

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

***

## mistral\_libraries\_share\_create\_v1

Create or update an access level.

**Parameters:**

| Parameter         | Type   | Required | Default | Description                                                          |        |
| ----------------- | ------ | -------- | ------- | -------------------------------------------------------------------- | ------ |
| `library_id`      | string | Yes      | —       | Library Id                                                           |        |
| `level`           | string | Yes      | —       | The level value                                                      |        |
| `org_id`          | string | null     | No      | —                                                                    | Org Id |
| `share_with_type` | string | Yes      | —       | The type of entity, used to share a library.                         |        |
| `share_with_uuid` | string | Yes      | —       | The id of the entity (user, workspace or organization) to share with |        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "library_id": {
        "type": "string",
        "description": "Library Id"
      },
      "level": {
        "type": "string",
        "description": "The level value",
        "enum": [
          "Viewer",
          "Editor"
        ]
      },
      "org_id": {
        "type": [
          "string",
          "null"
        ],
        "description": "Org Id"
      },
      "share_with_type": {
        "type": "string",
        "description": "The type of entity, used to share a library.",
        "enum": [
          "User",
          "Workspace",
          "Org"
        ]
      },
      "share_with_uuid": {
        "type": "string",
        "description": "The id of the entity (user, workspace or organization) to share with"
      }
    },
    "required": [
      "PCID",
      "library_id",
      "level",
      "share_with_type",
      "share_with_uuid"
    ]
  }
  ```
</Expandable>

***

## mistral\_libraries\_share\_delete\_v1

Delete an access level.

**Parameters:**

| Parameter         | Type   | Required | Default | Description                                                          |        |
| ----------------- | ------ | -------- | ------- | -------------------------------------------------------------------- | ------ |
| `library_id`      | string | Yes      | —       | Library Id                                                           |        |
| `org_id`          | string | null     | No      | —                                                                    | Org Id |
| `share_with_type` | string | Yes      | —       | The type of entity, used to share a library.                         |        |
| `share_with_uuid` | string | Yes      | —       | The id of the entity (user, workspace or organization) to share with |        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "library_id": {
        "type": "string",
        "description": "Library Id"
      },
      "org_id": {
        "type": [
          "string",
          "null"
        ],
        "description": "Org Id"
      },
      "share_with_type": {
        "type": "string",
        "description": "The type of entity, used to share a library.",
        "enum": [
          "User",
          "Workspace",
          "Org"
        ]
      },
      "share_with_uuid": {
        "type": "string",
        "description": "The id of the entity (user, workspace or organization) to share with"
      }
    },
    "required": [
      "PCID",
      "library_id",
      "share_with_type",
      "share_with_uuid"
    ]
  }
  ```
</Expandable>

***

## mistral\_libraries\_share\_list\_v1

List all of the access to this library.

**Parameters:**

| Parameter    | Type   | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ----------- |
| `library_id` | string | Yes      | —       | Library Id  |

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

***

## mistral\_libraries\_update\_v1

Update a library.

**Parameters:**

| Parameter     | Type   | Required | Default | Description |                       |
| ------------- | ------ | -------- | ------- | ----------- | --------------------- |
| `library_id`  | string | Yes      | —       | Library Id  |                       |
| `description` | string | null     | No      | —           | The description value |
| `name`        | string | null     | No      | —           | The name value        |

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