Frigate NVR API

openapi: 3.1.0
info:
  title: Frigate NVR API
  version: '2026-10-28'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-28: 5 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Frigate NVR has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 2
    pages-with-code: 2
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-28'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.frigate.video/configuration/advanced/system
  - https://docs.frigate.video/configuration/record
  - https://docs.frigate.video/configuration/authentication
paths:
  /api/config/save:
    post:
      operationId: post_api_config_save
      tags:
      - Api
      summary: POST /api/config/save
      x-source: https://docs.frigate.video/configuration/advanced/system
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST http://frigate_host:5000/api/config/save -d @config.json \n if you'd like you can use your yaml config directly\
          \ by using yq to convert it to json: \n yq -o = json '.' config.yaml | curl -X POST 'http://frigate_host:5000/api/config/save?save_option=saveonly'\
          \ --data-binary @- \n Via Command Line ​ \n You can also validate your config at the command line by using the docker container itself."
  /api/login:
    post:
      operationId: post_api_login
      tags:
      - Api
      summary: POST /api/login
      x-source: https://docs.frigate.video/configuration/authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiLoginRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -i -X POST https://frigate_ip:8971/api/login \\ -H \"Content-Type: application/json\" \\ -d '{\"user\": \"admin\", \"password\"\
          : \"your_password\"}' \n note You may need to include -k in the argument list in these steps (eg: curl -k -i -X POST ... ) if your Frigate\
          \ instance is using a self-signed certificate. \n The response will contain a cookie with the JWT token. \n 2. Using the Bearer Token\
          \ ​ \n Once you"
  /api/media/sync:
    post:
      operationId: post_api_media_sync
      tags:
      - Api
      summary: Syncing Media Files With Disk
      x-source: https://docs.frigate.video/configuration/record
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiMediaSyncResponse'
      x-evidence:
        kind: documentation
  /api/profile:
    get:
      operationId: get_api_profile
      tags:
      - Api
      summary: GET /api/profile
      x-source: https://docs.frigate.video/configuration/authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -H \"Authorization: Bearer <your_token>\" https://frigate_ip:8971/api/profile \n 3. Token Lifecycle ​ \n Tokens are valid\
          \ for the configured session length \n Tokens are automatically refreshed when you visit the /auth endpoint \n Tokens are invalidated\
          \ when the user's password is changed \n Use /logout to clear your session cookie \n Edit this page Previous Enrichments Next Notifications\
          \ Onboarding "
  /export/custom/{cameraName}/start/{startTime}/end/{endTime}:
    post:
      operationId: post_export_custom_cameraName_start_startTime_end_endTime
      tags:
      - Export
      summary: Custom export with FFmpeg arguments
      x-source: https://docs.frigate.video/configuration/record
      parameters:
      - name: cameraName
        in: path
        required: true
        schema:
          type: string
      - name: startTime
        in: path
        required: true
        schema:
          type: string
      - name: endTime
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostExportCustomCameranameStartStarttimeEndEndtimeRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostExportCustomCameranameStartStarttimeEndEndtimeResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiLoginRequest:
      type: object
      properties:
        user:
          type: string
        password:
          type: string
    PostApiMediaSyncResponse:
      type: object
      properties:
        job_id:
          type: string
          description: Identifier for the media sync job
    PostExportCustomCameranameStartStarttimeEndEndtimeRequest:
      type: object
      properties:
        name:
          type: string
          description: Export name
        ffmpeg_input_args:
          type: string
          description: Custom FFmpeg input arguments
        ffmpeg_output_args:
          type: string
          description: Custom FFmpeg output arguments
        cpu_fallback:
          type: string
          description: If true, fallback to software encoding on failure
      required:
      - name
    PostExportCustomCameranameStartStarttimeEndEndtimeResponse:
      type: object
      properties:
        job_id:
          type: string
          description: Identifier for the export job
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Export