/v1/files/uploadFile/:filepathOrId
—
post
Path Parameters
FileMatcherPathParameters

Path parameters for identifying a file by either filepath or file ID

FieldTypeRequiredDescription
filepathOrIdstringNo

File path with workspace rootname (case insensitive) or file ID for flexible file identification

Example: /workspace-rootname/folder/file.ext

Request Headers
UploadFileEndpointHTTPHeaders

HTTP headers for file upload requests

FieldTypeRequiredDescription
AuthorizationstringNo

Access token

Example: Bearer <token>

Content-TypestringYes

HTTP multipart form-data request content type

Enum: multipart/form-data

Example: multipart/form-data

content-lengthnumberYes

File size in bytes

Number subset: floating point or integer

Max: 1073741824

Example: 1024000

x-fimidara-file-descriptionstringNo

Resource description

Example: This is a resource description.

x-fimidara-file-mimetypestringNo

File MIME type

Example: image/jpeg

x-fimidara-file-encodingstringNo

File encoding

Example: utf8

x-fimidara-file-sizenumberNo

File size in bytes

Number subset: floating point or integer

Max: 1073741824

Example: 1024000

x-fimidara-multipart-idstringNo

Client generated unique identifier for multipart uploads. It is used to identify the same multipart upload across multiple requests

Example: upload-123e4567-e89b-12d3-a456-426614174000

x-fimidara-multipart-partnumberNo

Part number of the multipart upload. -1 can be used to signify the end of a multipart upload.

Number subset: floating point or integer

Example: 1

Request Query
Request Body
UploadFileEndpointParams

File upload parameters including binary data

FieldTypeRequiredDescription
datastring |
Node.js Readable |
Browser ReadableStream 		Yes

File binary

Max bytes: 1.07 GB

200 — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

Example: 1024

200 — Response Body
UploadFileEndpointResult

Response containing the uploaded file information

{
file: File
}
File

File resource with metadata and location information

{
resourceId: string
createdBy: Agent
createdAt: number
lastUpdatedBy: Agent
lastUpdatedAt: number
isDeleted: boolean
deletedAt?: number
deletedBy?: Agent
workspaceId: string
size: number
ext?: string
parentId: string | null
idPath: Array<string>
namepath: Array<string>
mimetype?: string
encoding?: string
name: string
description?: string
version: number
}
Agent

Represents a user or system entity that performed an action (e.g., created or updated a resource)

{
agentId: string
agentType: string
}
4XX or 5XX — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

4XX or 5XX — Response Body
EndpointErrorResult

Endpoint error result

{
errors?: Array<ExternalError>
}
ExternalError

{
message: string
}