Skip to main content
GET
Find shows by name

Authorizations

Authorization
string
header
required

Authorization: Bearer hk_live_... for live keys or Authorization: Bearer hk_test_... for test-mode keys. hk_test_ keys resolve real public catalog metadata but return deterministic committed fixtures, never call inference, and never mutate live credits. This is the only transport for the credential: the x-api-key alias once documented was removed in 0.2.0, because the edge authorizer reads Authorization as its single identity source and a request on any other header is refused before it is authenticated.

Never accepted on a dashboardJwt operation, and there are no exceptions. GET /v1/usage and GET /v1/limits briefly declared both schemes (0.8.0); that was withdrawn in 0.8.1 because no deployed route could honor it — both operations are served by the control-plane API, whose authorizer verifies a Cognito token and refuses an hk_live_ credential on shape, and the customer API does not route either path. An API-key holder reads its balance and reservation from QuoteResponse, which carries balance_credits and reserved_credits on every quote. Every operation in this document takes one scheme or the other and refuses the wrong one as unauthenticated.

Query Parameters

q
string
required

Free-text show search query.

Required string length: 1 - 200
limit
integer
default:20

Maximum number of items to return.

Required range: 1 <= x <= 100

Response

The matching shows, ranked as described above.

data
object[]
required
Maximum array length: 100
excluded
object[]
required
Maximum array length: 100
next_cursor
required

Always null; the provider does not page this call.

Pattern: ^[A-Za-z0-9_-]{1,512}$