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

# Upload a file

> Uploads a file once (multipart/form-data, the field file) and answers its media id, for media_id in any send. The app's own rules: pictures JPEG or PNG (HEIC and WEBP are turned into JPEG, a larger picture made smaller), videos MP4 or 3GPP, documents; the largest image 5 MB, video 16 MB, document 100 MB. For a sticker, add the field type=sticker: a WEBP file of at most 500 KB, kept as it is.

Permission: A Full or Send only key.



## OpenAPI

````yaml /openapi.json post /v1/media
openapi: 3.1.0
info:
  title: GetReply API
  version: 1.0.0
  description: >-
    Send WhatsApp messages, templates, OTPs and campaigns from your own
    software. Every request needs an API key (Developer → API keys) as a Bearer
    token.


    Requests sent here are real and charged like any other.
servers:
  - url: https://api.getreply.in
    description: GetReply
security:
  - bearerAuth: []
tags:
  - name: Account
  - name: Messages
  - name: Templates
  - name: Contacts
  - name: Inbox
  - name: Campaigns
  - name: Webhooks
paths:
  /v1/media:
    post:
      tags:
        - Messages
      summary: Upload a file
      description: >-
        Uploads a file once (multipart/form-data, the field file) and answers
        its media id, for media_id in any send. The app's own rules: pictures
        JPEG or PNG (HEIC and WEBP are turned into JPEG, a larger picture made
        smaller), videos MP4 or 3GPP, documents; the largest image 5 MB, video
        16 MB, document 100 MB. For a sticker, add the field type=sticker: a
        WEBP file of at most 500 KB, kept as it is.


        Permission: A Full or Send only key.
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            Your own unique id for this request (at most 255 characters). The
            same id and body within 24 hours answers the first answer again —
            never a second send or charge.
          schema:
            type: string
            maxLength: 255
          example: upload-invoice-4521
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - file
              properties:
                file:
                  type: string
                  format: binary
                type:
                  type: string
                  enum:
                    - sticker
      responses:
        '201':
          description: Uploaded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadedMedia'
        '400':
          description: 'validation_error: Some fields are missing or wrong.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                validation_error:
                  value:
                    error:
                      code: validation_error
                      message: Some fields are missing or wrong.
        '401':
          description: 'unauthorized: API key is missing or not valid.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                unauthorized:
                  value:
                    error:
                      code: unauthorized
                      message: API key is missing or not valid.
        '403':
          description: >-
            key_off: This API key is switched off. · forbidden_scope: This API
            key isn't allowed to do this. · ip_not_allowed: Requests from this
            IP address aren't allowed for this key. · needs_pro_plan: The API
            needs the Pro plan. · plan_ended: Your plan has ended. Renew it to
            send messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                key_off:
                  value:
                    error:
                      code: key_off
                      message: This API key is switched off.
                forbidden_scope:
                  value:
                    error:
                      code: forbidden_scope
                      message: This API key isn't allowed to do this.
                ip_not_allowed:
                  value:
                    error:
                      code: ip_not_allowed
                      message: >-
                        Requests from this IP address aren't allowed for this
                        key.
                needs_pro_plan:
                  value:
                    error:
                      code: needs_pro_plan
                      message: The API needs the Pro plan.
                plan_ended:
                  value:
                    error:
                      code: plan_ended
                      message: Your plan has ended. Renew it to send messages.
        '409':
          description: >-
            request_id_reused: This request ID was already used for a different
            request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                request_id_reused:
                  value:
                    error:
                      code: request_id_reused
                      message: >-
                        This request ID was already used for a different
                        request.
        '422':
          description: >-
            media_too_large: The media file is too large. ·
            media_type_not_allowed: This file type can't be sent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                media_too_large:
                  value:
                    error:
                      code: media_too_large
                      message: The media file is too large.
                media_type_not_allowed:
                  value:
                    error:
                      code: media_type_not_allowed
                      message: This file type can't be sent.
        '429':
          description: 'rate_limited: Too many requests. Try again in a few seconds.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                rate_limited:
                  value:
                    error:
                      code: rate_limited
                      message: Too many requests. Try again in a few seconds.
        '500':
          description: 'server_error: Something went wrong on our side. Try again.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                server_error:
                  value:
                    error:
                      code: server_error
                      message: Something went wrong on our side. Try again.
components:
  schemas:
    UploadedMedia:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
            - image
            - video
            - document
            - sticker
        mime_type:
          type: string
        filename:
          type: string
        size:
          type: integer
        created_at:
          type: string
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            field:
              type: string
              description: The one field that is wrong, when there is one.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. gr_live_…

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.