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

# Get AOP configuration

> Retrieve prompt, agent, structured inputs/output, and notification settings. Requires `aops:read`.



## OpenAPI

````yaml /openapi.json get /api/v1/aop/{aopId}/config
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: aops
    description: Agent operating procedures
    x-group: AOPs
  - name: commerce
    description: Root commerce discovery
    x-group: Commerce
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - 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, and publish
    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: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/aop/{aopId}/config:
    get:
      tags:
        - aops
      summary: Get AOP configuration
      description: >-
        Retrieve prompt, agent, structured inputs/output, and notification
        settings. Requires `aops:read`.
      operationId: get_v1_aop_by_aopid_config
      parameters:
        - name: aopId
          in: path
          required: true
          schema:
            type: string
        - name: organizationId
          in: query
          required: false
          schema:
            type: string
            maxLength: 120
            description: Required for session auth. Optional for API keys.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                  - aop_id
                properties:
                  aop_id:
                    type: string
                  title:
                    type:
                      - string
                      - 'null'
                  prompt:
                    type: string
                  description:
                    type: string
                  agentId:
                    type:
                      - string
                      - 'null'
                  icon:
                    type: string
                    default: ListTodo
                  section:
                    type: string
                  structured_output:
                    type:
                      - object
                      - 'null'
                    additionalProperties: true
                  structured_inputs:
                    type:
                      - object
                      - 'null'
                    additionalProperties: true
                    description: >-
                      Computed JSON Schema for user_inputs, derived from [[
                      placeholder ]] tokens and declared variables.
                  agent_config:
                    type:
                      - object
                      - 'null'
                    additionalProperties: true
                  user_notification_configs:
                    type:
                      - object
                      - 'null'
                    additionalProperties: true
        '400':
          description: Invalid AOP configuration or request
        '401':
          description: Unauthorized
        '402':
          description: Insufficient AI credits
        '403':
          description: Forbidden. Missing OAuth scope.
        '404':
          description: AOP or thread not found
        '500':
          description: Internal server error
      security:
        - bearerAuth: []
components:
  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.

````