Skip to content

Import External File

POST
/api/writing/external-files/import

🔗 Import an external file reference.

Creates a reference link to an external file without copying content. Useful for linking research materials, reference documents, and external resources while maintaining accessibility within the project.

Args: file_path: Filesystem path to the external file project_type: Project category for organization (default: “general”)

Returns: str: Generated file reference ID for tracking

Raises: HTTPException: 500 if external file import fails

Example Response: “ext_file_1703001234567”

Body_import_external_file_api_writing_external_files_import_post
object
file_path
required
File Path
string
project_type
Project Type
string
default: general

Successful Response

Response Import External File Api Writing External Files Import Post
string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object