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

# Start a site file upload

> Step 1 of 3 for adding a file to a site. Returns a presigned `PUT` URL and the `fileKey` that identifies the upload. `PUT` the bytes straight to that URL with a matching `Content-Type` header (step 2), then call `POST /v1/site/{id}/file` with the `fileKey` to register the file (step 3). Uploading directly to storage is what lets files exceed the 10MB request limit of this API; no direct byte upload is offered. The URL expires after 5 minutes, and nothing is stored until step 3. Returns `404` if the site does not exist or is not accessible to the partner. Requires the `siteFile:write` scope.



## OpenAPI

````yaml /openapi.yaml post /v1/site/{id}/file/upload-url
openapi: 3.1.0
info:
  title: ProVision Public API
  version: 1.0.0
  description: >-
    Use the ProVision Public API to integrate with ProVision conversations,
    clients, users, and addresses. All endpoints accept and return JSON, are
    authenticated with an `x-api-key` header, and are scoped to a single partner
    tenant.
  contact:
    email: support@onevisionresources.com
    name: OneVision Resources Support
  license:
    name: Proprietary
servers:
  - url: https://connect.provisionapp.io
    description: Production
security: []
paths:
  /v1/site/{id}/file/upload-url:
    post:
      tags:
        - site-file
      summary: Start a site file upload
      description: >-
        Step 1 of 3 for adding a file to a site. Returns a presigned `PUT` URL
        and the `fileKey` that identifies the upload. `PUT` the bytes straight
        to that URL with a matching `Content-Type` header (step 2), then call
        `POST /v1/site/{id}/file` with the `fileKey` to register the file (step
        3). Uploading directly to storage is what lets files exceed the 10MB
        request limit of this API; no direct byte upload is offered. The URL
        expires after 5 minutes, and nothing is stored until step 3. Returns
        `404` if the site does not exist or is not accessible to the partner.
        Requires the `siteFile:write` scope.
      operationId: createSiteFileUploadUrl
      parameters:
        - schema:
            $ref: '#/components/schemas/SiteId'
          required: true
          description: Site id the files belong to.
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSiteFileUploadUrlPayload'
      responses:
        '201':
          description: Presigned upload target
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteFileUploadUrl'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - OpenApiKeyAuth: []
components:
  schemas:
    SiteId:
      type: string
      minLength: 1
      description: >-
        Site id. Newer ids are `ovaid-<uuid>`; legacy sites may have bare (e.g.
        numeric) ids.
      example: ovaid-2b6d4d8e-9f1a-4b2c-8d4e-5f6011223344
    CreateSiteFileUploadUrlPayload:
      type: object
      properties:
        contentType:
          type: string
          minLength: 1
      required:
        - contentType
      additionalProperties: false
    SiteFileUploadUrl:
      type: object
      properties:
        fileKey:
          type: string
          format: uuid
        uploadUrl:
          type: string
        uploadUrlExpiresAt:
          type: string
          format: date-time
      required:
        - fileKey
        - uploadUrl
        - uploadUrlExpiresAt
    ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - error
    ApiError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: NOT_FOUND
        message:
          type: string
          description: Human-readable error description
      required:
        - code
        - message
  securitySchemes:
    OpenApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Send the API key in the x-api-key header.

````

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