Octoparse Search API

The Search API from Octoparse — 1 operation(s) for search.

OpenAPI Specification

octoparse-search-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Octoparse Action Search API
  version: 1.0.0
  description: 'Octoparse is your no-coding solution for web scraping to turn pages into

    structured data within clicks.'
servers:
- url: https://openapi.octoparse.com/
  description: API Server URL
tags:
- name: Search
paths:
  task/search:
    get:
      tags:
      - Search
      summary: Octoparse Search
      description: Search Task
      requestBody:
        content:
          application/json: {}
      parameters:
      - in: query
        name: taskGroupId
        description: Task group ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Response Example
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-04/schema#
                title: Response Example
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        taskId:
                          type: string
                        taskName:
                          type: string
                      required:
                      - taskId
                      - taskName
                  requestId:
                    type: string
              examples:
                Response Example:
                  value:
                    data:
                    - taskId: a3b9bdf7-9aaa-22f6-9ccf-b32790f6df8f
                      taskName: Task Group 1
                    - taskId: 86b9bdf7-9aaa-22236-9ccf-b3279469df01
                      taskName: Task Group 2
                    requestId: 0HMCVDHG1V3E6:00000002
        '400':
          description: Error Example
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-04/schema#
                title: Error Example
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                  requestId:
                    type: string
              examples:
                Error Example:
                  value:
                    error:
                      code: InvalidParameter
                      message: Invalid field
                    requestId: 0HMCVDHG1V3E6:00000002