Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: hyreflow engine (local) Brand API
version: 0.1.0
tags:
- name: Brand
paths:
/brand/{name}:
get:
summary: Brand Asset
description: 'Brand assets the emails reference.
Served by the ENGINE, not the web app, even though both answer on this host. The template that
points at the file lives here, so shipping the file here means the two can never skew: a web-side
asset 404s in every email sent between the api deploy and the web deploy, and the recipient just
sees a broken image. `/brand` is deliberately absent from web_code_paths so Traefik falls through.
Allowlisted rather than path-joined — `name` is caller-supplied.'
operationId: brand_asset_brand__name__get
parameters:
- name: name
in: path
required: true
schema:
type: string
title: Name
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
tags:
- Brand
components:
schemas:
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:
HTTPBearer:
type: http
scheme: bearer