Skip to main content
POST
Call documents.generate_pdf

Authorizations

Authorization
string
header
required

An API key minted at Settings › API & MCP. Send it as Authorization: Bearer <key>. A key carries its holder's own permissions, resolved on every call — revoking a membership closes the key's reach immediately. Keep it in an environment variable (GOOSY_API_KEY), never in a committed file.

Headers

x-request-id
string

Your own id for this request, echoed back and recorded on the audit trail. 1–128 characters from A–Z a–z 0–9 . _ : -, starting with a letter or digit; anything else is replaced by a generated id.

Maximum string length: 128

Body

application/json
name
string
required

The artifact's BASE name, with no file extension — the engine appends the one that matches what it actually wrote.

Required string length: 1 - 120
brief
string
required

What the document is, who it is for and everything it must say: its sections, its facts and figures, and any chart with its numbers.

Required string length: 1 - 8000
file_ids
string<uuid>[]

Stored files in this workspace the document is made from, by id: an upload to read, or a Word, Excel or PowerPoint file to edit and return beside the PDF.

Maximum array length: 5
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
pageSize
enum<string>

Defaults to a4.

Available options:
a4,
letter
orientation
enum<string>

Defaults to portrait.

Available options:
portrait,
landscape
workspace
string

Which workspace to run in — its slug. Omit to use your default. With more than one reachable workspace and no default, the call is refused and the choices are listed.

Minimum string length: 1

Response

The call was admitted and dispatched. ok says whether the tool succeeded — a refusal the tool itself produced is still a 200, exactly as it is a successful JSON-RPC result over MCP.

The tool ran and answered.

ok
boolean
required
status
enum<string>
required
Available options:
done,
running
job_run_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
workspace
string
required

The slug of the workspace this call ran in.

working_in
object
required

Which workspace this call ran in, and how that was decided. Present on every workspace-scoped result.

saved_in
string
files
object[]
summary
string