{"openapi":"3.1.0","info":{"title":"Briefing Board API","version":"1.1.0","description":"Submit content packages (\"briefings\") and receive an unguessable share link that renders a mobile-first reading page. Obtain an API key at /get-key.\n"},"servers":[{"url":"/api/v1"}],"security":[{"bearerAuth":[]}],"paths":{"/briefings":{"post":{"operationId":"createBriefing","summary":"Submit a briefing","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriefingInput"},"example":{"title":"Weekly market pulse","subtitle":"What moved and why","summary":"Equities rose 2% on easing rates; energy lagged.","body":"## Highlights\n\n- S&P 500 +2.1%\n- Brent -3.4%","images":[{"caption":"S&P 500 weekly chart","kind":"informational","url":"https://example.com/chart.png"},{"caption":"Trading floor","kind":"visual","cover":true,"data":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="}]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BriefingCreated"}}}},"400":{"$ref":"#/components/responses/Error"},"401":{"$ref":"#/components/responses/Error"},"413":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"}}}},"/briefings/{id}":{"delete":{"operationId":"deleteBriefing","summary":"Delete a briefing published with any key of the same email","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":43}}],"responses":{"204":{"description":"Deleted"},"401":{"$ref":"#/components/responses/Error"},"404":{"$ref":"#/components/responses/Error"}}}},"/keys":{"post":{"operationId":"requestKey","summary":"Email a new API key to an address","description":"The email contains the key and a ready-to-paste prompt that sets an agent up to publish briefings. CORS-enabled (any origin) so browser sign-up forms can call it directly.","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["email"],"properties":{"email":{"type":"string","format":"email","maxLength":254}}}}}},"responses":{"202":{"description":"Accepted; if the address is valid an email is on its way.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","const":"accepted"}}}}}},"400":{"$ref":"#/components/responses/Error"},"429":{"$ref":"#/components/responses/Error"},"502":{"$ref":"#/components/responses/Error"}}}},"/openapi.json":{"get":{"operationId":"getOpenApi","summary":"This document as JSON","security":[],"responses":{"200":{"description":"OpenAPI document"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key from /get-key. `X-API-Key: <key>` is also accepted."}},"responses":{"Error":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"BriefingInput":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","minLength":1,"maxLength":200},"subtitle":{"type":"string","maxLength":300},"summary":{"type":"string","maxLength":1024},"body":{"type":"string","maxLength":100000,"description":"Markdown (GFM). Raw HTML is not rendered."},"images":{"type":"array","maxItems":20,"items":{"$ref":"#/components/schemas/ImageInput"}}}},"ImageInput":{"type":"object","additionalProperties":false,"required":["caption","kind"],"properties":{"caption":{"type":"string","minLength":1,"maxLength":500},"kind":{"type":"string","enum":["informational","visual"],"description":"informational = never cropped (charts, diagrams); visual = may be cropped to fill."},"cover":{"type":"boolean","default":false,"description":"At most one image may be the cover."},"url":{"type":"string","format":"uri","pattern":"^https://"},"data":{"type":"string","description":"Base64 PNG/JPEG/WebP/GIF, raw or data URL, ≤ 3 MB decoded. The whole request must be ≤ 4 MB, so send larger images as `url`."}},"oneOf":[{"required":["url"]},{"required":["data"]}]},"BriefingCreated":{"type":"object","required":["id","url","createdAt"],"properties":{"id":{"type":"string","minLength":43,"description":"Share token"},"url":{"type":"string","format":"uri"},"createdAt":{"type":"string","format":"date-time"}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["validation_error","unauthorized","not_found","payload_too_large","rate_limited","email_failed","internal_error"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","required":["path","message"],"properties":{"path":{"type":"string","example":"images.1.url"},"message":{"type":"string"}}}}}}}}}}}