andre/crewAI
1
0
Fork 0
mirror of https://github.com/crewAIInc/crewAI.git synced 2026-04-08 03:58:23 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

docs: address review comments — consistent field names, input_files key, cross-references

Browse Source 
- Fix field name mismatch: use 'cover_image' in curl examples to match Python model
- Change 'inputFiles' to 'input_files' (snake_case) for Python API convention
- Add note that Option 3 is an alternative to multipart upload
- Add Platform API documentation reference for /files endpoint
- Add cross-reference from files.mdx to flows.mdx file inputs section

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Alex
2026-04-01 17:38:30 -07:00
parent 9e7f9423ea
commit 02df22681e
2 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/concepts/files.mdx
View File

@@ -135,7 +135,7 @@ result = flow.kickoff(
```
<Note type="info" title="CrewAI Platform Integration">
When deployed on CrewAI Platform, `ImageFile`, `PDFFile`, and other file-typed fields in your flow state automatically get a file upload UI. Users can drag and drop files directly in the Platform interface. Files are stored securely and passed to agents using provider-specific optimizations (inline base64, file upload APIs, or URL references depending on the provider).
When deployed on CrewAI Platform, `ImageFile`, `PDFFile`, and other file-typed fields in your flow state automatically get a file upload UI. Users can drag and drop files directly in the Platform interface. Files are stored securely and passed to agents using provider-specific optimizations (inline base64, file upload APIs, or URL references depending on the provider). For API usage examples, see [File Inputs in Flows](/concepts/flows#file-inputs).
</Note>
### With Standalone Agents

14
docs/en/concepts/flows.mdx
View File

@@ -384,7 +384,7 @@ Send files directly with the kickoff request:
curl -X POST https://your-deployment.crewai.com/kickoff \
-H 'Authorization: Bearer YOUR_TOKEN' \
-F 'inputs={"company_name": "Einstein"}' \
-F 'cnh_image=@/path/to/document.jpg'
-F 'cover_image=@/path/to/photo.jpg'
```
Files are automatically stored and converted to `FileInput` objects. The agent receives the file with provider-specific optimization (inline base64, file upload API, or URL reference depending on the LLM provider).
@@ -401,23 +401,25 @@ curl -X POST https://your-deployment.crewai.com/kickoff \
#### Option 3: Separate upload + kickoff
Upload files first, then reference them:
This is an alternative to multipart upload when you need to upload files separately from the kickoff request. Upload files first, then reference them by URL:
```bash
# Step 1: Upload
curl -X POST https://your-deployment.crewai.com/files \
-H 'Authorization: Bearer YOUR_TOKEN' \
-F 'file=@/path/to/document.jpg' \
-F 'field_name=cnh_image'
# Returns: {"url": "https://...", "field_name": "cnh_image"}
-F 'file=@/path/to/photo.jpg' \
-F 'field_name=cover_image'
# Returns: {"url": "https://...", "field_name": "cover_image"}
# Step 2: Kickoff with URL
curl -X POST https://your-deployment.crewai.com/kickoff \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"inputs": {"company_name": "Einstein"}, "inputFiles": {"cnh_image": "https://..."}}'
-d '{"inputs": {"company_name": "Einstein"}, "input_files": {"cover_image": "https://..."}}'
```
See the Platform API documentation for full `/files` endpoint details.
#### On CrewAI Platform
When using the Platform UI, file-typed fields automatically render as drag-and-drop upload zones. No API calls needed—just drop the file and click Run.