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

# List team VM, permission and model presets with defaults and immutable revisions

> Requires the integrations:read scope.

Accepts a scoped bearer token, vendor-verified run identity, or interactive owner session.



## OpenAPI

````yaml /openapi.yaml get /api/v1/presets
openapi: 3.1.0
info:
  title: Factorize API
  version: 1.0.0
  description: >-
    Versioned Factorize REST API. See the hosted docs for examples and OAuth
    discovery.
  x-dashboard-auth: >-
    Access-token and authorized-client management and trace replay operations
    require an interactive owner session; all other operations accept a suitably
    scoped bearer token or owner session.
servers:
  - url: https://app.factorize.sh
security:
  - bearerAuth: []
paths:
  /api/v1/presets:
    get:
      tags:
        - presets
      summary: >-
        List team VM, permission and model presets with defaults and immutable
        revisions
      description: >-
        Requires the integrations:read scope.


        Accepts a scoped bearer token, vendor-verified run identity, or
        interactive owner session.
      operationId: get_api_v1_presets
      responses:
        '200':
          description: Presets
          content:
            application/json:
              schema:
                type: object
                properties:
                  presets:
                    type: array
                    items:
                      oneOf:
                        - type: object
                          properties:
                            slug:
                              type: string
                              maxLength: 120
                              pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
                            name:
                              type: string
                              minLength: 1
                              maxLength: 120
                            kind:
                              type: string
                              const: vm
                            settings:
                              anyOf:
                                - oneOf:
                                    - type: object
                                      properties:
                                        image:
                                          type: string
                                          minLength: 1
                                          maxLength: 512
                                          pattern: ^[A-Za-z0-9][A-Za-z0-9._/:@-]*$
                                        region:
                                          type: string
                                          pattern: ^[a-z0-9]{3}$
                                        size:
                                          type: string
                                          pattern: ^[a-z0-9-]{1,64}$
                                        provider:
                                          type: string
                                          const: fly
                                      required:
                                        - image
                                        - region
                                        - size
                                        - provider
                                      additionalProperties: false
                                    - type: object
                                      properties:
                                        provider:
                                          type: string
                                          const: exe
                                        connectionId:
                                          type: string
                                          minLength: 1
                                          maxLength: 256
                                        image:
                                          type: string
                                        tags:
                                          maxItems: 20
                                          type: array
                                          items:
                                            type: string
                                            pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$
                                      required:
                                        - provider
                                        - connectionId
                                        - image
                                        - tags
                                      additionalProperties: false
                                - type: object
                                  properties:
                                    provider:
                                      type: string
                                      const: none
                                  required:
                                    - provider
                                  additionalProperties: false
                            id:
                              type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            revision:
                              type: integer
                              exclusiveMinimum: 0
                              maximum: 9007199254740991
                            isDefault:
                              type: boolean
                            executionConfigId:
                              type:
                                - string
                                - 'null'
                          required:
                            - slug
                            - name
                            - kind
                            - settings
                            - id
                            - revision
                            - isDefault
                            - executionConfigId
                          additionalProperties: false
                        - type: object
                          properties:
                            slug:
                              type: string
                              maxLength: 120
                              pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
                            name:
                              type: string
                              minLength: 1
                              maxLength: 120
                            kind:
                              type: string
                              const: permission
                            settings:
                              type: object
                              properties:
                                runScopes:
                                  description: >-
                                    Factorize API scopes for new trigger runs.
                                    Omission uses existing scopes on update or
                                    read/invoke defaults on create; an empty
                                    array grants no application scopes.
                                    triggers:write permits configuring triggers
                                    and their future run scopes.
                                  maxItems: 13
                                  type: array
                                  items:
                                    type: string
                                    enum:
                                      - team:read
                                      - team:write
                                      - triggers:read
                                      - triggers:write
                                      - runs:read
                                      - runs:invoke
                                      - runs:start
                                      - runs:cancel
                                      - runs:write
                                      - integrations:read
                                      - integrations:write
                                      - skills:read
                                      - skills:write
                                portableIntegrationIds:
                                  maxItems: 100
                                  type: array
                                  items:
                                    type: string
                                    format: uuid
                                    pattern: >-
                                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                                githubInstallationIds:
                                  maxItems: 100
                                  type: array
                                  items:
                                    type: integer
                                    exclusiveMinimum: 0
                                    maximum: 9007199254740991
                                linearConnectionId:
                                  anyOf:
                                    - type: string
                                      const: linear
                                    - type: 'null'
                                xConnectionIds:
                                  maxItems: 100
                                  type: array
                                  items:
                                    type: string
                                    format: uuid
                                    pattern: >-
                                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                                allowedTriggerIds:
                                  maxItems: 100
                                  type: array
                                  items:
                                    type: string
                                    format: uuid
                                    pattern: >-
                                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                              additionalProperties: false
                            id:
                              type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            revision:
                              type: integer
                              exclusiveMinimum: 0
                              maximum: 9007199254740991
                            isDefault:
                              type: boolean
                            executionConfigId:
                              type:
                                - string
                                - 'null'
                          required:
                            - slug
                            - name
                            - kind
                            - settings
                            - id
                            - revision
                            - isDefault
                            - executionConfigId
                          additionalProperties: false
                        - type: object
                          properties:
                            slug:
                              type: string
                              maxLength: 120
                              pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
                            name:
                              type: string
                              minLength: 1
                              maxLength: 120
                            kind:
                              type: string
                              const: model
                            settings:
                              type: object
                              properties:
                                modelAccountId:
                                  type: string
                                  format: uuid
                                  pattern: >-
                                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                                model:
                                  type: string
                                  maxLength: 120
                                effort:
                                  type: string
                                  enum:
                                    - ''
                                    - minimal
                                    - low
                                    - medium
                                    - high
                                    - xhigh
                              additionalProperties: false
                            id:
                              type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            revision:
                              type: integer
                              exclusiveMinimum: 0
                              maximum: 9007199254740991
                            isDefault:
                              type: boolean
                            executionConfigId:
                              type:
                                - string
                                - 'null'
                          required:
                            - slug
                            - name
                            - kind
                            - settings
                            - id
                            - revision
                            - isDefault
                            - executionConfigId
                          additionalProperties: false
                required:
                  - presets
                additionalProperties: false
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '409':
          $ref: '#/components/responses/Error409'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
        '503':
          $ref: '#/components/responses/Error503'
      security:
        - bearerAuth: []
        - vendorRunIdentity: []
          runIdentityHeader: []
        - cookieAuth: []
components:
  responses:
    Error400:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error401:
      description: Invalid or revoked credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error403:
      description: Missing scope or required owner session
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error404:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error409:
      description: Operation conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error429:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error500:
      description: Internal error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error503:
      description: Service unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth2
    vendorRunIdentity:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Fresh vendor-signed exe.dev WIF or Fly Machine OIDC token matching the
        provisioned active run. Must be combined with X-Factorize-Run-Id; a
        vendor token alone grants no access.
    runIdentityHeader:
      type: apiKey
      in: header
      name: X-Factorize-Run-Id
      description: >-
        Provisioned run UUID. Used only to locate the immutable vendor/VM
        binding; this header is not a credential. Scopes and tenant come from
        the server-side run snapshot.
    cookieAuth:
      type: apiKey
      in: cookie
      name: factorize_session

````

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