mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 16:18:30 +00:00
bf9e0423f2
Some checks failed
* WIP: v1 docs (#3626) (cherry picked from commit d46e20fa09bcd2f5916282f5553ddeb7183bd92c) * docs: parity for all translations * docs: full name of acronym AMP * docs: fix lingering unused code * docs: expand contextual options in docs.json * docs: add contextual action to request feature on GitHub * chore: tidy docs formatting
76 lines
1.5 KiB
Plaintext
76 lines
1.5 KiB
Plaintext
---
|
||
title: PDF Text Writing Tool
|
||
description: The `PDFTextWritingTool` writes text to specific positions in a PDF, supporting custom fonts.
|
||
icon: file-pdf
|
||
mode: "wide"
|
||
---
|
||
|
||
# `PDFTextWritingTool`
|
||
|
||
## Description
|
||
|
||
Write text at precise coordinates on a PDF page, optionally embedding a custom TrueType font.
|
||
|
||
## Parameters
|
||
|
||
### Run Parameters
|
||
|
||
- `pdf_path` (str, required): Path to the input PDF.
|
||
- `text` (str, required): Text to add.
|
||
- `position` (tuple[int, int], required): `(x, y)` coordinates.
|
||
- `font_size` (int, default `12`)
|
||
- `font_color` (str, default `"0 0 0 rg"`)
|
||
- `font_name` (str, default `"F1"`)
|
||
- `font_file` (str, optional): Path to `.ttf` file.
|
||
- `page_number` (int, default `0`)
|
||
|
||
## Example
|
||
|
||
```python Code
|
||
from crewai import Agent, Task, Crew
|
||
from crewai_tools import PDFTextWritingTool
|
||
|
||
tool = PDFTextWritingTool()
|
||
|
||
agent = Agent(
|
||
role="PDF Editor",
|
||
goal="Annotate PDFs",
|
||
backstory="Documentation specialist",
|
||
tools=[tool],
|
||
verbose=True,
|
||
)
|
||
|
||
task = Task(
|
||
description="Write 'CONFIDENTIAL' at (72, 720) on page 1 of ./sample.pdf",
|
||
expected_output="Confirmation message",
|
||
agent=agent,
|
||
)
|
||
|
||
crew = Crew(
|
||
agents=[agent],
|
||
tasks=[task],
|
||
verbose=True,
|
||
)
|
||
|
||
result = crew.kickoff()
|
||
```
|
||
|
||
### Direct usage
|
||
|
||
```python Code
|
||
from crewai_tools import PDFTextWritingTool
|
||
|
||
PDFTextWritingTool().run(
|
||
pdf_path="./input.pdf",
|
||
text="CONFIDENTIAL",
|
||
position=(72, 720),
|
||
font_size=18,
|
||
page_number=0,
|
||
)
|
||
```
|
||
|
||
## Tips
|
||
|
||
- Coordinate origin is the bottom‑left corner.
|
||
- If using a custom font (`font_file`), ensure it is a valid `.ttf`.
|