Deprecation notice: The parse PDF API endpoint at
/v1/tools/pdf-parser/{file_id}
is deprecated and will be removed on December 22, 2025.Migration path: We plan to introduce a prebuilt PDF parsing tool for chat completions that will provide similar functionality. This tool will work similarly to other prebuilt tools like the Vision tool or LLM tool. We will provide more details about this alternative when it becomes available.Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your Writer API key.
Path Parameters
The unique identifier of the file.
Body
application/json
The format into which the PDF content should be converted.
Available options:
text
, markdown
Response
200 - application/json
The extracted content from the PDF file, converted to the specified format.