find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/mabl:mabl-find-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: mabl Find API
  description: APIs for interacting with mabl services
  version: 0.599.3.1792436330
  x-readme-id: 62c896636916ce01d2ff4f5a
servers:
- url: /
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Find
paths:
  /find/{workspace_id}/evaluate/attributes:
    post:
      tags:
      - Find
      summary: Evaluate element attributes
      description: Evaluate element attributes for find and auto-healing execution using AI
      operationId: evaluateAttributes
      parameters:
      - name: workspace_id
        in: path
        description: The workspace associated with this element and find or auto-heal
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: The request with element attributes to evaluate
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FindEvaluateAttributesRequest'
        required: true
      responses:
        '200':
          description: An evaluation of element attributes for use in executing find and auto-healing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FindEvaluateAttributesResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::FindEvaluation
  /find/{workspace_id}/evaluate/textSimilarity:
    post:
      tags:
      - Find
      summary: Evaluate text similarity of multiple elements
      description: Evaluate text similarity of element candidates for find and auto-healing execution using AI
      operationId: evaluateTextSimilarity
      parameters:
      - name: workspace_id
        in: path
        description: The workspace associated with this element and find or auto-heal
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: The request with candidate text to evaluate
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FindEvaluateTextSimilarityRequest'
        required: true
      responses:
        '200':
          description: An evaluation of candidate text for use in executing find and auto-healing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FindEvaluateTextSimilarityResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse400'
        '401':
          $ref: '#/components/responses/ErrorResponse401'
        '403':
          $ref: '#/components/responses/ErrorResponse403'
        default:
          $ref: '#/components/responses/ErrorResponse'
      x-mabl-action: Read::FindEvaluation
