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

# Start a file upload

> Start a picture upload (PNG, JPEG or WebP): POST every field plus the file to uploadUrl, then call POST /v1/files/complete.



## OpenAPI

````yaml scripts/api/sources/openapi.json POST /files
openapi: 3.1.0
info:
  title: Summer API
  version: '1'
  description: >-
    Curated, tested game-dev models: 3D, images, video, voice, sound and music,
    into your Summer assets.
servers:
  - url: https://www.summerengine.com/v1
security:
  - bearer: []
paths:
  /files:
    post:
      summary: Start an image upload
      description: >-
        Start an image upload (PNG, JPEG or WebP): POST every field plus the
        file to uploadUrl, then POST /v1/files/complete with the upload's
        answer.
      operationId: assets_upload_begin
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 128
          description: >-
            A new key for each new request; the same key returns the first
            answer.
      responses:
        '200':
          description: Done.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uploadUrl:
                    type: string
                  method:
                    type: string
                    const: POST
                  fields:
                    description: >-
                      Send each as a multipart form field, then the file as
                      "file".
                    type: object
                    additionalProperties:
                      type: string
                  expiresAt:
                    type: string
                  example:
                    description: >-
                      The same upload as one curl command (replace the file
                      path).
                    type: string
                required:
                  - uploadUrl
                  - method
                  - fields
                  - expiresAt
                  - example
                additionalProperties: false
        default:
          description: An error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
            - request_id
            - doc_url
          properties:
            type:
              type: string
            code:
              type: string
              description: >-
                A stable code: invalid_input, not_signed_in, no_credits (the
                paid balance), over_limit (the app's own spend limit), ...
            message:
              type: string
            param:
              type:
                - string
                - 'null'
              description: The field to fix, such as input.prompt or Idempotency-Key.
            request_id:
              type: string
            doc_url:
              type: string
            fix_url:
              type: string
              description: Where the person fixes it, such as adding credits.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A Summer sign-in: an OAuth 2.1 access token, valid one hour. Sign in
        once with npx -y summer-engine login, then print a token with summer
        token. Each app you sign in spends your paid credits up to the limit you
        set in Connected apps.

````

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