Picomes Uploads API

openapi: 3.2.0
info:
  title: Picomes Uploads API
  version: '2026-10-12'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-12: 5 operation(s) read from 4 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Picomes has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 1
    pages-with-code: 4
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-12'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://apidocs.picomes.com/guides/media-upload-api
  - https://apidocs.picomes.com/guides/work-instructions-api
  - https://apidocs.picomes.com/guides/erp_example_calls
  - https://apidocs.picomes.com/guides/authentication
servers:
- url: https://your-erp-system.com
security:
- x-pico-api-org: []
tags:
- name: Uploads
paths:
  /uploads:
    post:
      operationId: post_uploads
      tags:
      - Uploads
      summary: POST /uploads
      x-source: https://apidocs.picomes.com/guides/media-upload-api
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostUploadsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://example.picomes.io/uploads \\ -H \"x-pico-api-org: YOUR_API_TOKEN\" \\ -F \"destinationId=stepImage\" \\ -F \"file=@/path/to/image.jpg\" \n Python Example ​ \n import json import urllib . request import os UPLOAD_ENDPOINT = \"https://example.picomes.io/uploads\" API_TOKEN = \"YOUR_API_TOKEN\" def upload_image ( file_path , destination_id = \"stepImage\" ) : \"\"\"Upload an image and return the re"
  /uploads/{id}:
    patch:
      operationId: patch_uploads_id
      tags:
      - Uploads
      summary: Media Upload API
      description: Send chunk to existing stream
      x-source: https://apidocs.picomes.com/guides/media-upload-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchUploadsIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchUploadsIdResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PatchUploadsIdRequest:
      type: object
      properties:
        chunkIndex:
          type: integer
          description: Zero‑based index of the chunk being sent
        totalChunks:
          type: integer
          description: Total number of chunks for the upload
        file:
          type: string
          description: Chunk binary data
      required:
      - chunkIndex
      - totalChunks
      - file
    PostUploadsResponse:
      type: object
      properties:
        streamId:
          type: string
    PatchUploadsIdResponse:
      type: object
      properties:
        streamId:
          type: string
          description: Identifier of the upload stream
        chunkIndex:
          type: integer
          description: Index of the chunk that was just received
        path:
          type: string
          description: Path to the uploaded media (present in final chunk response)
  securitySchemes:
    x-pico-api-org:
      type: apiKey
      in: header
      name: x-pico-api-org
      x-source: https://apidocs.picomes.com/guides/authentication/index.html