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

# Get how to write each of a step's settings

> Each input by its real name: type, required, options and default, and for one the editor fills with a widget (a template, a role, a filter) the JSON Schema of what to write and its editor shape. The same list GET /v1/automations/components/{component} gives.



## OpenAPI

````yaml /api/statisfy-api.openapi.json get /v1/automations/components/{component}/settings
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/automations/components/{component}/settings:
    get:
      tags:
        - automations
      summary: Get how to write each of a step's settings
      description: >-
        Each input by its real name: type, required, options and default, and
        for one the editor fills with a widget (a template, a role, a filter)
        the JSON Schema of what to write and its editor shape. The same list GET
        /v1/automations/components/{component} gives.
      operationId: automations_get_component_settings
      parameters:
        - in: path
          name: component
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationComponentSettings'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    AutomationComponentSettings:
      properties:
        component:
          title: Component
          type: string
        settings:
          description: >-
            Every input a spec may set, as GET
            /v1/automations/components/{component} lists them
          items:
            $ref: '#/components/schemas/ComponentSetting'
          title: Settings
          type: array
      required:
        - component
        - settings
      title: AutomationComponentSettings
      type: object
    ComponentSetting:
      properties:
        default:
          title: Default
        editor_shape:
          anyOf:
            - type: string
            - type: 'null'
          description: 'The editor value it becomes: GET /automations/shapes/{shape}'
          title: Editor Shape
        fields_from:
          anyOf:
            - type: string
            - type: 'null'
          description: 'For a filter input: where its field keys come from'
          title: Fields From
        info:
          anyOf:
            - type: string
            - type: 'null'
          title: Info
        name:
          title: Name
          type: string
        options:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Options
        required:
          title: Required
          type: boolean
        schema:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: >-
            For an input Orion completes or compiles (a template, a role, a
            filter): the JSON Schema of what to write
          title: Schema
        type:
          anyOf:
            - type: string
            - type: 'null'
          title: Type
        when_omitted:
          anyOf:
            - type: string
            - type: 'null'
          description: 'For a filter input: what leaving it out does'
          title: When Omitted
      required:
        - name
        - type
        - required
      title: ComponentSetting
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

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