Picomes API

openapi: 3.1.0
info:
  title: Picomes 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
paths:
  /api/pico-webhooks:
    post:
      operationId: post_api_pico_webhooks
      tags:
      - Api
      summary: POST /api/pico-webhooks
      x-source: https://apidocs.picomes.com/guides/erp_example_calls
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPicoWebhooksRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiPicoWebhooksResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Python curl -X POST YOUR_PICO_API_ENDPOINT \ -H "Content-Type: application/json" \ -H "x-pico-api-org: YOUR_API_TOKEN"
          \ -d ''{ "query": "mutation Subscribe($input: SubscribeRequestInput!) { webhookSubscribe(input: $input) { subscriptionId webhookUrl
          createdAt } }", "variables": { "input": { "subscriptionID": "erp-order-completions", "responseFragment": "fragment OrderComplete on
          OperationOrde'
  /graph/v2:
    get:
      operationId: get_graph_v2
      tags:
      - Graph
      summary: GET /graph/v2
      x-source: https://apidocs.picomes.com/guides/erp_example_calls
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGraphV2Response'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl / Python selector on each example to view it in your preferred language. Replace the placeholder values with your actual\
          \ endpoint and authentication token before running. \n Placeholders In every example below, replace: \n YOUR_PICO_API_ENDPOINT — your\
          \ Pico API GraphQL URL (e.g. https://yourcompany.picomes.com/graph/v2 ) \n YOUR_API_TOKEN — your Pico API authentication token (see\
          \ Authentication "
    post:
      operationId: post_graph_v2
      tags:
      - Graph
      summary: POST /graph/v2
      x-source: https://apidocs.picomes.com/guides/work-instructions-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostGraphV2Request'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://example.picomes.io/graph/v2 \ -H "Content-Type: application/json" \ -H "x-pico-api-org: YOUR_API_TOKEN"
          \ -d ''{ "query": "mutation CreateProcess($input: ProcessCreateInput!) { processCreate(input: $input) }", "variables": { "input": {
          "process": { "id": "assembly_step_1", "name": "Main Assembly", "description": "Assemble the main components", "steps": [ { "id": "step_1",
          "name'
  /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:
    PostApiPicoWebhooksRequest:
      type: object
      properties:
        query:
          type: string
        variables:
          type: object
          properties:
            input:
              type: object
              properties:
                subscriptionID:
                  type: string
                responseFragment:
                  type: string
                webhookUrl:
                  type: string
                webhookHeaders:
                  type: object
                  properties:
                    X-API-Key:
                      type: string
    PostApiPicoWebhooksResponse:
      type: object
      properties:
        x-pico-api-org:
          type: string
    GetGraphV2Response:
      type: object
      properties:
        x-pico-api-org:
          type: string
    PostGraphV2Request:
      type: object
      properties:
        query:
          type: string
        variables:
          type: object
          properties:
            input:
              type: object
              properties:
                process:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    description:
                      type: string
                    steps:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                          instructionText:
                            type: object
                            properties:
                              text: {}
                          actions:
                            type: array
                            items: {}
    PostUploadsResponse:
      type: object
      properties:
        streamId:
          type: string
    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
    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
tags:
- name: Api
- name: Graph
- name: Uploads
security:
- x-pico-api-org: []