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

# List searches

> Returns your past searches and similarity lookups, newest first. Free: listing history costs no credits.

Search results themselves are not stored, only the request and its outcome. Extraction history lives at [`GET /design/submissions`](/api-reference/endpoint/list-submissions).



## OpenAPI

````yaml api-reference/openapi.json GET /search/submissions
openapi: 3.1.0
info:
  title: Taste Engine Design API
  version: 1.0.0
  description: >-
    Public REST API for the Taste Engine. Submit a URL, extract a structured
    design system from any website, search the brand corpus by aesthetic, and
    ground prompts in real brand profiles.


    All requests are authenticated with an API key sent in the `X-API-Key`
    header. Create one directly in the Engine dashboard at
    https://engine.tastelabs.com/app/api-keys.
  contact:
    name: Taste Engine Support
    email: support@thetaste.ai
servers:
  - url: https://api.tastelabs.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Account
    description: Identity of the authenticated API key holder.
  - name: Submissions
    description: >-
      Create and track extraction jobs, then retrieve the resulting design
      system.
  - name: Prompts
    description: Rewrite prompts grounded in an extracted brand profile.
  - name: Search
    description: >-
      Find brands in the curated corpus by describing an aesthetic, or by
      similarity to one of your own extractions.
  - name: Brand adherence
    description: >-
      Judge how well a page adheres to a reference site's brand: submit a pair
      of URLs, poll the job, then read the verdict.
paths:
  /search/submissions:
    get:
      tags:
        - Search
      summary: List searches
      description: >-
        Returns your past searches and similarity lookups, newest first. Free:
        listing history costs no credits.


        Search results themselves are not stored, only the request and its
        outcome. Extraction history lives at [`GET
        /design/submissions`](/api-reference/endpoint/list-submissions).
      operationId: listSearches
      parameters:
        - name: kind
          in: query
          required: false
          description: Filter to query searches or similarity lookups.
          schema:
            type: string
            enum:
              - search
              - similar
        - name: status
          in: query
          required: false
          description: Filter by outcome.
          schema:
            type: string
            enum:
              - completed
              - failed
              - in_progress
        - name: depth
          in: query
          required: false
          description: Filter query searches by depth.
          schema:
            type: string
            enum:
              - fast
              - deep
        - name: q
          in: query
          required: false
          description: Free-text filter over the query text.
          schema:
            type: string
        - name: api_key_id
          in: query
          required: false
          description: >-
            Only searches made with one API key. Useful for separating
            environments that share an account.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: Maximum number of searches to return.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: offset
          in: query
          required: false
          description: Number of searches to skip, for pagination.
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: A page of past searches.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchSubmissionList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    SearchSubmissionList:
      type: object
      properties:
        submissions:
          type: array
          description: Past searches, newest first.
          items:
            $ref: '#/components/schemas/SearchSubmission'
        total:
          type: integer
          description: Total searches matching the filter, ignoring pagination.
        total_by_status:
          type: object
          additionalProperties:
            type: integer
          description: >-
            Counts by outcome under the other filters, ignoring pagination, so a
            status picker can label its options.
        limit:
          type: integer
        offset:
          type: integer
    SearchSubmission:
      type: object
      description: >-
        One past search. Results are not stored, only the request and its
        outcome.
      properties:
        id:
          type: string
          description: Identifier of the search.
        kind:
          type: string
          description: '`search` for a query search, `similar` for a similarity lookup.'
          enum:
            - search
            - similar
        query:
          type: string
          description: The query text, or the source URL for a `similar` lookup.
        depth:
          oneOf:
            - $ref: '#/components/schemas/SearchDepth'
            - type: 'null'
          description: Depth used. `null` for `similar` lookups.
        filters:
          type:
            - object
            - 'null'
          description: The hard constraints sent with the search, when any.
        query_tags:
          type:
            - object
            - 'null'
          description: >-
            The engine's soft reading of the query, as returned with the
            results.
        status:
          type: string
          description: Outcome of the search.
        result_count:
          type:
            - integer
            - 'null'
          description: How many results the search returned.
        latency_ms:
          type:
            - integer
            - 'null'
          description: How long the search took, in milliseconds.
        credit_ref_id:
          type:
            - string
            - 'null'
          description: Reference to the credit charge for this search.
        credits_consumed:
          type:
            - integer
            - 'null'
          description: Credits consumed by this search, net of any refund.
        api_key_name:
          type:
            - string
            - 'null'
          description: Name of the API key that made the search, when one was used.
        created_at:
          type: string
          format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
    Error:
      type: object
      description: >-
        Standard error envelope for non-2xx responses: the machine-readable
        `error` code and the human-readable `message` are nested under `detail`.
        Validation errors (`422`) and search failures (`502`, `503`) shape
        `detail` differently; see those responses.
      properties:
        detail:
          type: object
          properties:
            error:
              type: string
              description: Machine-readable error code.
              examples:
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - NOT_READY
            message:
              type: string
              description: Human-readable explanation of the error.
          required:
            - error
            - message
          additionalProperties: true
      required:
        - detail
    SearchDepth:
      type: string
      description: >-
        Search depth. `fast` returns in seconds. `deep` consumes more credits
        and can take up to ~3 minutes, for when result quality matters more than
        latency.
      enum:
        - fast
        - deep
      default: fast
  responses:
    Unauthorized:
      description: The API key is missing, invalid, or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail:
              error: UNAUTHORIZED
              message: Bearer token or X-API-Key required
    InternalError:
      description: An unexpected server error occurred. The body is plain text.
      content:
        text/plain:
          example: Internal Server Error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key issued by the Taste Engine. Create one in the dashboard at
        https://engine.tastelabs.com/app/api-keys.

````