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

# Create Instagram Story Automation

> Adds an automation that replies to story mentions/replies on Instagram. Use `igStories.listStories` to find eligible stories first.



## OpenAPI

````yaml /api-reference/platform-api.json post /v1/ig-stories
openapi: 3.1.1
info:
  title: ChatbotX
  version: 0.0.1
servers:
  - url: https://app.chatbotx.io/api
security:
  - bearerAuth: []
  - developerAccessToken: []
  - tokenInSearchParams: []
paths:
  /v1/ig-stories:
    post:
      tags:
        - IG Stories
      summary: Create Instagram Story Automation
      description: >-
        Adds an automation that replies to story mentions/replies on Instagram.
        Use `igStories.listStories` to find eligible stories first.
      operationId: igStories.create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: Automation name.
                type:
                  enum:
                    - instagram
                    - instagramFacebook
                  type: string
                  description: >-
                    Instagram connection type, `instagram` (native login) or
                    `instagramFacebook` (linked via a Facebook page).
                folderId:
                  anyOf:
                    - type: string
                      pattern: ^\d+$
                    - type: 'null'
                  description: Folder to place the automation in, or null for root-level.
                story:
                  type: object
                  properties:
                    type:
                      enum:
                        - all
                        - storyIds
                      type: string
                    value:
                      type: array
                      items:
                        type: string
                  required:
                    - type
                    - value
                  description: >-
                    Instagram story to watch for replies/mentions. Get it from
                    `igStories.listStories`.
                reply:
                  type: object
                  properties:
                    type:
                      enum:
                        - AIAgent
                        - text
                        - flow
                        - none
                      type: string
                    value:
                      anyOf:
                        - type: string
                        - type: 'null'
                    values:
                      type: array
                      maxItems: 10
                      items:
                        type: object
                        properties:
                          value:
                            type: string
                        required:
                          - value
                  required:
                    - type
                    - value
                  description: Private message reply sent to the contact.
                includeKeywords:
                  type: object
                  properties:
                    type:
                      enum:
                        - all
                        - equal
                        - contain
                      type: string
                    value:
                      type: array
                      items:
                        type: string
                  required:
                    - type
                    - value
                  description: Only trigger when the reply matches these keywords.
              required:
                - name
                - type
                - story
                - reply
                - includeKeywords
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  createdAt:
                    type: string
                    format: date-time
                    x-native-type: date
                  updatedAt:
                    type: string
                    format: date-time
                    x-native-type: date
                  name:
                    type: string
                  folderId:
                    anyOf:
                      - type: string
                      - type: 'null'
                  type:
                    enum:
                      - instagram
                      - instagramFacebook
                    type: string
                  isActive:
                    type: boolean
                  startTime:
                    anyOf:
                      - type: string
                      - type: 'null'
                  endTime:
                    anyOf:
                      - type: string
                      - type: 'null'
                  repliesCount:
                    type: integer
                    minimum: -2147483648
                    maximum: 2147483647
                  story:
                    type: object
                    properties:
                      type:
                        enum:
                          - all
                          - storyIds
                        type: string
                      value:
                        type: array
                        items:
                          type: string
                    required:
                      - type
                      - value
                  reply:
                    type: object
                    properties:
                      type:
                        enum:
                          - AIAgent
                          - text
                          - flow
                          - none
                        type: string
                      value:
                        anyOf:
                          - type: string
                          - type: 'null'
                      values:
                        type: array
                        maxItems: 10
                        items:
                          type: object
                          properties:
                            value:
                              type: string
                          required:
                            - value
                    required:
                      - type
                      - value
                  includeKeywords:
                    type: object
                    properties:
                      type:
                        enum:
                          - all
                          - equal
                          - contain
                        type: string
                      value:
                        type: array
                        items:
                          type: string
                    required:
                      - type
                      - value
                required:
                  - id
                  - createdAt
                  - updatedAt
                  - name
                  - type
                  - isActive
                  - startTime
                  - endTime
                  - repliesCount
                  - story
                  - reply
                  - includeKeywords
        '400':
          description: '400'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: businessError
                      status:
                        const: 400
                      message:
                        type: string
                        default: An error occurred while processing your request
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
        '401':
          description: '401'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: UNAUTHORIZED
                      status:
                        const: 401
                      message:
                        type: string
                        default: Authentication required
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: INVALID_CHATBOT_TOKEN
                      status:
                        const: 401
                      message:
                        type: string
                        default: Invalid or missing workspace API token
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
        '403':
          description: '403'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: FORBIDDEN
                      status:
                        const: 403
                      message:
                        type: string
                        default: You do not have permission to perform this action
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: trialExpired
                      status:
                        const: 403
                      message:
                        type: string
                        default: Trial expired
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: macLimitReached
                      status:
                        const: 403
                      message:
                        type: string
                        default: Monthly active contact limit reached
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
        '422':
          description: '422'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: invalidRequestData
                      status:
                        const: 422
                      message:
                        type: string
                        default: Input validation failed
                      data:
                        type: object
                        properties:
                          issues:
                            type: array
                            items:
                              type: object
                              properties:
                                message:
                                  type: string
                                path:
                                  type: array
                                  items:
                                    anyOf:
                                      - type: string
                                      - type: number
                                      - type: object
                                        properties:
                                          key:
                                            anyOf:
                                              - type: string
                                              - type: number
                                        required:
                                          - key
                                        additionalProperties: {}
                              required:
                                - message
                              additionalProperties: {}
                        required:
                          - issues
                        additionalProperties: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                      - data
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: validation
                      status:
                        const: 422
                      message:
                        type: string
                        default: Validation error
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
        '429':
          description: '429'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: tooManyRequests
                      status:
                        const: 429
                      message:
                        type: string
                        default: Too many requests
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
        '500':
          description: '500'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: INTERNAL_SERVER_ERROR
                      status:
                        const: 500
                      message:
                        type: string
                        default: An unexpected error occurred
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - $ref: '#/components/schemas/UndefinedError'
components:
  schemas:
    UndefinedError:
      type: object
      properties:
        defined:
          const: false
        code:
          type: string
        status:
          type: number
        message:
          type: string
        data: {}
      required:
        - defined
        - code
        - status
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    developerAccessToken:
      type: http
      scheme: bearer
    tokenInSearchParams:
      type: apiKey
      in: query
      name: token

````