Genre Queries

Generated genre queries operations.

DELETE/v1/genre-queries/{id}Release a genre preparation handleread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: cancel_genre_query

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternalrevision_mismatchstale_continuationsearch_busymetadata_unavailabledatabase_busywriter_capacity

Example request

curl -X DELETE "http://127.0.0.1:32500/v1/genre-queries/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/genre-queries/{id}Read a genre preparation or its ready windowread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_genre_query

Parameters

Name	In	Type	Description
`id`required	path	`string`

Responses

200Successapplication/json

Example

{
  "genres": [
    {
      "backdrop": {
        "id": "id_8h2k4q",
        "kind": "item",
        "path": "string"
      },
      "count": 1,
      "covers": [
        {
          "id": "id_8h2k4q",
          "kind": "item",
          "path": "string"
        }
      ],
      "label": "string",
      "value": "string"
    }
  ],
  "hasGenres": true,
  "nextCursor": "eyJvIjoyMH0",
  "previousCursor": "eyJvIjoyMH0",
  "queryId": "id_8h2k4q",
  "reloadCursor": "eyJvIjoyMH0",
  "revision": "r12",
  "variant": "ready"
}

Schema

genresarray of objectrequired0–50 items
- backdropobject
  - idstringrequired
  - kindstringrequiredone of "item", "show"
  - pathstringrequired
- countintegerrequired≥ 1
- coversarray of objectrequired0–2 items
  - idstringrequired
  - kindstringrequiredone of "item", "show"
  - pathstringrequired
- labelstringrequired
- valuestringrequired
hasGenresboolean
nextCursorstringlength 1–512pattern ^[A-Za-z0-9_-]+$
previousCursorstringlength 1–512pattern ^[A-Za-z0-9_-]+$
queryIdstringrequiredlength 1–512pattern ^[A-Za-z0-9_-]+$
reloadCursorstringlength 1–512pattern ^[A-Za-z0-9_-]+$
revisionstringrequired
variant"ready"required

202Successapplication/json

Example

{
  "kind": "genre-preparing",
  "queryId": "id_8h2k4q",
  "retryAfterMs": 1800000,
  "state": "preparing",
  "variant": "preparing"
}

Schema

kind"genre-preparing"required
queryIdstringrequiredlength 1–512pattern ^[A-Za-z0-9_-]+$
retryAfterMsintegerrequired≥ 1
state"preparing"required
variant"preparing"required

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternalrevision_mismatchstale_continuationsearch_busymetadata_unavailabledatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/genre-queries/{id}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"