> For the complete documentation index, see [llms.txt](https://guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guardian.hedera.com/docs/develop/guardian/standard-registry/policies/modules/modules-apis/preview-module-from-ipfs.md).

# Preview Module from IPFS

## Module preview from IPFS.

<mark style="color:green;">`POST`</mark> `/modules/import/message/preview`

Previews the module from IPFS without loading it into the local DB. Only users with the Standard Registry role are allowed to make the request.

#### Request Body

| Name                                        | Type   | Description                                                                                          |
| ------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------- |
| messageId<mark style="color:red;">\*</mark> | String | Object that contains the identifier of the Hedera message which contains the IPFS CID of the module. |

{% tabs %}
{% tab title="200: OK Successful Operation" %}

```javascript
{
  content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewModule'
}
```

{% endtab %}

{% tab title="401: Unauthorized Unauthorized" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="403: Forbidden Forbidden" %}

```javascript
{
    // Response
}
```

{% endtab %}

{% tab title="500: Internal Server Error Internal server Error" %}

```javascript
{
    content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://guardian.hedera.com/docs/develop/guardian/standard-registry/policies/modules/modules-apis/preview-module-from-ipfs.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
