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

# Identify an album from a cover photo

> Upload a photo of the front cover; get back the albums whose cover looks most like it, with a similarity score. The photo is processed in memory and never stored.

A cover identifies the album, not the pressing: most pressings share artwork. Keep the cover upright, since a sideways photo scores much lower. Use a barcode when there is one; it is far more reliable.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/identify
openapi: 3.1.0
info:
  title: Open Vinyl API
  description: >-
    Open catalog of vinyl albums and pressings built from Discogs (CC0),
    MusicBrainz (CC0), Wikidata (CC0) and Cover Art Archive links.
  version: 0.2.0
servers:
  - url: https://api.openvinyl.dev
    description: Open Vinyl API
  - url: http://127.0.0.1:8000
    description: self-hosted (openvinyl serve)
security:
  - {}
  - apiKey: []
paths:
  /v1/identify:
    post:
      tags:
        - Identify
      summary: Identify an album from a cover photo
      description: >-
        Upload a photo of the front cover; get back the albums whose cover looks
        most like it, with a similarity score. The photo is processed in memory
        and never stored.


        A cover identifies the album, not the pressing: most pressings share
        artwork. Keep the cover upright, since a sideways photo scores much
        lower. Use a barcode when there is one; it is far more reliable.
      operationId: identify_v1_identify_post
      parameters:
        - name: k
          in: query
          required: false
          schema:
            type: integer
            maximum: 25
            default: 5
            title: K
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_identify_v1_identify_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Identify V1 Identify Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Body_identify_v1_identify_post:
      properties:
        photo:
          type: string
          contentMediaType: application/octet-stream
          title: Photo
          description: photo of the front cover
      type: object
      required:
        - photo
      title: Body_identify_v1_identify_post
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: ov_live_…
      description: >-
        Optional. Keys raise the rate limit; without one, requests are limited
        per IP.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.