Home
HomeGuidesRecipesAPI ReferencePython SDKAI Agent SDKAlation Data Quality SDKAlation's MCP Server
HomeAlation Help Center
API Reference
Alation Help Center

Export this chat as a PDF (async)

post
{protocol}://{base-url}/ai/api/v1/chats//pdf

Enqueue a background job that runs the generate_pdf_from_chat agent against the chat's history and saves the PDF as an asset on this chat. Retrieve the resulting PDF with GET /chats/{chat_id}/pdf.

Path Params
string
required

The ID of the Chat to use.

Body Params

Request body for POST /chats/{chat_id}/pdf.

The endpoint enqueues generate_pdf_from_chat as a background job;
callers retrieve the resulting PDF via GET /chats/{chat_id}/pdf.

length ≥ 1

Optional override for the message sent to the agent. Defaults to
:data:DEFAULT_EXPORT_PDF_MESSAGE.

string | DefaultAgentRef
Defaults to generate_pdf_from_chat_agent

Optional override for the agent that produces the PDF.

Accepts a :class:DefaultAgentRef (e.g. the default
GENERATE_PDF_FROM_CHAT) or the UUID of a tenant-scoped
:class:AgentConfig, so callers can plug in a custom chart- or
summary-generation agent that produces a kind="pdf" asset.

Responses

Updated 3 days ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 days ago

Did this page help you?