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

# Webextrator Extract



## OpenAPI

````yaml /openapi/webextrator.json post /webextrator/extract
openapi: 3.0.0
info:
  title: WebExtrator Web Render & Extract
  version: 1.0.0
  description: API reference for WebExtrator Web Render & Extract on Ace Data Cloud.
servers:
  - url: https://api.acedata.cloud
    description: Ace Data Cloud API
security:
  - bearerAuth: []
paths:
  /webextrator/extract:
    post:
      summary: Webextrator Extract
      operationId: WebextratorcreateWebextratorExtract
      parameters:
        - in: header
          name: accept
          schema:
            enum:
              - application/json
            type: string
          required: false
          description: Webextrator Extract Param Accept
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  example: https://platform.acedata.cloud/documents/openai-images-edits
                  description: Webextrator Extract Url
                expected_type:
                  enum:
                    - product
                    - article
                    - general
                  type: string
                  description: Webextrator Extract Expected Type
                enable_llm:
                  type: boolean
                  default: false
                  description: Webextrator Extract Enable Llm
                wait_until:
                  enum:
                    - load
                    - domcontentloaded
                    - networkidle
                    - commit
                  type: string
                  default: networkidle
                  description: Webextrator Extract Wait Until
                timeout:
                  type: number
                  default: 30
                  description: Webextrator Extract Timeout
                delay:
                  type: number
                  description: Webextrator Extract Delay
                wait_for_selector:
                  type: string
                  description: Webextrator Extract Wait For Selector
                block_resources:
                  type: array
                  items:
                    type: string
                    enum:
                      - image
                      - font
                      - media
                      - stylesheet
                      - xhr
                      - fetch
                  description: Webextrator Extract Block Resources
                headers:
                  type: object
                  additionalProperties:
                    type: string
                  description: Webextrator Extract Headers
                user_agent:
                  type: string
                  description: Webextrator Extract User Agent
                callback_url:
                  type: string
                  format: uri
                  example: https://webhook.site/580b81f5-596e-4321-b03f-606770b0bb83
                  description: Webextrator Extract Callback Url
                async:
                  type: boolean
                  description: Webextrator Extract Async
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                example:
                  success: true
                  task_id: 550e8400-e29b-41d4-a716-446655440000
                  trace_id: 550e8400-e29b-41d4-a716-446655440001
                  started_at: 1746181800.123
                  finished_at: 1746181808.789
                  elapsed: 8.666
                  data:
                    kind: extract
                    url: >-
                      https://platform.acedata.cloud/documents/openai-images-edits
                    contentType: product
                    title: OpenAI Images Edits API
                    description: Webextrator Extract Response 200 Example Data
                    byline: Ace Data Cloud
                    siteName: Ace Data Cloud
                    images:
                      - https://cdn.acedata.cloud/nyq0xz.png
                    links:
                      - >-
                        https://platform.acedata.cloud/documents/openai-images-generations
                    markdown: |-
                      # OpenAI Images Edits API

                      Edit images by providing an input image URL and a prompt.
                    structured:
                      service: openai
                      endpoint: /openai/images/edits
                      method: POST
                properties:
                  success:
                    type: boolean
                    description: Webextrator Extract Response 200 Success
                  task_id:
                    type: string
                    description: Webextrator Extract Response 200 Task Id
                  trace_id:
                    type: string
                    description: Webextrator Extract Response 200 Trace Id
                  started_at:
                    type: number
                    description: Webextrator Extract Response 200 Started At
                  finished_at:
                    type: number
                    description: Webextrator Extract Response 200 Finished At
                  elapsed:
                    type: number
                    description: Webextrator Extract Response 200 Elapsed
                  data:
                    type: object
                    description: Webextrator Extract Response 200 Data
                    properties:
                      kind:
                        type: string
                        description: Webextrator Extract Response 200 Data Kind
                      url:
                        type: string
                        description: Webextrator Extract Response 200 Data Url
                      contentType:
                        type: string
                        description: Webextrator Extract Response 200 Data Contenttype
                      title:
                        type: string
                        description: Webextrator Extract Response 200 Data Title
                      description:
                        type: string
                        description: Webextrator Extract Response 200 Data Description
                      byline:
                        type: string
                        description: Webextrator Extract Response 200 Data Byline
                      siteName:
                        type: string
                        description: Webextrator Extract Response 200 Data Sitename
                      images:
                        type: array
                        description: Webextrator Extract Response 200 Data Images
                        items:
                          type: string
                      links:
                        type: array
                        description: Webextrator Extract Response 200 Data Links
                        items:
                          type: string
                      markdown:
                        type: string
                        description: Webextrator Extract Response 200 Data Markdown
                      structured:
                        type: object
                        description: Webextrator Extract Response 200 Data Structured
                        properties:
                          price:
                            type: number
                            description: >-
                              Webextrator Extract Response 200 Data Structured
                              Price
                          currency:
                            type: string
                            description: >-
                              Webextrator Extract Response 200 Data Structured
                              Currency
                          brand:
                            type: string
                            description: >-
                              Webextrator Extract Response 200 Data Structured
                              Brand
                          rating:
                            type: number
                            description: >-
                              Webextrator Extract Response 200 Data Structured
                              Rating
          description: Webextrator Extract Response 200
        '400':
          content:
            application/json:
              schema:
                type: object
                example:
                  success: false
                  error:
                    code: bad_request
                    message: url is required
                additionalProperties: true
          description: Webextrator Extract Response 400
        '429':
          content:
            application/json:
              schema:
                type: object
                example:
                  success: false
                  error:
                    code: too_many_requests
                    message: queue is busy
                additionalProperties: true
          description: Webextrator Extract Response 429
        '500':
          content:
            application/json:
              schema:
                type: object
                example:
                  success: false
                  error:
                    code: api_error
                    message: internal server error
                additionalProperties: true
          description: Webextrator Extract Response 500
        '504':
          content:
            application/json:
              schema:
                type: object
                example:
                  success: false
                  error:
                    code: timeout
                    message: extract exceeded timeout
                additionalProperties: true
          description: Webextrator Extract Response 504
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API token from https://platform.acedata.cloud

````

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