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

# Triage a maintenance issue

> Returns steps the customer could try themselves, along with a suggested name, category and priority for the issue. Nothing is created or changed.



## OpenAPI

````yaml openapi-maintenance.json POST /v1/maintenance/triage
openapi: 3.1.0
info:
  title: Yorlet Maintenance API
  description: >-
    APIs for managing maintenance issues, the jobs raised against them, supplier
    quotes, and the conversation with the tenant.
  version: 1.0.0
servers:
  - url: https://api.yorlet.com
    description: Production
  - url: https://api.yorlet.io
    description: Sandbox
security: []
paths:
  /v1/maintenance/triage:
    post:
      tags:
        - Maintenance Triage
      summary: Triage a maintenance issue
      description: >-
        Returns steps the customer could try themselves, along with a suggested
        name, category and priority for the issue. Nothing is created or
        changed.
      operationId: maintenance_issues_create
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  minLength: 1
                  maxLength: 2000
                  description: The customer description of the issue to triage.
                issue_category:
                  type: string
                  enum:
                    - air_conditioning
                    - appliance
                    - electricity
                    - exterior
                    - heating_system
                    - housekeeping
                    - housing
                    - locksmith
                    - other
                    - painting
                    - pest_control
                    - plumbing
                  description: The category the customer picked, used as a hint.
              required:
                - description
      responses:
        '200':
          description: Returns a triage object if the request succeeded.
          content:
            application/json:
              schema:
                type: object
                properties:
                  relevant:
                    type: boolean
                    description: >-
                      Whether the description is about a property maintenance
                      issue at all.
                  emergency:
                    type: boolean
                    description: >-
                      Whether this reads as an emergency — a gas leak, a fire
                      risk, a flood, no water, or no heating in cold weather. An
                      emergency is never self-resolvable.
                  name:
                    type: string
                    description: >-
                      A short, specific title for the issue, suitable for a list
                      of work. No trailing period.
                  issue_category:
                    type: string
                    enum:
                      - air_conditioning
                      - appliance
                      - electricity
                      - exterior
                      - heating_system
                      - housekeeping
                      - housing
                      - locksmith
                      - other
                      - painting
                      - pest_control
                      - plumbing
                    description: The category the description best fits.
                  priority:
                    type: number
                    description: >-
                      A suggested priority from 0 to 3, where 0 is low, 1 is
                      medium, 2 is high and 3 is urgent.
                  suggestions:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                          description: >-
                            A short label for the suggestion, no more than a few
                            words.
                        detail:
                          type: string
                          description: >-
                            What to do, in plain language, addressed to the
                            customer.
                      required:
                        - title
                        - detail
                    description: >-
                      Safe, practical steps the customer can try themselves,
                      most likely to help first. Empty when nothing can safely
                      be attempted.
                  object:
                    type: string
                    enum:
                      - maintenance.triage
                  session:
                    type:
                      - string
                      - 'null'
                    description: >-
                      The completion session recording the exchange. Pass it
                      back as `triage.portal_completion_session` when creating
                      the issue so the team can see what was suggested.
                description: An AI-generated triage of a maintenance issue description.
                required:
                  - relevant
                  - emergency
                  - name
                  - issue_category
                  - priority
                  - suggestions
                  - object
                  - session
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API Key authentication. Use "Bearer YOUR_API_KEY".

````