components:
  responses:
    ErrorResponse401:
      description: User not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse400:
      description: Invalid or missing parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse403:
      description: User not authorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
    ErrorResponse:
      description: Unknown error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponseGeneric'
  schemas:
    FindEvaluateTextSimilarityRequest:
      required:
      - attribute_id
      - candidate_text
      - expected_text
      - selector_invariant_id
      - test_run_id
      type: object
      properties:
        expected_text:
          type: string
          description: The text we expect to find on the element based on the find model
        candidate_text:
          type: array
          description: The ID and text of each candidate for evaluation
          items:
            $ref: '#/components/schemas/FindCandidateText'
        test_run_id:
          type: string
          description: The test run ID for which this find and attribute evaluation is being executed
        selector_invariant_id:
          type: string
          description: The selector invariant ID for the element being evaluated
        attribute_id:
          type: string
          description: The ID for the primary text attribute being used for the evaluation
    FindCandidateTextSimilarity:
      required:
      - id
      - text
      type: object
      properties:
        id:
          type: string
          description: The ID of the candidate
        text:
          type: string
          description: The text from the candidate
        match:
          type: boolean
          description: True if this candidate text matches the expected text
        similarity:
          type: number
          description: 0 to 1 similarity score where 1 is exact match and 0 is no match
          format: double
    GuardrailApprovalKind:
      type: string
      description: Who decides a guardrail approval. SELF is decided by the person the agent acts for; WORKSPACE, for an agent acting for an API key, by a workspace owner or editor.
      enum:
      - SELF
      - WORKSPACE
    GuardrailRefusal:
      type: object
      properties:
        id:
          type: string
          description: The id of the guardrail policy that decided the refusal.
        reason:
          type: string
          description: Why the policy refuses the request, written for the person the agent acts for.
        decision_id:
          type: string
          description: The id of this decision in the guardrail decision log.
        action:
          type: string
          description: The action the request was evaluated as, written Verb::Resource (for example Delete::Test), as declared by the operation's x-mabl-action extension.
        policy_source:
          type: string
          description: 'Who set the deciding policy: workspace for a rule the workspace''s owners wrote, account for a rule set for the workspace''s account, mabl_agent_type for the agent type''s ceiling, and mabl_default for mabl''s own defaults.'
        approval:
          description: The approval for this request; present when error_code is approval_required and the approval could be recorded. Without it the request cannot be approved.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalRef'
      description: The guardrail policy that refused an agent request.
    GuardrailApprovalState:
      type: string
      description: Where a guardrail approval stands. PENDING awaits a decision and expires undecided after 24 hours; APPROVED lets the agent repeat the request, as often as it does, for 20 minutes; DENIED refuses the same request for 20 minutes after the decision, after which asking again opens a new approval; CANCELLED means a person withdrew it while pending or revoked it while approved. EXPIRED and CANCELLED are final.
      enum:
      - PENDING
      - APPROVED
      - DENIED
      - EXPIRED
      - CANCELLED
    FindCandidateText:
      required:
      - id
      - text
      type: object
      properties:
        id:
          type: string
          description: The ID of the candidate
        text:
          type: string
          description: The text from the candidate
    GuardrailApprovalRef:
      type: object
      properties:
        id:
          type: string
          description: The approval's id.
        state:
          description: Where the approval stands.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalState'
        kind:
          description: Who decides the approval.
          allOf:
          - $ref: '#/components/schemas/GuardrailApprovalKind'
        request_expires_time:
          type: integer
          description: When the approval expires if nobody decides it, in epoch milliseconds.
          format: int64
        url:
          type: string
          description: The mabl app page where a person reviews the approval.
      description: 'An approval a guardrail policy asks for. While it is PENDING, stop: give the person the url, tell them the request is waiting for approval, and do not repeat the request or poll in a loop. Once a person tells you it is APPROVED, repeat the identical request with the header X-Mabl-Approval set to id. DENIED means a person said no, so do not work around it.'
    FindEvaluateTextSimilarityResponse:
      required:
      - attribute_id
      - candidate_text_matches
      - expected_text
      - selector_invariant_id
      - workspace_id
      type: object
      properties:
        workspace_id:
          type: string
          description: The workspace associated with this element and find or auto-heal
          readOnly: true
        candidate_text_matches:
          type: array
          description: The candidate text matches to the expected text
          readOnly: true
          items:
            $ref: '#/components/schemas/FindCandidateTextSimilarity'
        expected_text:
          type: string
          description: The text we expect to find on the element based on the find model
        selector_invariant_id:
          type: string
          description: The selector invariant ID for the element being evaluated
        attribute_id:
          type: string
          description: The ID for the primary text attribute being used for the evaluation
    FindEvaluateAttributesResponse:
      required:
      - evaluated_attributes
      - workspace_id
      type: object
      properties:
        workspace_id:
          type: string
          description: The workspace associated with this element and find or auto-heal
          readOnly: true
        evaluated_attributes:
          type: array
          description: Element attributes to evaluate
          readOnly: true
          items:
            $ref: '#/components/schemas/FindElementAttributeEvaluation'
    FindEvaluateAttributesRequest:
      required:
      - attributes
      type: object
      properties:
        primary_text_attribute:
          $ref: '#/components/schemas/FindElementAttribute'
        attributes:
          type: array
          description: Element attributes to evaluate
          items:
            $ref: '#/components/schemas/FindElementAttribute'
        test_run_id:
          type: string
          description: The test run ID for which this find and attribute evaluation is being executed
        selector_invariant_id:
          type: string
          description: The selector invariant ID for the element being evaluated
    ErrorResponseGeneric:
      type: object
      properties:
        id:
          type: string
          x-mabl-scope: public
        code:
          maximum: 599
          minimum: 100
          type: integer
          format: int32
          x-mabl-scope: public
        message:
          type: string
          x-mabl-scope: public
        error_code:
          type: string
          description: Machine-readable reason for the error, present only when the API names one. Values are guardrail_blocked (a guardrail policy refused an agent request), approval_required (a guardrail policy requires a person to approve the request first).
        guardrail:
          description: The guardrail policy that refused the request; present only when error_code is guardrail_blocked or approval_required.
          allOf:
          - $ref: '#/components/schemas/GuardrailRefusal'
    FindElementAttribute:
      required:
      - id
      - value
      type: object
      properties:
        id:
          type: string
          description: The identifier for this attribute, must be unique among all provided attributes
        value:
          type: string
          description: The text value of this attribute
    FindElementAttributeEvaluation:
      required:
      - id
      - weight
      type: object
      properties:
        id:
          type: string
          description: The identifier for this attribute
        explanation:
          type: string
          description: Model-provided explanation for the evaluation of this attribute
        weight:
          type: number
          description: A multiplicative factor to apply to the score of this attribute based on evaluating the relevance of its value
          format: double
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header