mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 08:08:32 +00:00
1a1bb0ca3d
* docs(cli): document device-code login and config reset guidance; renumber sections * docs(cli): fix duplicate numbering (renumber Login/API Keys/Configuration sections) * docs: Fix webhook documentation to include meta dict in all webhook payloads - Add note explaining that meta objects from kickoff requests are included in all webhook payloads - Update webhook examples to show proper payload structure including meta field - Fix webhook examples to match actual API implementation - Apply changes to English, Korean, and Portuguese documentation Resolves the documentation gap where meta dict passing to webhooks was not documented despite being implemented in the API. * WIP: CrewAI docs theme, changelog, GEO, localization * docs(cli): fix merge markers; ensure mode: "wide"; convert ASCII tables to Markdown (en/pt-BR/ko) * docs: add group icons across locales; split Automation/Integrations; update tools overviews and links
78 lines
1.5 KiB
Plaintext
78 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`.
|
||
|
||
|