For AI agents: an index of this documentation is at https://developer.rippling.com/llms.txt. Public pages have a Markdown version at the same URL with .md added.

Skip to main content
Article

FileDocumentDTO

Response DTO for ``POST /files/`` and ``GET /files/{id}``.

Use with AI:Rippling AI ChatGPT Claude Cursor

FileDocumentDTO

Response DTO for POST /files/ and GET /files/{id}.

    id stringrequired

    Opaque identifier for this file

    status stringrequired

    Lifecycle status: awaiting_upload | uploaded | active | infected

    display_name string

    Human-readable label for the file

    content_type string

    MIME type supplied by the client at create time

    upload_url string

    S3 endpoint URL — POST your multipart form here to upload the file. Present only in the create response.

    upload_fields object

    Required form fields to include in the multipart POST to S3 alongside the file binary

    url_data

    object

    Nested DTO containing URLs for accessing an uploaded file.

    s3_url string

    S3 URL where the file is accessible after upload

    preview_url string

    CDN URL for previewing the uploaded file after upload completes