Octoparse

naftiko: 1.0.0-alpha2
info:
  label: Octoparse
  description: Octoparse is your no-coding solution for web scraping to turn pages into structured data within clicks.
  tags:
  - Octoparse
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: octoparse
    baseUri: https://openapi.octoparse.com
    description: Octoparse HTTP API.
    resources:
    - name: token
      path: token
      operations:
      - name: post-token
        method: POST
        description: Octoparse getToken
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloudextraction-task-subtasks
      path: cloudextraction/task/subtasks
      operations:
      - name: get-cloudextraction-task-subtasks
        method: GET
        description: Octoparse SubtasksStatus
        inputParameters:
        - name: taskId
          in: query
          type: string
          required: true
          description: Task ID
        - name: page
          in: query
          type: string
          required: true
          description: Page number
        - name: size
          in: query
          type: string
          required: true
          description: Number of subtasks a page (1 to 20)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloudextraction-statuses
      path: cloudextraction/statuses
      operations:
      - name: post-cloudextraction-statuses
        method: POST
        description: Octoparse TaskStatus
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloudextraction-statuses-v2
      path: cloudextraction/statuses/v2
      operations:
      - name: post-cloudextraction-statuses-v2
        method: POST
        description: Octoparse TaskStatusV2
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloudextraction-start
      path: cloudextraction/start
      operations:
      - name: post-cloudextraction-start
        method: POST
        description: Octoparse cloudextractionStart
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloudextraction-stop
      path: cloudextraction/stop
      operations:
      - name: post-cloudextraction-stop
        method: POST
        description: Octoparse cloudextractionStop
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloudextraction-subtasks-start
      path: cloudextraction/subtasks{start}
      operations:
      - name: post-cloudextraction-subtasks-start
        method: POST
        description: Octoparse cloudextractionSubtasksStart
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloudextraction-subtasks-stop
      path: cloudextraction/subtasks{stop}
      operations:
      - name: post-cloudextraction-subtasks-stop
        method: POST
        description: Octoparse cloudextractionSubtasksStop
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: data-all
      path: data/all
      operations:
      - name: get-data-all
        method: GET
        description: Octoparse all
        inputParameters:
        - name: taskId
          in: query
          type: string
          required: true
          description: Task ID
        - name: offset
          in: query
          type: string
          required: true
          description: Data offset. When offset=0, you can get data from the first data row.
        - name: size
          in: query
          type: string
          required: true
          description: The amount of data rows(range from 1 to 1000).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: data-lotno-all
      path: data/lotno/all
      operations:
      - name: get-data-lotno-all
        method: GET
        description: Octoparse lotnoAll
        inputParameters:
        - name: taskId
          in: query
          type: string
          required: true
          description: Task Id
        - name: lotno
          in: query
          type: string
          required: true
          description: Batch ID
        - name: offset
          in: query
          type: string
          required: true
          description: Data offset. When offset=0, you can get data from the first data row.
        - name: size
          in: query
          type: string
          required: true
          description: The amount of data rows (range from 1 to 1000).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: data-markexported
      path: data/markexported
      operations:
      - name: post-data-markexported
        method: POST
        description: Octoparse markexported
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: data-notexported
      path: data/notexported
      operations:
      - name: get-data-notexported
        method: GET
        description: Octoparse notexported
        inputParameters:
        - name: taskId
          in: query
          type: string
          required: true
          description: Task ID
        - name: size
          in: query
          type: string
          required: true
          description: The amount of data rows(range from 1 to 1000)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: data-remove
      path: data/remove
      operations:
      - name: post-data-remove
        method: POST
        description: Octoparse remove
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: task-copy
      path: task/copy
      operations:
      - name: post-task-copy
        method: POST
        description: Octoparse Copy
        inputParameters:
        - name: taskGroupId
          in: query
          type: string
          required: true
          description: Task group ID (If not specified, the task will be duplicated to the current task group)
        - name: taskId
          in: query
          type: string
          required: true
          description: Task ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: task-movetogroup
      path: task/moveToGroup
      operations:
      - name: post-task-movetogroup
        method: POST
        description: Octoparse MoveToGroup
        inputParameters:
        - name: taskGroupId
          in: query
          type: string
          required: true
          description: Task group ID
        - name: taskId
          in: query
          type: string
          required: true
          description: Task ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: task-search
      path: task/search
      operations:
      - name: get-task-search
        method: GET
        description: Octoparse Search
        inputParameters:
        - name: taskGroupId
          in: query
          type: string
          required: true
          description: Task group ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: task-urls-file
      path: task/urls{file}
      operations:
      - name: post-task-urls-file
        method: POST
        description: Octoparse UpdateUrls
        inputParameters:
        - name: taskId
          in: query
          type: string
          required: true
          description: Task ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: taskgroup
      path: taskGroup
      operations:
      - name: get-taskgroup
        method: GET
        description: Octoparse taskGroup
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: task-getactions
      path: task/getActions
      operations:
      - name: post-task-getactions
        method: POST
        description: Octoparse getActions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: task-updateactionproperties
      path: task/updateActionProperties
      operations:
      - name: post-task-updateactionproperties
        method: POST
        description: Octoparse updateActionProperties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: task-updateloopitems
      path: task/updateLoopItems
      operations:
      - name: post-task-updateloopitems
        method: POST
        description: Octoparse updateLoopItems
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: octoparse-rest
    description: REST adapter for Octoparse.
    resources:
    - path: token
      name: post-token
      operations:
      - method: POST
        name: post-token
        description: Octoparse getToken
        call: octoparse.post-token
        outputParameters:
        - type: object
          mapping: $.
    - path: cloudextraction/task/subtasks
      name: get-cloudextraction-task-subtasks
      operations:
      - method: GET
        name: get-cloudextraction-task-subtasks
        description: Octoparse SubtasksStatus
        call: octoparse.get-cloudextraction-task-subtasks
        outputParameters:
        - type: object
          mapping: $.
    - path: cloudextraction/statuses
      name: post-cloudextraction-statuses
      operations:
      - method: POST
        name: post-cloudextraction-statuses
        description: Octoparse TaskStatus
        call: octoparse.post-cloudextraction-statuses
        outputParameters:
        - type: object
          mapping: $.
    - path: cloudextraction/statuses/v2
      name: post-cloudextraction-statuses-v2
      operations:
      - method: POST
        name: post-cloudextraction-statuses-v2
        description: Octoparse TaskStatusV2
        call: octoparse.post-cloudextraction-statuses-v2
        outputParameters:
        - type: object
          mapping: $.
    - path: cloudextraction/start
      name: post-cloudextraction-start
      operations:
      - method: POST
        name: post-cloudextraction-start
        description: Octoparse cloudextractionStart
        call: octoparse.post-cloudextraction-start
        outputParameters:
        - type: object
          mapping: $.
    - path: cloudextraction/stop
      name: post-cloudextraction-stop
      operations:
      - method: POST
        name: post-cloudextraction-stop
        description: Octoparse cloudextractionStop
        call: octoparse.post-cloudextraction-stop
        outputParameters:
        - type: object
          mapping: $.
    - path: cloudextraction/subtasks{start}
      name: post-cloudextraction-subtasks-start
      operations:
      - method: POST
        name: post-cloudextraction-subtasks-start
        description: Octoparse cloudextractionSubtasksStart
        call: octoparse.post-cloudextraction-subtasks-start
        outputParameters:
        - type: object
          mapping: $.
    - path: cloudextraction/subtasks{stop}
      name: post-cloudextraction-subtasks-stop
      operations:
      - method: POST
        name: post-cloudextraction-subtasks-stop
        description: Octoparse cloudextractionSubtasksStop
        call: octoparse.post-cloudextraction-subtasks-stop
        outputParameters:
        - type: object
          mapping: $.
    - path: data/all
      name: get-data-all
      operations:
      - method: GET
        name: get-data-all
        description: Octoparse all
        call: octoparse.get-data-all
        outputParameters:
        - type: object
          mapping: $.
    - path: data/lotno/all
      name: get-data-lotno-all
      operations:
      - method: GET
        name: get-data-lotno-all
        description: Octoparse lotnoAll
        call: octoparse.get-data-lotno-all
        outputParameters:
        - type: object
          mapping: $.
    - path: data/markexported
      name: post-data-markexported
      operations:
      - method: POST
        name: post-data-markexported
        description: Octoparse markexported
        call: octoparse.post-data-markexported
        outputParameters:
        - type: object
          mapping: $.
    - path: data/notexported
      name: get-data-notexported
      operations:
      - method: GET
        name: get-data-notexported
        description: Octoparse notexported
        call: octoparse.get-data-notexported
        outputParameters:
        - type: object
          mapping: $.
    - path: data/remove
      name: post-data-remove
      operations:
      - method: POST
        name: post-data-remove
        description: Octoparse remove
        call: octoparse.post-data-remove
        outputParameters:
        - type: object
          mapping: $.
    - path: task/copy
      name: post-task-copy
      operations:
      - method: POST
        name: post-task-copy
        description: Octoparse Copy
        call: octoparse.post-task-copy
        outputParameters:
        - type: object
          mapping: $.
    - path: task/moveToGroup
      name: post-task-movetogroup
      operations:
      - method: POST
        name: post-task-movetogroup
        description: Octoparse MoveToGroup
        call: octoparse.post-task-movetogroup
        outputParameters:
        - type: object
          mapping: $.
    - path: task/search
      name: get-task-search
      operations:
      - method: GET
        name: get-task-search
        description: Octoparse Search
        call: octoparse.get-task-search
        outputParameters:
        - type: object
          mapping: $.
    - path: task/urls{file}
      name: post-task-urls-file
      operations:
      - method: POST
        name: post-task-urls-file
        description: Octoparse UpdateUrls
        call: octoparse.post-task-urls-file
        outputParameters:
        - type: object
          mapping: $.
    - path: taskGroup
      name: get-taskgroup
      operations:
      - method: GET
        name: get-taskgroup
        description: Octoparse taskGroup
        call: octoparse.get-taskgroup
        outputParameters:
        - type: object
          mapping: $.
    - path: task/getActions
      name: post-task-getactions
      operations:
      - method: POST
        name: post-task-getactions
        description: Octoparse getActions
        call: octoparse.post-task-getactions
        outputParameters:
        - type: object
          mapping: $.
    - path: task/updateActionProperties
      name: post-task-updateactionproperties
      operations:
      - method: POST
        name: post-task-updateactionproperties
        description: Octoparse updateActionProperties
        call: octoparse.post-task-updateactionproperties
        outputParameters:
        - type: object
          mapping: $.
    - path: task/updateLoopItems
      name: post-task-updateloopitems
      operations:
      - method: POST
        name: post-task-updateloopitems
        description: Octoparse updateLoopItems
        call: octoparse.post-task-updateloopitems
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: octoparse-mcp
    transport: http
    description: MCP adapter for Octoparse for AI agent use.
    tools:
    - name: post-token
      description: Octoparse getToken
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-token
      outputParameters:
      - type: object
        mapping: $.
    - name: get-cloudextraction-task-subtasks
      description: Octoparse SubtasksStatus
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: octoparse.get-cloudextraction-task-subtasks
      with:
        taskId: tools.taskId
        page: tools.page
        size: tools.size
      inputParameters:
      - name: taskId
        type: string
        description: Task ID
        required: true
      - name: page
        type: string
        description: Page number
        required: true
      - name: size
        type: string
        description: Number of subtasks a page (1 to 20)
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: post-cloudextraction-statuses
      description: Octoparse TaskStatus
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-cloudextraction-statuses
      outputParameters:
      - type: object
        mapping: $.
    - name: post-cloudextraction-statuses-v2
      description: Octoparse TaskStatusV2
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-cloudextraction-statuses-v2
      outputParameters:
      - type: object
        mapping: $.
    - name: post-cloudextraction-start
      description: Octoparse cloudextractionStart
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-cloudextraction-start
      outputParameters:
      - type: object
        mapping: $.
    - name: post-cloudextraction-stop
      description: Octoparse cloudextractionStop
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-cloudextraction-stop
      outputParameters:
      - type: object
        mapping: $.
    - name: post-cloudextraction-subtasks-start
      description: Octoparse cloudextractionSubtasksStart
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-cloudextraction-subtasks-start
      outputParameters:
      - type: object
        mapping: $.
    - name: post-cloudextraction-subtasks-stop
      description: Octoparse cloudextractionSubtasksStop
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-cloudextraction-subtasks-stop
      outputParameters:
      - type: object
        mapping: $.
    - name: get-data-all
      description: Octoparse all
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: octoparse.get-data-all
      with:
        taskId: tools.taskId
        offset: tools.offset
        size: tools.size
      inputParameters:
      - name: taskId
        type: string
        description: Task ID
        required: true
      - name: offset
        type: string
        description: Data offset. When offset=0, you can get data from the first data row.
        required: true
      - name: size
        type: string
        description: The amount of data rows(range from 1 to 1000).
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: get-data-lotno-all
      description: Octoparse lotnoAll
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: octoparse.get-data-lotno-all
      with:
        taskId: tools.taskId
        lotno: tools.lotno
        offset: tools.offset
        size: tools.size
      inputParameters:
      - name: taskId
        type: string
        description: Task Id
        required: true
      - name: lotno
        type: string
        description: Batch ID
        required: true
      - name: offset
        type: string
        description: Data offset. When offset=0, you can get data from the first data row.
        required: true
      - name: size
        type: string
        description: The amount of data rows (range from 1 to 1000).
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: post-data-markexported
      description: Octoparse markexported
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-data-markexported
      outputParameters:
      - type: object
        mapping: $.
    - name: get-data-notexported
      description: Octoparse notexported
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: octoparse.get-data-notexported
      with:
        taskId: tools.taskId
        size: tools.size
      inputParameters:
      - name: taskId
        type: string
        description: Task ID
        required: true
      - name: size
        type: string
        description: The amount of data rows(range from 1 to 1000)
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: post-data-remove
      description: Octoparse remove
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-data-remove
      outputParameters:
      - type: object
        mapping: $.
    - name: post-task-copy
      description: Octoparse Copy
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-task-copy
      with:
        taskGroupId: tools.taskGroupId
        taskId: tools.taskId
      inputParameters:
      - name: taskGroupId
        type: string
        description: Task group ID (If not specified, the task will be duplicated to the current task group)
        required: true
      - name: taskId
        type: string
        description: Task ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: post-task-movetogroup
      description: Octoparse MoveToGroup
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-task-movetogroup
      with:
        taskGroupId: tools.taskGroupId
        taskId: tools.taskId
      inputParameters:
      - name: taskGroupId
        type: string
        description: Task group ID
        required: true
      - name: taskId
        type: string
        description: Task ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: get-task-search
      description: Octoparse Search
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: octoparse.get-task-search
      with:
        taskGroupId: tools.taskGroupId
      inputParameters:
      - name: taskGroupId
        type: string
        description: Task group ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: post-task-urls-file
      description: Octoparse UpdateUrls
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-task-urls-file
      with:
        taskId: tools.taskId
      inputParameters:
      - name: taskId
        type: string
        description: Task ID
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: get-taskgroup
      description: Octoparse taskGroup
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: octoparse.get-taskgroup
      outputParameters:
      - type: object
        mapping: $.
    - name: post-task-getactions
      description: Octoparse getActions
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-task-getactions
      outputParameters:
      - type: object
        mapping: $.
    - name: post-task-updateactionproperties
      description: Octoparse updateActionProperties
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-task-updateactionproperties
      outputParameters:
      - type: object
        mapping: $.
    - name: post-task-updateloopitems
      description: Octoparse updateLoopItems
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: octoparse.post-task-updateloopitems
      outputParameters:
      - type: object
        mapping: $.