# Placeholders

{% hint style="warning" %}
**If you want to recheck files**\
**--metadata-update after updating the config**
{% endhint %}

<details>

<summary><mark style="color:red;">Windows path warning</mark></summary>

<mark style="color:red;">**`\ should be escaped or replaced with a \\ or /`**</mark>

<mark style="color:red;">**`Not doing this could lead to an error`**</mark>

<mark style="color:red;">**`Examples:`**</mark>

```
C:\Users\John.config\ofscraper\bin\ffmpeg.exe => 
```

```
C:\Users\John.config\ofscraper\bin\ffmpeg.exe => 
C:/Users/John.config/ofscraper/bin/ffmpeg.exe
```

</details>

## Example of generated filenames

The placeholders described below will substitute the {} values

{% content-ref url="/pages/jrlNGOJkoW97nQV30uHK" %}
[Example Configs](/of-scraper/getting-started/config-options/example-configs.md)
{% endcontent-ref %}

```
"file_options": {
            "save_location": "/home/james/Data/ofscraper",
            "dir_format": "/{model_username}/{responsetype}/{mediatype}/",
            "file_format": "{filename}.{ext}",
            "textlength": 0,
            "space-replacer": " ",
            "date": "MM-DD-YYYY",
            "text_type_default": "letter",
            "truncation_default": true
        },
```

The generated filename based on the example config would be

```
/home/James/Data/ofscraper/{model_username}/{responsetype}/
{mediatype}/{filename}.{ext}
```

***

{% hint style="info" %}
**Placeholders are generally the same between options here**
{% endhint %}

## dir\_path and filename

{% hint style="info" %}
**You may use placeholders without any underscores (\_)**
{% endhint %}

```

{response_type}=Posts,Messages,Paid,etc
{post_id}= ID of post
{media_id} =ID of media

{file_name} = the filename, videos wills include the quality i.e source,720
{only_file_name}= the filename,videos will not include quality
{original_filename}= filename as sent by onlyfans, may or may not include source

{media_type}=Images,Audios,Videos
{quality} = quality of the media, none videos will always be source

{value}=The content's value: Whether it's categorized as Paid or Free.

{model_id}= Unique identification number for model

{first_letter}= first letter of model's username

{site_name} = Onlyfans
{text} = The text within the media. Truncation of file names has been tested to fit within OS limits, 
still it's advisable to establish a text length limit.
{date}= The date of the post, outputed in the config date format

{model_username} = The model's username
{username} = The model's username
{profile} = The currently active profile
{my_username}=The authorized account's username
{my_id} = The identification number 
for the  authorized account
{label} = The label assigned to the post, if available
{download_type}= Indication of whether it's protected or normal, 
determined by the necessity for decryption

{current_price}= Free if current price is 0 dollars else paid
{regular_price}=Free if regular price is 0 dollars else paid
{promo_price}= Free if promo price is 0 dollars else paid
{renewal_price}= Free if renewal price is 0 dollars else paid
{args}= the passed arguments namespace, keys can be access 
with the dot (.) syntax
{config}= the config arguments dictionary, keys can be access 
with the [] syntax
{modelObj} = model data class via class folder, properties can be access 
via the dot (.) syntax
{configPath} = path to current config directory

```

### dir\_path

The  relative directory path within the save location where files are stored

{% hint style="info" %}
**No unique placeholders**
{% endhint %}

### filename

The file's name segment in the saved file

{% hint style="info" %}
**When configuring filenames, ensure a unique element such as text, media ID, post ID, or filename is added to avoid naming conflict**
{% endhint %}

```
{ext} = The file extension of the media

```

***

## Text Placeholders

{% hint style="info" %}
**Text mediatype will most likely need a overwrite to work properly**
{% endhint %}

Text files are based on posts and have access to all the same placeholders as other media **except**&#x20;

<pre><code>- media_id 
<strong>- download type
</strong></code></pre>

Some placeholders will be changed

<pre><code>- filename is replace with text
<strong>- quality will always be Source
</strong>- media_type will always be "Text"

</code></pre>

{% content-ref url="/pages/AzC8ftoWjPqnb37nZCWr" %}
[Downloading Text Files](/of-scraper/using-the-scraper/batch-scraping-and-bot-actions/basic-actions/selecting-posts/downloading-text-files.md)
{% endcontent-ref %}

{% content-ref url="/pages/nZpCznEwGWwZ7KL3XLiS" %}
[Broken mention](broken://pages/nZpCznEwGWwZ7KL3XLiS)
{% endcontent-ref %}

***

## metadata

Controls where metadata is save

{% content-ref url="/pages/DA9pbtluodnxm8xdStBZ" %}
[Setting metadata path](/of-scraper/getting-started/config-options/setting-metadata-path.md)
{% endcontent-ref %}

***

## response\_type placeholder

{% content-ref url="/pages/aOEHPXdI8Q4QWua6CYux" %}
[Responsetype Placeholders](/of-scraper/getting-started/config-options/options/file-output-options/remapping-responsetype.md)
{% endcontent-ref %}


---

# Agent Instructions: 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:

```
GET https://of-scraper.gitbook.io/of-scraper/getting-started/config-options/options/file-output-options/customizing-save-path.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.