> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# reserve • AI Agent SDK

> reserve: Reserve an entry for an incoming file and return its ``ref_id``.

# reserve

<div className="flex items-center gap-2">
  <Badge color="purple">Method</Badge>
</div>

> This is a method of the [**AttachmentStoreProtocol**](../classes/AttachmentStoreProtocol) class in the [**protocols**](../modules/protocols) module.

Reserve an entry for an incoming file and return its `ref_id`.

## Signature

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
def reserve(filename: str, mime: str, size: int) -> str
```

## Parameters

<ParamField query="filename" type="str" required={true}>
  No description available.
</ParamField>

<ParamField query="mime" type="str" required={true}>
  No description available.
</ParamField>

<ParamField query="size" type="int" required={true}>
  No description available.
</ParamField>

### Returns

<ResponseField name="Returns" type="str">
  The result of the operation.
</ResponseField>

## Source

<Card title="View on GitHub" icon="github" href="https://github.com/MervinPraison/PraisonAI/blob/main/src/praisonai-agents/praisonaiagents/gateway/protocols.py#L677">
  `praisonaiagents/gateway/protocols.py` at line 677
</Card>