> ## 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.

# Update visibility

> Toggles whether a submission's result is public. Public results can be read from `GET /submissions/{id}/result` without authentication. Only the owner of the submission can change its visibility.



## OpenAPI

````yaml api-reference/openapi.json PATCH /design/submissions/{id}/visibility
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:
  /design/submissions/{id}/visibility:
    patch:
      tags:
        - Submissions
      summary: Update visibility
      description: >-
        Toggles whether a submission's result is public. Public results can be
        read from `GET /submissions/{id}/result` without authentication. Only
        the owner of the submission can change its visibility.
      operationId: updateSubmissionVisibility
      parameters:
        - $ref: '#/components/parameters/SubmissionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VisibilityUpdate'
            example:
              is_public: true
      responses:
        '200':
          description: The updated submission status view.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Submission'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    SubmissionId:
      name: id
      in: path
      required: true
      description: The `submission_id` returned when the submission was created.
      schema:
        type: string
  schemas:
    VisibilityUpdate:
      type: object
      properties:
        is_public:
          type: boolean
          description: >-
            Set to `true` to make the result publicly readable, `false` to make
            it private.
      required:
        - is_public
    Submission:
      type: object
      description: Status view of a single submission.
      properties:
        submission_id:
          type: string
        status:
          $ref: '#/components/schemas/SubmissionStatus'
        source_url:
          type: string
          format: uri
        current_step:
          type: string
          description: Name of the step currently running.
        step_started_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        cache_hit:
          type: boolean
          description: >-
            Whether the result was served from cache. When `true`,
            `completed_at` reflects the original extraction, not this request.
        extraction_id:
          type:
            - string
            - 'null'
        accepted_at:
          type: string
          format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the extraction completed: the freshness of the result. On a
            cache hit (`cache_hit` is `true`) this is the original extraction,
            not the current request, so it may predate this request. `null`
            while the submission is still running.
        error:
          type:
            - string
            - 'null'
          description: Error message when status is `failed`.
        credits_consumed:
          type:
            - integer
            - 'null'
          description: >-
            Net credits this submission consumed. `null` when metering was off,
            and `0` once a failed submission has been refunded.
        credit_ref_id:
          type:
            - string
            - 'null'
          description: Reference to the credit charge for this submission.
        api_key_name:
          type:
            - string
            - 'null'
          description: >-
            Name of the API key that created the submission. `null` for
            dashboard submissions and when metering was off at submission time.
        batch_id:
          type:
            - string
            - 'null'
          description: Identifier of the batch run this submission belongs to.
        batch_label:
          type:
            - string
            - 'null'
          description: Human-readable label for the batch run.
        is_public:
          type: boolean
          description: Whether the result is publicly readable.
      required:
        - submission_id
        - status
        - source_url
        - is_public
    SubmissionStatus:
      type: string
      description: Lifecycle status of a submission.
      enum:
        - accepted
        - queued
        - crawling
        - extracting
        - completed
        - failed
    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
  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
    Forbidden:
      description: The API key is valid but is not allowed to call this endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail:
              error: FORBIDDEN
              message: This key is not allowed to call this endpoint.
    NotFound:
      description: The resource was not found or is not accessible with these credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            detail:
              error: NOT_FOUND
              message: Submission not found
    ValidationError:
      description: >-
        The request failed validation. `detail` is a list of issues, each naming
        the offending field in `loc`.
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: array
                items:
                  type: object
                  properties:
                    loc:
                      type: array
                      items: {}
                    msg:
                      type: string
                    type:
                      type: string
          example:
            detail:
              - loc:
                  - body
                  - url
                msg: Field required
                type: missing
    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.

````