Notion: File uploads schemas
1 Notion schema with complete fields and constraints.
← File uploads operations · All schemas
Upload a file — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
complete_url | string | Optional | |
content_length | JSON | Required within parent | |
content_length (anyOf 1) | JSON | Alternative | |
content_length (anyOf 1) (anyOf 1) | integer | Alternative | Minimum: 0 |
content_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
content_length (anyOf 2) | null | Alternative | |
content_type | JSON | Required within parent | |
content_type (anyOf 1) | string | Alternative | |
content_type (anyOf 2) | null | Alternative | |
created_by | object | Required within parent | Additional keys: allowed |
created_by.id | string | Required within parent | Format: uuid |
created_by.type | string | Required within parent | One of: `person`, `bot`, `agent` Known values: person, bot, agent |
created_time | string | Required within parent | Format: date-time |
expiry_time | JSON | Required within parent | |
expiry_time (anyOf 1) | string | Alternative | Format: date-time |
expiry_time (anyOf 2) | null | Alternative | |
file_import_result | JSON | Optional | |
file_import_result (allOf 1) | object | All variants apply | Additional keys: allowed |
file_import_result (allOf 1).imported_time | string | Required within parent | The time the file was imported into Notion. ISO 8601 format. Format: date-time |
file_import_result (allOf 2) | JSON | All variants apply | |
file_import_result (allOf 2) (anyOf 1) | object | Alternative | |
file_import_result (allOf 2) (anyOf 1).success | Model | Required within parent | Expand List views — response body — view Empty object for success type. |
file_import_result (allOf 2) (anyOf 1).type | string | Required within parent | Indicates a successful import. Must equal: success |
file_import_result (allOf 2) (anyOf 2) | object | Alternative | |
file_import_result (allOf 2) (anyOf 2).error | object | Required within parent | Details about the error that occurred during file import. Additional keys: allowed |
file_import_result (allOf 2) (anyOf 2).error.code | string | Required within parent | A short string code representing the error. |
file_import_result (allOf 2) (anyOf 2).error.message | string | Required within parent | A human-readable message describing the error. |
file_import_result (allOf 2) (anyOf 2).error.parameter | JSON | Required within parent | The parameter related to the error, if applicable. Null if not applicable. |
file_import_result (allOf 2) (anyOf 2).error.parameter (anyOf 1) | string | Alternative | |
file_import_result (allOf 2) (anyOf 2).error.parameter (anyOf 2) | null | Alternative | |
file_import_result (allOf 2) (anyOf 2).error.status_code | JSON | Required within parent | The 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) | JSON | Alternative | |
file_import_result (allOf 2) (anyOf 2).error.status_code (anyOf 1) (anyOf 1) | integer | Alternative | |
file_import_result (allOf 2) (anyOf 2).error.status_code (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
file_import_result (allOf 2) (anyOf 2).error.status_code (anyOf 2) | null | Alternative | |
file_import_result (allOf 2) (anyOf 2).error.type | string | Required within parent | The 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).type | string | Required within parent | Indicates an error occurred during import. Must equal: error |
filename | JSON | Required within parent | |
filename (anyOf 1) | string | Alternative | |
filename (anyOf 2) | null | Alternative | |
id | string | Required within parent | Format: uuid |
in_trash | boolean | Required within parent | |
last_edited_time | string | Required within parent | Format: date-time |
number_of_parts | object | Optional | Additional keys: allowed |
number_of_parts.sent | JSON | Required within parent | |
number_of_parts.sent (anyOf 1) | integer | Alternative | Minimum: 0 |
number_of_parts.sent (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number_of_parts.total | JSON | Required within parent | |
number_of_parts.total (anyOf 1) | integer | Alternative | Minimum: 0 |
number_of_parts.total (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
object | string | Required within parent | Always `file_upload` Must equal: file_upload |
status | string | Required within parent | One of: `pending`, `uploaded`, `expired`, `failed` Known values: pending, uploaded, expired, failed |
upload_url | string | Optional |
Referenced models: List views — response body — view