@inductiv/node-red-openai-api/src/container-files/help.html

Enhance your Node-RED projects with advanced AI capabilities.

<section>
    <details>
        <summary style="font-weight: bold;">🗄️ Container Files</summary>
        <a href="https://platform.openai.com/docs/api-reference/container-files" target="_blank">Official Documentation
            <i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>

        <h4 style="font-weight: bolder;"> ⋙ Create Container File</h4>
        <p>Create a container file.</p>
        <dl class="message-properties">
            <h4>msg.payload Properties</h4>

            <dt>
                container_id
                <a href="https://platform.openai.com/docs/api-reference/container-files/createContainerFile#container-files-createcontainerfile-container_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the container to hold the file.</dd>

            <dt class="optional">
                file
                <a href="https://platform.openai.com/docs/api-reference/container-files/createContainerFile#container-files-createcontainerfile-file"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">file</span>
            </dt>
            <dd>The File object (not file name) to be uploaded.</dd>

            <dt class="optional">
                file_id
                <a href="https://platform.openai.com/docs/api-reference/container-files/createContainerFile#container-files-createcontainerfile-file_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>Name of the file to create.</dd>
        </dl>

        <h4 style="font-weight: bolder;"> ⋙ List Container Files</h4>
        <p>List container files.</p>
        <dl class="message-properties">
            <h4>msg.payload Properties</h4>

            <dt>
                container_id
                <a href="https://platform.openai.com/docs/api-reference/container-files/listContainerFiles#container-files-listcontainerfiles-container_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the desired container.</dd>

            <dt class="optional">
                after
                <a href="https://platform.openai.com/docs/api-reference/container-files/listContainerFiles#container-files-listcontainerfiles-after"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>A cursor for use in pagination. `after` is an object ID that defines your place in the list.</dd>

            <dt class="optional">
                limit
                <a href="https://platform.openai.com/docs/api-reference/container-files/listContainerFiles#container-files-listcontainerfiles-limit"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">integer</span>
            </dt>
            <dd>A limit on the number of objects to be returned.</dd>

            <dt class="optional">
                order
                <a href="https://platform.openai.com/docs/api-reference/container-files/listContainerFiles#container-files-listcontainerfiles-order"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>Sort order by the created_at timestamp of the objects.</dd>
        </dl>

        <h4 style="font-weight: bolder;"> ⋙ Retrieve Container File</h4>
        <p>Retrieve a container file.</p>
        <dl class="message-properties">
            <h4>msg.payload Properties</h4>

            <dt>
                container_id
                <a href="https://platform.openai.com/docs/api-reference/container-files/retrieveContainerFile#container-files-retrievecontainerfile-container_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the desired container.</dd>

            <dt>
                file_id
                <a href="https://platform.openai.com/docs/api-reference/container-files/retrieveContainerFile#container-files-retrievecontainerfile-container_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the file to retrieve.</dd>
        </dl>

        <h4 style="font-weight: bolder;"> ⋙ Retrieve Container File Content</h4>
        <p>Retrieves container file content.</p>
        <dl class="message-properties">
            <h4>msg.payload Properties</h4>

            <dt>
                container_id
                <a href="https://platform.openai.com/docs/api-reference/container-files/retrieveContainerFileContent#container-files-retrievecontainerfilecontent-container_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the desired container.</dd>

            <dt>
                file_id
                <a href="https://platform.openai.com/docs/api-reference/container-files/retrieveContainerFileContent#container-files-retrievecontainerfilecontent-file_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the desired file.</dd>

        </dl>

        <h4 style="font-weight: bolder;"> ⋙ Delete Container File</h4>
        <p>Deletes a container file.</p>
        <dl class="message-properties">
            <h4>msg.payload Properties</h4>

            <dt>
                container_id
                <a href="https://platform.openai.com/docs/api-reference/container-files/deleteContainerFile#container-files-deletecontainerfile-container_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the desired container.</dd>

            <dt>
                file_id
                <a href="https://platform.openai.com/docs/api-reference/container-files/deleteContainerFile#container-files-deletecontainerfile-file_id"
                    target="_blank"><i class="fa fa-external-link fa-sm" aria-hidden="true"></i></a>
                <span class="property-type">string</span>
            </dt>
            <dd>The ID of the file to delete.</dd>

        </dl>

    </details>
</section>