{"openapi":"3.1.0","info":{"title":"LinkDirect API","version":"1.3.0","description":"Create and edit short links, generate dynamic QR codes, read analytics and manage campaign batches through REST and MCP. One workspace, scoped credentials.","termsOfService":"https://linkdirect.co/en/tos"},"servers":[{"url":"https://linkdirect.co/api/v1"}],"security":[{"bearerAuth":[]}],"externalDocs":{"description":"Quick start, permissions, MCP, limits and retries","url":"https://linkdirect.co/developers"},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"LinkDirect API key","description":"Create a scoped key in /settings/api. Never use a query parameter."}}},"paths":{"/links/batch":{"post":{"operationId":"bulk_create_short_links","summary":"Create 1–50 short links atomically","description":"Requires links:write. Body up to 256 KiB. All items consume normal quotas; any failure rolls back the whole batch. One idempotency key covers the batch.","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[a-zA-Z0-9._:-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"destinationUrl":{"type":"string","minLength":1,"maxLength":4096,"format":"uri"},"title":{"type":"string","minLength":1,"maxLength":160},"domainId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"domainHostname":{"type":"string","minLength":1,"maxLength":254},"slug":{"type":"string","minLength":3,"maxLength":80,"pattern":"^[a-z0-9-]+$"},"utm":{"type":"object","properties":{"source":{"type":"string","minLength":1,"maxLength":160},"medium":{"type":"string","minLength":1,"maxLength":160},"campaign":{"type":"string","minLength":1,"maxLength":160},"term":{"type":"string","minLength":1,"maxLength":160},"content":{"type":"string","minLength":1,"maxLength":160}},"additionalProperties":false}},"required":["destinationUrl"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object","required":["items","count","atomic"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","shortUrl","destinationUrl","status","dashboardUrl"],"properties":{"id":{"type":"string","format":"uuid"},"domainId":{"type":["string","null"],"format":"uuid"},"linkId":{"type":"string","format":"uuid"},"name":{"type":"string"},"shortUrl":{"type":["string","null"],"format":"uri","description":"Null for static contact and Wi-Fi codes; use their authenticated image downloads."},"destinationUrl":{"type":["string","null"],"format":"uri"},"destinationType":{"type":"string"},"mode":{"type":"string","enum":["dynamic","static"]},"title":{"type":"string"},"configuration":{"type":"object"},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["active","paused","blocked","limited"]},"dashboardUrl":{"type":"string","format":"uri"},"downloads":{"type":"object","properties":{"png":{"type":"string","format":"uri"},"svg":{"type":"string","format":"uri"}}}}}},"count":{"type":"integer"},"atomic":{"type":"boolean","const":true}}}}}},"201":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object","required":["items","count","atomic"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","shortUrl","destinationUrl","status","dashboardUrl"],"properties":{"id":{"type":"string","format":"uuid"},"domainId":{"type":["string","null"],"format":"uuid"},"linkId":{"type":"string","format":"uuid"},"name":{"type":"string"},"shortUrl":{"type":["string","null"],"format":"uri","description":"Null for static contact and Wi-Fi codes; use their authenticated image downloads."},"destinationUrl":{"type":["string","null"],"format":"uri"},"destinationType":{"type":"string"},"mode":{"type":"string","enum":["dynamic","static"]},"title":{"type":"string"},"configuration":{"type":"object"},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["active","paused","blocked","limited"]},"dashboardUrl":{"type":"string","format":"uri"},"downloads":{"type":"object","properties":{"png":{"type":"string","format":"uri"},"svg":{"type":"string","format":"uri"}}}}}},"count":{"type":"integer"},"atomic":{"type":"boolean","const":true}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}},"patch":{"operationId":"bulk_update_short_links","summary":"Update 1–50 selected links atomically","description":"Requires links:write. Explicit distinct IDs, optional per-link ifVersion. Full rollback on any error. Body up to 256 KiB; one idempotency key covers the batch.","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[a-zA-Z0-9._:-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"updates":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"destinationUrl":{"type":"string","minLength":1,"maxLength":4096,"format":"uri"},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]},"utm":{"type":"object","properties":{"source":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]},"medium":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]},"campaign":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]},"term":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]},"content":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]}},"additionalProperties":false},"status":{"type":"string","enum":["active","paused"]},"geoRouting":{"anyOf":[{"type":"object","properties":{"version":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"enabled":{"type":"boolean"},"forwardQuery":{"type":"boolean"},"rules":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9-]{1,36}$"},"name":{"type":"string","minLength":1,"maxLength":80},"enabled":{"type":"boolean"},"countryOperator":{"type":"string","enum":["include","exclude"]},"countries":{"minItems":1,"maxItems":250,"type":"array","items":{"type":"string","pattern":"^[A-Za-z]{2}$"}},"destinationUrl":{"type":"string","minLength":1,"maxLength":4096}},"required":["id","name","enabled","countries","destinationUrl"],"additionalProperties":false}}},"required":["version","enabled","forwardQuery","rules"],"additionalProperties":false},{"type":"null"}]},"description":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"ogImageUrl":{"anyOf":[{"type":"string","minLength":1,"maxLength":4096,"format":"uri"},{"type":"null"}]},"ifVersion":{"type":"string","pattern":"^[a-f0-9]{64}$"},"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["id"],"additionalProperties":false}}},"required":["updates"],"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object","required":["items","count","atomic"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","shortUrl","destinationUrl","status","dashboardUrl"],"properties":{"id":{"type":"string","format":"uuid"},"domainId":{"type":["string","null"],"format":"uuid"},"linkId":{"type":"string","format":"uuid"},"name":{"type":"string"},"shortUrl":{"type":["string","null"],"format":"uri","description":"Null for static contact and Wi-Fi codes; use their authenticated image downloads."},"destinationUrl":{"type":["string","null"],"format":"uri"},"destinationType":{"type":"string"},"mode":{"type":"string","enum":["dynamic","static"]},"title":{"type":"string"},"configuration":{"type":"object"},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["active","paused","blocked","limited"]},"dashboardUrl":{"type":"string","format":"uri"},"downloads":{"type":"object","properties":{"png":{"type":"string","format":"uri"},"svg":{"type":"string","format":"uri"}}}}}},"count":{"type":"integer"},"atomic":{"type":"boolean","const":true}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}}},"/analytics/links":{"get":{"operationId":"get_top_links","summary":"Rank links by recorded visits","description":"Requires analytics:read. Optional source, country and days or ISO from/to. End exclusive, history clipped to plan retention; no visitor personal data.","parameters":[{"name":"days","in":"query","schema":{"type":"integer","minimum":1,"maximum":366}},{"name":"from","in":"query","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"to","in":"query","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"source","in":"query","schema":{"type":"string"}},{"name":"country","in":"query","schema":{"type":"string","pattern":"^[A-Za-z]{2}$"}},{"name":"limit","in":"query","schema":{"default":10,"type":"integer","minimum":1,"maximum":50}}],"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object","properties":{"range":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"timezone":{"type":"string","const":"UTC"},"endExclusive":{"type":"boolean","const":true},"retentionDays":{"type":"integer"},"truncated":{"type":"boolean"}}},"filters":{"type":"object"},"attribution":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"shortUrl":{"type":"string","format":"uri"},"clicks":{"type":"integer","minimum":0},"browserOpens":{"type":"integer","minimum":0},"stayedInApp":{"type":"integer","minimum":0},"browserOpenRate":{"type":"number","minimum":0,"maximum":100}}}}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}}},"/links/{id}/analytics":{"get":{"operationId":"get_link_analytics","summary":"Read aggregate link analytics","description":"Requires analytics:read. Owned standalone links only. Summary, daily UTC counts, sources and named countries, within plan history retention.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"days","in":"query","schema":{"type":"integer","minimum":1,"maximum":366}},{"name":"from","in":"query","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"to","in":"query","schema":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"}},{"name":"source","in":"query","schema":{"type":"string"}},{"name":"country","in":"query","schema":{"type":"string","pattern":"^[A-Za-z]{2}$"}}],"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object","properties":{"range":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"},"timezone":{"type":"string","const":"UTC"},"endExclusive":{"type":"boolean","const":true},"retentionDays":{"type":"integer"},"truncated":{"type":"boolean"}}},"filters":{"type":"object"},"attribution":{"type":"string"},"link":{"type":"object"},"summary":{"type":"object","properties":{"clicks":{"type":"integer","minimum":0},"browserOpens":{"type":"integer","minimum":0},"stayedInApp":{"type":"integer","minimum":0},"browserOpenRate":{"type":"number","minimum":0,"maximum":100}}},"daily":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date"},"clicks":{"type":"integer","minimum":0},"browserOpens":{"type":"integer","minimum":0},"stayedInApp":{"type":"integer","minimum":0},"browserOpenRate":{"type":"number","minimum":0,"maximum":100}}}},"sources":{"type":"array","items":{"type":"object"}},"countries":{"type":"array","items":{"type":"object"}}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}}},"/account":{"get":{"operationId":"get_account_limits","summary":"Get account limits and usage","description":"Requires account:read. Does not return payment or personal data.","responses":{"200":{"description":"Plan, limits, usage, API budgets and billingUrl","content":{"application/json":{"schema":{"type":"object","required":["plan","usage","api","billingUrl"],"properties":{"plan":{"type":"object"},"usage":{"type":"object"},"api":{"type":"object"},"billingUrl":{"type":"string","format":"uri"},"documentationUrl":{"type":"string","format":"uri"}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}}},"/domains":{"get":{"operationId":"list_domains","summary":"Discover active owned shortening domains","description":"Requires account:read. Copy an owned item's id into domainId for link/QR creation. Inactive and foreign domains are excluded; defaultDomain.id is null, so omit domainId and slug when using the shared default. No DNS or provisioning secrets are returned.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"default":20,"type":"integer","minimum":1,"maximum":50}},{"name":"offset","in":"query","required":false,"schema":{"default":0,"type":"integer","minimum":0,"maximum":10000}},{"name":"hostname","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":254}}],"responses":{"200":{"description":"Owned active domains and shared default","content":{"application/json":{"schema":{"type":"object","required":["items","defaultDomain","nextOffset"],"properties":{"items":{"type":"array","items":{"type":"object","required":["id","hostname","domainType","status","isDefault","allowsCustomSlug"],"properties":{"id":{"type":["string","null"],"format":"uuid"},"hostname":{"type":"string"},"domainType":{"type":"string","enum":["platform_subdomain","external_custom_domain","shared_default"]},"status":{"type":"string","const":"active"},"isDefault":{"type":"boolean"},"allowsCustomSlug":{"type":"boolean"}}}},"defaultDomain":{"type":"object","required":["id","hostname","domainType","status","isDefault","allowsCustomSlug"],"properties":{"id":{"type":["string","null"],"format":"uuid"},"hostname":{"type":"string"},"domainType":{"type":"string","enum":["platform_subdomain","external_custom_domain","shared_default"]},"status":{"type":"string","const":"active"},"isDefault":{"type":"boolean"},"allowsCustomSlug":{"type":"boolean"}}},"nextOffset":{"type":["integer","null"]}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}}},"/links":{"get":{"operationId":"list_short_links","summary":"List your standalone short links","description":"Requires links:read.","parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"maximum":10000,"default":0}}],"responses":{"200":{"description":"Owned resources","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","required":["id","shortUrl","destinationUrl","status","dashboardUrl"],"properties":{"id":{"type":"string","format":"uuid"},"domainId":{"type":["string","null"],"format":"uuid"},"linkId":{"type":"string","format":"uuid"},"name":{"type":"string"},"shortUrl":{"type":["string","null"],"format":"uri","description":"Null for static contact and Wi-Fi codes; use their authenticated image downloads."},"destinationUrl":{"type":["string","null"],"format":"uri"},"destinationType":{"type":"string"},"mode":{"type":"string","enum":["dynamic","static"]},"title":{"type":"string"},"configuration":{"type":"object"},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["active","paused","blocked","limited"]},"dashboardUrl":{"type":"string","format":"uri"},"downloads":{"type":"object","properties":{"png":{"type":"string","format":"uri"},"svg":{"type":"string","format":"uri"}}}}}},"nextOffset":{"type":["integer","null"]}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}},"post":{"operationId":"create_short_link","summary":"Create a short link","description":"Requires links:write. Uses the workspace plan's existing resource limit. Reuse the idempotency key with identical input for 24 hours. Custom slug requires an owned active domainId or domainHostname.","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[a-zA-Z0-9._:-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destinationUrl":{"type":"string","minLength":1,"maxLength":4096,"format":"uri"},"title":{"type":"string","minLength":1,"maxLength":160},"domainId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"domainHostname":{"type":"string","minLength":1,"maxLength":254},"slug":{"type":"string","minLength":3,"maxLength":80,"pattern":"^[a-z0-9-]+$"},"utm":{"type":"object","properties":{"source":{"type":"string","minLength":1,"maxLength":160},"medium":{"type":"string","minLength":1,"maxLength":160},"campaign":{"type":"string","minLength":1,"maxLength":160},"term":{"type":"string","minLength":1,"maxLength":160},"content":{"type":"string","minLength":1,"maxLength":160}},"additionalProperties":false}},"required":["destinationUrl"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay","content":{"application/json":{"schema":{"type":"object","required":["id","shortUrl","destinationUrl","status","dashboardUrl"],"properties":{"id":{"type":"string","format":"uuid"},"domainId":{"type":["string","null"],"format":"uuid"},"linkId":{"type":"string","format":"uuid"},"name":{"type":"string"},"shortUrl":{"type":["string","null"],"format":"uri","description":"Null for static contact and Wi-Fi codes; use their authenticated image downloads."},"destinationUrl":{"type":["string","null"],"format":"uri"},"destinationType":{"type":"string"},"mode":{"type":"string","enum":["dynamic","static"]},"title":{"type":"string"},"configuration":{"type":"object"},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["active","paused","blocked","limited"]},"dashboardUrl":{"type":"string","format":"uri"},"downloads":{"type":"object","properties":{"png":{"type":"string","format":"uri"},"svg":{"type":"string","format":"uri"}}}}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","required":["id","shortUrl","destinationUrl","status","dashboardUrl"],"properties":{"id":{"type":"string","format":"uuid"},"domainId":{"type":["string","null"],"format":"uuid"},"linkId":{"type":"string","format":"uuid"},"name":{"type":"string"},"shortUrl":{"type":["string","null"],"format":"uri","description":"Null for static contact and Wi-Fi codes; use their authenticated image downloads."},"destinationUrl":{"type":["string","null"],"format":"uri"},"destinationType":{"type":"string"},"mode":{"type":"string","enum":["dynamic","static"]},"title":{"type":"string"},"configuration":{"type":"object"},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["active","paused","blocked","limited"]},"dashboardUrl":{"type":"string","format":"uri"},"downloads":{"type":"object","properties":{"png":{"type":"string","format":"uri"},"svg":{"type":"string","format":"uri"}}}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}}},"/qr-codes":{"get":{"operationId":"list_qr_codes","summary":"List your QR codes","description":"Requires qr:read.","parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":50,"default":20}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"maximum":10000,"default":0}}],"responses":{"200":{"description":"Owned resources","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","required":["id","shortUrl","destinationUrl","status","dashboardUrl"],"properties":{"id":{"type":"string","format":"uuid"},"domainId":{"type":["string","null"],"format":"uuid"},"linkId":{"type":"string","format":"uuid"},"name":{"type":"string"},"shortUrl":{"type":["string","null"],"format":"uri","description":"Null for static contact and Wi-Fi codes; use their authenticated image downloads."},"destinationUrl":{"type":["string","null"],"format":"uri"},"destinationType":{"type":"string"},"mode":{"type":"string","enum":["dynamic","static"]},"title":{"type":"string"},"configuration":{"type":"object"},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["active","paused","blocked","limited"]},"dashboardUrl":{"type":"string","format":"uri"},"downloads":{"type":"object","properties":{"png":{"type":"string","format":"uri"},"svg":{"type":"string","format":"uri"}}}}}},"nextOffset":{"type":["integer","null"]}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}},"post":{"operationId":"create_qr_code","summary":"Create a dynamic website QR code","description":"Requires qr:write. Uses the workspace plan's existing resource limit. Reuse the idempotency key with identical input for 24 hours. Custom slug requires an owned active domainId or domainHostname.","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[a-zA-Z0-9._:-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destinationUrl":{"type":"string","minLength":1,"maxLength":4096,"format":"uri"},"title":{"type":"string","minLength":1,"maxLength":160},"domainId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"domainHostname":{"type":"string","minLength":1,"maxLength":254},"slug":{"type":"string","minLength":3,"maxLength":80,"pattern":"^[a-z0-9-]+$"},"utm":{"type":"object","properties":{"source":{"type":"string","minLength":1,"maxLength":160},"medium":{"type":"string","minLength":1,"maxLength":160},"campaign":{"type":"string","minLength":1,"maxLength":160},"term":{"type":"string","minLength":1,"maxLength":160},"content":{"type":"string","minLength":1,"maxLength":160}},"additionalProperties":false},"name":{"type":"string","minLength":2,"maxLength":160}},"required":["destinationUrl","name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Idempotent replay","content":{"application/json":{"schema":{"type":"object","required":["id","shortUrl","destinationUrl","status","dashboardUrl"],"properties":{"id":{"type":"string","format":"uuid"},"domainId":{"type":["string","null"],"format":"uuid"},"linkId":{"type":"string","format":"uuid"},"name":{"type":"string"},"shortUrl":{"type":["string","null"],"format":"uri","description":"Null for static contact and Wi-Fi codes; use their authenticated image downloads."},"destinationUrl":{"type":["string","null"],"format":"uri"},"destinationType":{"type":"string"},"mode":{"type":"string","enum":["dynamic","static"]},"title":{"type":"string"},"configuration":{"type":"object"},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["active","paused","blocked","limited"]},"dashboardUrl":{"type":"string","format":"uri"},"downloads":{"type":"object","properties":{"png":{"type":"string","format":"uri"},"svg":{"type":"string","format":"uri"}}}}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","required":["id","shortUrl","destinationUrl","status","dashboardUrl"],"properties":{"id":{"type":"string","format":"uuid"},"domainId":{"type":["string","null"],"format":"uuid"},"linkId":{"type":"string","format":"uuid"},"name":{"type":"string"},"shortUrl":{"type":["string","null"],"format":"uri","description":"Null for static contact and Wi-Fi codes; use their authenticated image downloads."},"destinationUrl":{"type":["string","null"],"format":"uri"},"destinationType":{"type":"string"},"mode":{"type":"string","enum":["dynamic","static"]},"title":{"type":"string"},"configuration":{"type":"object"},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["active","paused","blocked","limited"]},"dashboardUrl":{"type":"string","format":"uri"},"downloads":{"type":"object","properties":{"png":{"type":"string","format":"uri"},"svg":{"type":"string","format":"uri"}}}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}}},"/links/{id}":{"patch":{"operationId":"update_short_link","summary":"Edit an owned standalone link","description":"Requires links:write. Partial update; omitted fields preserved, UTM null removes a parameter. Short address unchanged. Optional ifVersion prevents stale writes. Moderation, ownership, subscription and reactivation quotas apply.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[a-zA-Z0-9._:-]+$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destinationUrl":{"type":"string","minLength":1,"maxLength":4096,"format":"uri"},"title":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]},"utm":{"type":"object","properties":{"source":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]},"medium":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]},"campaign":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]},"term":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]},"content":{"anyOf":[{"type":"string","minLength":1,"maxLength":160},{"type":"null"}]}},"additionalProperties":false},"status":{"type":"string","enum":["active","paused"]},"geoRouting":{"anyOf":[{"type":"object","properties":{"version":{"anyOf":[{"type":"number","const":1},{"type":"number","const":2}]},"enabled":{"type":"boolean"},"forwardQuery":{"type":"boolean"},"rules":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9-]{1,36}$"},"name":{"type":"string","minLength":1,"maxLength":80},"enabled":{"type":"boolean"},"countryOperator":{"type":"string","enum":["include","exclude"]},"countries":{"minItems":1,"maxItems":250,"type":"array","items":{"type":"string","pattern":"^[A-Za-z]{2}$"}},"destinationUrl":{"type":"string","minLength":1,"maxLength":4096}},"required":["id","name","enabled","countries","destinationUrl"],"additionalProperties":false}}},"required":["version","enabled","forwardQuery","rules"],"additionalProperties":false},{"type":"null"}]},"description":{"anyOf":[{"type":"string","minLength":1,"maxLength":500},{"type":"null"}]},"ogImageUrl":{"anyOf":[{"type":"string","minLength":1,"maxLength":4096,"format":"uri"},{"type":"null"}]},"ifVersion":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Successful scoped operation","content":{"application/json":{"schema":{"type":"object","required":["id","shortUrl","destinationUrl","status","dashboardUrl"],"properties":{"id":{"type":"string","format":"uuid"},"domainId":{"type":["string","null"],"format":"uuid"},"linkId":{"type":"string","format":"uuid"},"name":{"type":"string"},"shortUrl":{"type":["string","null"],"format":"uri","description":"Null for static contact and Wi-Fi codes; use their authenticated image downloads."},"destinationUrl":{"type":["string","null"],"format":"uri"},"destinationType":{"type":"string"},"mode":{"type":"string","enum":["dynamic","static"]},"title":{"type":"string"},"configuration":{"type":"object"},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["active","paused","blocked","limited"]},"dashboardUrl":{"type":"string","format":"uri"},"downloads":{"type":"object","properties":{"png":{"type":"string","format":"uri"},"svg":{"type":"string","format":"uri"}}}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}},"get":{"operationId":"get_short_link","summary":"Read your short link","description":"Requires links:read. Foreign or missing IDs return 404.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Owned short link","content":{"application/json":{"schema":{"type":"object","required":["id","shortUrl","destinationUrl","status","dashboardUrl"],"properties":{"id":{"type":"string","format":"uuid"},"domainId":{"type":["string","null"],"format":"uuid"},"linkId":{"type":"string","format":"uuid"},"name":{"type":"string"},"shortUrl":{"type":["string","null"],"format":"uri","description":"Null for static contact and Wi-Fi codes; use their authenticated image downloads."},"destinationUrl":{"type":["string","null"],"format":"uri"},"destinationType":{"type":"string"},"mode":{"type":"string","enum":["dynamic","static"]},"title":{"type":"string"},"configuration":{"type":"object"},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["active","paused","blocked","limited"]},"dashboardUrl":{"type":"string","format":"uri"},"downloads":{"type":"object","properties":{"png":{"type":"string","format":"uri"},"svg":{"type":"string","format":"uri"}}}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}}},"/qr-codes/{id}":{"get":{"operationId":"get_qr_code","summary":"Read your QR code","description":"Requires qr:read.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Owned QR code","content":{"application/json":{"schema":{"type":"object","required":["id","shortUrl","destinationUrl","status","dashboardUrl"],"properties":{"id":{"type":"string","format":"uuid"},"domainId":{"type":["string","null"],"format":"uuid"},"linkId":{"type":"string","format":"uuid"},"name":{"type":"string"},"shortUrl":{"type":["string","null"],"format":"uri","description":"Null for static contact and Wi-Fi codes; use their authenticated image downloads."},"destinationUrl":{"type":["string","null"],"format":"uri"},"destinationType":{"type":"string"},"mode":{"type":"string","enum":["dynamic","static"]},"title":{"type":"string"},"configuration":{"type":"object"},"version":{"type":"string","pattern":"^[a-f0-9]{64}$"},"status":{"type":"string","enum":["active","paused","blocked","limited"]},"dashboardUrl":{"type":"string","format":"uri"},"downloads":{"type":"object","properties":{"png":{"type":"string","format":"uri"},"svg":{"type":"string","format":"uri"}}}}}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}}},"/qr-codes/{id}/image":{"get":{"operationId":"download_qr_code","summary":"Download an owned QR code","description":"Requires qr:read and the Bearer header.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"format","in":"query","schema":{"type":"string","enum":["png","svg"],"default":"png"}}],"responses":{"200":{"description":"QR image","content":{"image/png":{"schema":{"type":"string","contentEncoding":"binary"}},"image/svg+xml":{"schema":{"type":"string"}}}},"400":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"401":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"403":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"404":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"409":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"413":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"415":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"429":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}},"503":{"description":"Structured API error. 429 includes Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"billingUrl":{"type":"string","format":"uri"},"retryAfter":{"type":"integer"}}}}}}}}}}}}}