Skip to content

Notion: File uploads schemas

1 Notion schema with complete fields and constraints.

← File uploads operations · All schemas

Upload a file — response body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
complete_urlstringOptional
content_lengthJSONRequired within parent
content_length (anyOf 1)JSONAlternative
content_length (anyOf 1) (anyOf 1)integerAlternativeMinimum: 0
content_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
content_length (anyOf 2)nullAlternative
content_typeJSONRequired within parent
content_type (anyOf 1)stringAlternative
content_type (anyOf 2)nullAlternative
created_byobjectRequired within parentAdditional keys: allowed
created_by.idstringRequired within parentFormat: uuid
created_by.typestringRequired within parentOne of: `person`, `bot`, `agent`
Known values: person, bot, agent
created_timestringRequired within parentFormat: date-time
expiry_timeJSONRequired within parent
expiry_time (anyOf 1)stringAlternativeFormat: date-time
expiry_time (anyOf 2)nullAlternative
file_import_resultJSONOptional
file_import_result (allOf 1)objectAll variants applyAdditional keys: allowed
file_import_result (allOf 1).imported_timestringRequired within parentThe time the file was imported into Notion. ISO 8601 format.
Format: date-time
file_import_result (allOf 2)JSONAll variants apply
file_import_result (allOf 2) (anyOf 1)objectAlternative
file_import_result (allOf 2) (anyOf 1).successModelRequired within parentExpand List views — response body — view
Empty object for success type.
file_import_result (allOf 2) (anyOf 1).typestringRequired within parentIndicates a successful import.
Must equal: success
file_import_result (allOf 2) (anyOf 2)objectAlternative
file_import_result (allOf 2) (anyOf 2).errorobjectRequired within parentDetails about the error that occurred during file import.
Additional keys: allowed
file_import_result (allOf 2) (anyOf 2).error.codestringRequired within parentA short string code representing the error.
file_import_result (allOf 2) (anyOf 2).error.messagestringRequired within parentA human-readable message describing the error.
file_import_result (allOf 2) (anyOf 2).error.parameterJSONRequired within parentThe parameter related to the error, if applicable. Null if not applicable.
file_import_result (allOf 2) (anyOf 2).error.parameter (anyOf 1)stringAlternative
file_import_result (allOf 2) (anyOf 2).error.parameter (anyOf 2)nullAlternative
file_import_result (allOf 2) (anyOf 2).error.status_codeJSONRequired within parentThe HTTP status code associated with the error, if available. Null if not applicable.
file_import_result (allOf 2) (anyOf 2).error.status_code (anyOf 1)JSONAlternative
file_import_result (allOf 2) (anyOf 2).error.status_code (anyOf 1) (anyOf 1)integerAlternative
file_import_result (allOf 2) (anyOf 2).error.status_code (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
file_import_result (allOf 2) (anyOf 2).error.status_code (anyOf 2)nullAlternative
file_import_result (allOf 2) (anyOf 2).error.typestringRequired within parentThe type of error that occurred during file import.
Known values: validation_error, internal_system_error, download_error, upload_error
file_import_result (allOf 2) (anyOf 2).typestringRequired within parentIndicates an error occurred during import.
Must equal: error
filenameJSONRequired within parent
filename (anyOf 1)stringAlternative
filename (anyOf 2)nullAlternative
idstringRequired within parentFormat: uuid
in_trashbooleanRequired within parent
last_edited_timestringRequired within parentFormat: date-time
number_of_partsobjectOptionalAdditional keys: allowed
number_of_parts.sentJSONRequired within parent
number_of_parts.sent (anyOf 1)integerAlternativeMinimum: 0
number_of_parts.sent (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_of_parts.totalJSONRequired within parent
number_of_parts.total (anyOf 1)integerAlternativeMinimum: 0
number_of_parts.total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
objectstringRequired within parentAlways `file_upload`
Must equal: file_upload
statusstringRequired within parentOne of: `pending`, `uploaded`, `expired`, `failed`
Known values: pending, uploaded, expired, failed
upload_urlstringOptional

Referenced models: List views — response body — view

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.