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

# Similar companies API

<Panel>
  <Note>
    Cost: **5 credits**
  </Note>
</Panel>

Performs advanced search for similar companies based on a given company URL. Returns list of companies including company:

* name,
* URL,
* description,
* similarity score (from 0 to 1, where 1 is the most similar).

Retrieves the list of **max 12 similar companies.**

<Note>
  This API endpoint automaticaly manages proxy and CAPTCHA solving.
</Note>


## OpenAPI

````yaml api-reference/openapi-0.yaml post /companies/similar
openapi: 3.1.0
info:
  title: Workfloows API
  version: '0'
  description: >
    ## Introduction


    This API provides a growing collection of powerful tools and endpoints 

    commonly used in automation workflows. It's designed for individual
    automators, 

    agencies, and app builders who want to streamline processes and connect
    systems.


    ## Authentication


    All requests require an API key, which must be included in the `x-api-key`
    header.


    ```

    x-api-key: <your_api_key>

    ```


    If the API key is missing or invalid, a `401 Unauthorized` response will be
    returned.
servers:
  - url: https://api.workfloo.ws/v0
security: []
paths:
  /companies/similar:
    post:
      tags:
        - Scrape
      summary: Similar companies API
      operationId: similarCompanies
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  description: >-
                    Target URL to find similar companies for (including
                    protocol)
                  example: https://workfloows.com
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: object
                    properties:
                      success:
                        type: boolean
                        description: Whether the request was successful
                  results:
                    type: array
                    description: List of similar companies
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: Name of the similar company
                        url:
                          type: string
                          format: uri
                          description: Website URL of the similar company
                        description:
                          type: string
                          description: Short description of the company
                        similarity_score:
                          type: number
                          format: float
                          description: Similarity score (0-1, higher is more similar)
              examples:
                success:
                  summary: Success
                  value:
                    response:
                      success: true
                    results:
                      - name: ExampleCorp
                        url: https://example.com/
                        description: >-
                          ExampleCorp is a mock company for demonstration
                          purposes in API documentation.
                        similarity_score: 0.95
                      - name: Mockify
                        url: https://mockify.example/
                        description: >-
                          Mockify provides sample automation tools for testing
                          and example workflows.
                        similarity_score: 0.87
                      - name: DemoSoft
                        url: https://demosoft.mock/
                        description: >-
                          DemoSoft is a fictional SaaS platform used as an
                          example in API responses.
                        similarity_score: 0.81
        '400':
          description: Invalid input or missing/invalid URL
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message describing why the request failed
              examples:
                invalidJson:
                  summary: Invalid JSON
                  value:
                    error: >-
                      Invalid JSON body. Please provide a valid JSON object with
                      a 'url' field.
                missingUrl:
                  summary: Missing URL
                  value:
                    error: URL is required in the request body.
                invalidUrl:
                  summary: Invalid URL
                  value:
                    error: >-
                      Invalid URL format. Provide a valid URL (e.g.,
                      https://example.com).
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          description: Insufficient credits
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              examples:
                insufficientCredits:
                  summary: Insufficient credits
                  value:
                    error: Insufficient credits.
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - apiKeyAuth: []
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
          examples:
            unauthorized:
              summary: Unauthorized
              value:
                error: Unauthorized.
            apiKeyRequired:
              summary: API Key required
              value:
                error: Unauthorized. API key is required.
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
          examples:
            invalidApiKey:
              summary: Invalid API key
              value:
                error: Invalid API key.
            apiKeyNotFound:
              summary: API Key not found
              value:
                error: API Key not found.
            rateLimitExceeded:
              summary: Rate limit exceeded
              value:
                error: Rate limit exceeded.
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
          examples:
            userNotFound:
              summary: User not found
              value:
                error: User not found.
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: An error occurred while processing your request.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````