Skip to content

attachments

Bases: BaseAttachments

Source code in airia/client/attachments/sync_attachments.py 
10
11
def __init__(self, request_handler: RequestHandler):
    super().__init__(request_handler)

upload_file(file_path, correlation_id=None)

Upload a file and get attachment information.

Parameters:

Name Type Description Default
file_path str

Path to the file on disk

 required
correlation_id Optional[str]

Optional correlation ID for request tracing. If not provided, one will be generated automatically.

 None

Returns:

Name Type Description
AttachmentResponse AttachmentResponse

Response containing the attachment ID and URL.

Raises:

Type Description
AiriaAPIError

If the API request fails with details about the error.
RequestException

For other request-related errors.
Example 
client = AiriaClient(api_key="your_api_key")

# Upload a file
response = client.attachments.upload_file(
    file_path="example.jpg"
)
print(f"Uploaded attachment ID: {response.id}")
print(f"Attachment URL: {response.image_url}")
Source code in airia/client/attachments/sync_attachments.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
def upload_file(
    self,
    file_path: str,
    correlation_id: Optional[str] = None,
) -> AttachmentResponse:
    """
    Upload a file and get attachment information.

    Args:
        file_path: Path to the file on disk
        correlation_id: Optional correlation ID for request tracing. If not provided,
                    one will be generated automatically.

    Returns:
        AttachmentResponse: Response containing the attachment ID and URL.

    Raises:
        AiriaAPIError: If the API request fails with details about the error.
        requests.RequestException: For other request-related errors.

    Example:
        ```python
        client = AiriaClient(api_key="your_api_key")

        # Upload a file
        response = client.attachments.upload_file(
            file_path="example.jpg"
        )
        print(f"Uploaded attachment ID: {response.id}")
        print(f"Attachment URL: {response.image_url}")
        ```
    """
    request_data = self._pre_upload_file(
        file_path=file_path,
        correlation_id=correlation_id,
        api_version=ApiVersion.V1.value,
    )

    resp = self._request_handler.make_request_multipart("POST", request_data)
    return AttachmentResponse(**resp)