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

# Execute Script

> Submit a durable run of the active or explicitly pinned accepted version. Requires scripts:execute. Arguments must match its schema and fit 256 KiB.

Optional idempotencyKey identifies one invocation within this organization: reuse only for the same version and arguments.

HTTP 202 retains the run record and does not establish execution success; pass every run.id to scripts.awaitRuns and inspect resultRef/errorRef. Runs use immutable hashes and existing durable reconciliation.



## OpenAPI

````yaml /openapi.json post /api/v1/scripts/{scriptId}/runs
openapi: 3.1.0
info:
  title: OmniCommerce API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://omnicommerce.sg/terms
  description: >-
    OmniCommerce API surface for agents and developer integrations. Includes
    public endpoints (merchant discovery, product search, compare, catalog, ACO
    retrieval) and authenticated endpoints (product management via API key
    Bearer tokens).
servers:
  - url: https://omnicommerce.sg
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: agentic-checkout
    description: Merchant-fulfilled agentic checkout
    x-group: Agentic Checkout
  - name: agents
    description: agents
    x-group: Agents
  - name: analytics
    description: Sales performance across marketplaces
    x-group: Analytics
  - name: aops
    description: Agent operating procedures
    x-group: AOPs
  - name: branding
    description: branding
    x-group: Branding
  - name: campaigns
    description: Campaign briefs, offer windows, and marketplace runs
    x-group: Campaigns
  - name: commerce
    description: commerce
    x-group: Commerce
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - name: documents
    description: Knowledge base document uploads
    x-group: Knowledge Base
  - name: inventory
    description: Inventory quantities, planning signals, and marketplace listing absence
    x-group: Inventory
  - name: looks
    description: AI-styled product looks
    x-group: Looks
  - name: oauth
    description: OAuth token endpoints
    x-group: OAuth
  - name: orders
    description: Workspace and agentic orders
    x-group: Orders
  - name: organizations
    description: Organization management
    x-group: Organizations
  - name: price-books
    description: Marketplace list-price markup rules
    x-group: Price Books
  - name: products
    description: Product CRUD, bulk import, enrichment, publish, and delist
    x-group: Products
  - name: promotions
    description: Central promotions and marketplace sync
    x-group: Promotions
  - name: public-agent
    description: Public agent discovery and catalog APIs
    x-group: Public Agent
  - name: returns
    description: returns
    x-group: Returns
  - name: reviews
    description: Marketplace product reviews and seller replies
    x-group: Reviews
  - name: scripts
    description: scripts
    x-group: Scripts
  - name: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/scripts/{scriptId}/runs:
    post:
      tags:
        - scripts
      summary: Execute Script
      description: >-
        Submit a durable run of the active or explicitly pinned accepted
        version. Requires scripts:execute. Arguments must match its schema and
        fit 256 KiB.


        Optional idempotencyKey identifies one invocation within this
        organization: reuse only for the same version and arguments.


        HTTP 202 retains the run record and does not establish execution
        success; pass every run.id to scripts.awaitRuns and inspect
        resultRef/errorRef. Runs use immutable hashes and existing durable
        reconciliation.
      operationId: post_v1_scripts_by_scriptid_runs
      parameters:
        - name: scriptId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                organizationId:
                  type: string
                  minLength: 1
                versionId:
                  anyOf:
                    - type: string
                      minLength: 1
                    - type: 'null'
                args:
                  default: {}
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
                idempotencyKey:
                  type: string
                  minLength: 1
                  maxLength: 200
              additionalProperties: false
      responses:
        '202':
          description: Durable run record; inspect status and track run.id.
          content:
            application/json:
              schema:
                type: object
                properties:
                  run:
                    $ref: '#/components/schemas/OrganizationScriptRun'
                required:
                  - run
        '400':
          description: Invalid request, arguments, or deployment.
        '401':
          description: Missing or invalid credentials.
        '403':
          description: Missing script scope, organization capability, or Scripts feature.
        '404':
          description: Script not found in this organization.
        '429':
          description: Rate limit exceeded.
      security:
        - bearerAuth: []
components:
  schemas:
    OrganizationScriptRun:
      type: object
      properties:
        id:
          type: string
        organizationId:
          type: string
        scriptId:
          type: string
        scriptVersionId:
          type: string
        actorUserId:
          anyOf:
            - type: string
            - type: 'null'
        agentId:
          anyOf:
            - type: string
            - type: 'null'
        aopId:
          anyOf:
            - type: string
            - type: 'null'
        assistantRunId:
          anyOf:
            - type: string
            - type: 'null'
        idempotencyKey:
          type: string
        windmillJobId:
          anyOf:
            - type: string
            - type: 'null'
        status:
          type: string
          enum:
            - submitting
            - queued
            - running
            - succeeded
            - failed
            - timed_out
            - cancel_requested
            - cancelled
            - review_required
        argsRedacted:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        resultRef:
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties: {}
            - type: 'null'
        errorRef:
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties: {}
            - type: 'null'
        artifactRef:
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties: {}
            - type: 'null'
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - id
        - organizationId
        - scriptId
        - scriptVersionId
        - actorUserId
        - agentId
        - aopId
        - assistantRunId
        - idempotencyKey
        - windmillJobId
        - status
        - argsRedacted
        - resultRef
        - errorRef
        - artifactRef
        - createdAt
        - updatedAt
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Bearer API key for server-to-server access. Session auth is also
        supported in first-party UI flows.

````

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