---
title: "Phrase Matches"
method: POST
path: "/v1/agent/projects/{project_id}/phrase-matches"
tags: ["Agent phrase matching"]
---

# Phrase Matches

`POST /v1/agent/projects/{project_id}/phrase-matches`

## Request

- Base URL: `https://api.lyricpatch.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.lyricpatch.com/v1/agent/projects/{project_id}/phrase-matches`
- Auth: none declared

## Path parameters

- `project_id` string, uuid, required

## Headers

- `authorization` string, nullable

## Request body

- PhraseMatchRequest
  - `target_phrase` string, required
  - `words` SuppliedTranscriptWord[], required
    - `text` string, required
    - `start_seconds` number, required
    - `end_seconds` number, required

## Response `200`

Successful Response

- PhraseMatchResponse
  - `project_id` string, uuid, required
  - `source` 'agent_supplied_transcript'
  - `match_status` 'matched' | 'ambiguous' | 'not_found' | 'too_long' | 'too_short', required
  - `candidates` PhraseCandidate[], required
    - `start_sample` integer, required
    - `end_sample` integer, required
    - `start_seconds` number, required
    - `end_seconds` number, required
    - `matched_text` string, required
    - `match_type` 'exact' | 'approximate', required
    - `selection_valid` boolean, required
    - `requires_confirmation` boolean, required
    - `score` number, required: Text similarity, not confidence that these words were sung or that their timestamps are accurate.
  - `transcript_verified` false
  - `credits_charged` 0
  - `message` string, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/lyricpatch/apis/lyricpatch-api.md) · [All operations](https://skmtc.dev/lyricpatch/apis/lyricpatch-api/llms.txt) · [OpenAPI document](https://skmtc.dev/lyricpatch/apis/lyricpatch-api/revisions/307fbddfa9b0?raw)