Palavras embaralhadas Referência da API

Palavras embaralhadas: Esta referência obtém modos, configurações, formatos e campos do mesmo registro e contrato da API.

Chaves API

Exemplo de solicitação

curl -X POST https://puzzlegenio.com/api/v1/puzzles \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Idempotency-Key: task-000000000001' \
  -H 'Content-Type: application/json' \
  -d '{ "type": "scramble", "title": "Animal scramble", "input": { "words": [ "TIGER", "HORSE", "RABBIT" ] } }'

Modos

scramble · double

Configurações de página

Formatos de exportação no navegador

png · pdf

Os formatos dependem das configurações e do plano. viewUrl e exportPageUrl levam ao download no navegador; a resposta não contém arquivos PDF, PNG ou STL. As permissões são fixadas na publicação e revistas ao republicar.

Campos comuns

Campo	Valor aceito	Obrigatório
preset	texto	Não
mode	texto	Não
locale	uma opção; en \| zh \| es \| de \| fr \| pt \| it \| id \| ja \| ko	Não
contentLanguage	uma opção; en \| zh \| es \| de \| fr \| pt \| it \| id \| ja \| ko	Não
title	texto	Sim
retentionDays	número; inteiro	Não
appearance.fontFamily	uma opção; sans \| serif \| handwriting \| playful \| mono	Não
appearance.themeColor	texto	Não
appearance.footerText	texto; máximo 200	Não
appearance.borderStyle	uma opção; solid \| dashed \| dotted	Não
appearance.layoutMode	uma opção; default \| worksheet	Não
appearance.pillTitle	verdadeiro/falso	Não
appearance.showWorksheetHeader	verdadeiro/falso	Não
appearance.outerBorder	verdadeiro/falso	Não
appearance.titleScale	número; mínimo 0.5; máximo 3	Não
appearance.letterCase	uma opção; uppercase \| lowercase	Não
appearance.answerStyle	uma opção; boxed \| line	Não
appearance.secretShade	verdadeiro/falso	Não
appearance.rowSpacing	uma opção; compact \| normal \| relaxed	Não
appearance.hideInstructions	verdadeiro/falso	Não
export.paperSize	uma opção; A3 \| A4 \| A4-landscape \| A5 \| B5 \| Letter \| Letter-landscape \| Legal \| Half-Letter \| Tabloid \| custom	Não
export.widthMm	número; mínimo 50; máximo 2000	Não
export.heightMm	número; mínimo 50; máximo 2000	Não
export.unit	uma opção; mm \| cm \| in \| px	Não
export.quality	uma opção; standard \| high \| print	Não
input.words	lista; mínimo 1; máximo 20	Sim
input.words[]	texto; mínimo 2; máximo 15	Sim
input.secretMessage	texto; máximo 200	Não
options.seed	número; inteiro; mínimo 0; máximo 2147483647	Não
options.hintMode	uma opção; none \| first-letter	Não
options.revealLetters	lista; máximo 26	Não
options.revealLetters[]	texto	Não
options.showWordBank	verdadeiro/falso	Não

Modelos e temas

Consulte /api/v1/capabilities para ver modelos, temas e limites da conta. Usar um modelo também ocupa uma vaga salva.

Imagens e arquivos

A entrada de imagem usa um assetId enviado ou importado pela mesma conta. O download acontece na página do resultado; o endereço dessa página não é um arquivo direto.

Casos de erro

Campos desconhecidos ou combinações incompatíveis de type, mode e preset retornam 422. Entradas que não geram um quebra-cabeça completo também retornam 422. Os formatos dependem das configurações e do plano.