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

# Get an upload by id

> The details of one of the account's uploads. An upload that belongs to another account is not found.



## OpenAPI

````yaml /openapi/widgetic-api-public.json get /uploads/{id}
openapi: 3.0.0
info:
  title: Widgetic API Gateway
  version: 1.0.0
  description: API documentation for the Widgetic API Gateway
  license:
    name: Widgetic Integration License
    url: https://docs.widgetic.com/resources/license
servers:
  - url: https://api.widgetic.com/v1
    description: Production server
    variables:
      env:
        default: production
        description: Environment
      apiUrl:
        default: https://api.widgetic.com
        description: API URL
      apiVersion:
        default: /v1
        description: API Version path prefix
security: []
tags: []
paths:
  /uploads/{id}:
    get:
      tags:
        - Uploads
      summary: Get an upload by id
      description: >-
        The details of one of the account's uploads. An upload that belongs to
        another account is not found.
      operationId: getUpload
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            format: uuid
          description: The upload to read
      responses:
        '200':
          description: The upload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadResponse'
        '401':
          description: The API key is missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No such upload on this account (`UPLOAD_NOT_FOUND`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    UploadResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          description: Always `true` on a success.
          example: true
        data:
          $ref: '#/components/schemas/Upload'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
    ErrorResponse:
      type: object
      required:
        - success
        - message
        - error
      additionalProperties: true
      properties:
        success:
          type: boolean
          description: Always `false` on a failure.
          example: false
        message:
          type: string
          description: The same text as `error.message`, for a caller that reads one line.
        error:
          $ref: '#/components/schemas/ErrorDetail'
    Upload:
      type: object
      description: A file stored for the account that uploaded it.
      required:
        - id
        - url
        - mime_type
        - file_name
        - file_size
        - storage_key
        - context_type
        - source
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
          format: uri
          description: The public address of the stored file
        mime_type:
          type: string
          description: >-
            The type of the stored file. A HEIC or HEIF photo is stored as
            `image/jpeg`.
          example: image/png
        file_name:
          type: string
        file_size:
          type: integer
          description: Size of the stored file, in bytes
        width:
          type: integer
          nullable: true
          description: Width in pixels, for images
        height:
          type: integer
          nullable: true
          description: Height in pixels, for images
        storage_key:
          type: string
          description: Where the file sits in its storage bucket
        context_type:
          type: string
          enum:
            - widget-codegen
            - browser-ic
            - content-property
          description: >-
            What the file was uploaded for. Media for widget content is
            `content-property`.
        source:
          type: string
          enum:
            - chat-upload
            - chat-screenshot
            - browser-ic-screenshot
            - preview-screenshot
            - file-browser-upload
            - widget-visitor-upload
          description: >-
            Which part of the product, or which client, uploaded the file.
            `widget-visitor-upload` is a file a visitor sent through a widget's
            upload adapter; it cannot be asked for when uploading.
        widget_id:
          type: string
          format: uuid
          nullable: true
        conversation_id:
          type: string
          format: uuid
          nullable: true
        managed_user_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            The managed user the file was uploaded for, or null when it is the
            account's own. List one managed user's files with the
            `managed_user_id` or `managed_user_external_id` query parameter of
            `listUploads`.
        purpose:
          type: string
          nullable: true
          enum:
            - canvas
            - chat
            - field
          description: Where in the product the partner uses the file, or null when unknown
      example:
        id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        url: Example url
        mime_type: image/png
        file_name: Example file_name
        file_size: 42
        width: 42
        height: 42
        storage_key: Example storage_key
        context_type: Example context_type
        source: Example source
        widget_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        conversation_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        managed_user_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        purpose: Example purpose
    ResponseMeta:
      type: object
      description: >-
        Extra information about the answer: where a page sits in a list, the
        cursor of the next page, or warnings about a call that succeeded with a
        caveat.
      additionalProperties: true
      properties:
        page:
          type: integer
          description: The page that was read, counting from 1.
          example: 1
        size:
          type: integer
          description: How many items one page holds.
          example: 20
        total:
          type: integer
          description: How many items the whole list has.
          example: 135
        limit:
          type: integer
          description: The same as `size`.
          example: 20
        offset:
          type: integer
          description: How many items come before this page.
          example: 0
        hasNextPage:
          type: boolean
          example: true
        hasPreviousPage:
          type: boolean
          example: false
        nextCursor:
          type: string
          nullable: true
          description: >-
            Pass this as `cursor` to read the next page of a list that is read
            by cursor. `null` on the last page.
        warnings:
          type: array
          items:
            type: string
          description: >-
            Things the call did not do, though it succeeded (for example a table
            that could not be created just now).
    ErrorDetail:
      type: object
      required:
        - code
        - message
        - timestamp
      properties:
        code:
          type: string
          description: Machine-readable error code.
          example: RESOURCE_NOT_FOUND
        message:
          type: string
          description: Human-readable explanation.
          example: Composition not found
        param:
          type: string
          description: The field that caused the error, when one did.
          example: name
        docUrl:
          type: string
          description: Where this error is explained.
        suggestedAction:
          type: string
          description: What to do about it.
        retryAfter:
          type: integer
          description: >-
            Seconds to wait before trying again (rate limits). The same number
            is in the `Retry-After` header.
          example: 60
        details:
          type: object
          additionalProperties: true
          description: >-
            More about the error: the fields that failed, a limit that was
            reached.
        correlationId:
          type: string
          description: Quote this when you ask support about the call.
          example: req_123e4567-e89b-12d3-a456-426614174000
        timestamp:
          type: string
          format: date-time
          example: '2026-10-15T10:00:00.000Z'
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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