Add a file

Uploads a new file to the Library in the specified teamsite using a multipart/form-data POST containing the file metadata and binary content.

The metadata part is a JSON string with required properties name, format, and parentFolderId. Additional optional properties documented in the PATCH operation (Seismic.LibraryContentManagement.ChangeFileInformationproperties) such as ownerId, experts, description, expiresAt, properties, and externalId may also be included.

Use the special keyword root as parentFolderId to add files to the root folder of a teamsite.

The content part contains the binary file bytes to upload.

Example metadata JSON:

{
    "name": "file name here",
    "parentFolderId": "root",
    "format": "pptx"
}

You can also optionally include an externalId as a well-known and non-editable way of tracking the content ID from an external system.

Use the optional query parameter resolveNameCollision=true to automatically append an index such as (1), (2), (3), etc. until a name is found that does not conflict with an existing document in the folder.

📘

Upload Limits

Max file size is limited to 2 GB.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the teamsite context for the request. Depending on API behavior, it may be a GUID-formatted value or a documented special value such as 1.

Query Params
boolean
Defaults to true

When true, automatically appends an incremented index such as (1), (2), (3) to the file name until no naming conflict exists in the target folder. When false, an upload that conflicts with an existing filename in the target folder is rejected with a 400 response. Defaults to true.

boolean
Defaults to false

When true, the service automatically deletes any partially-created Library file record if the binary content upload fails after the metadata record was created, preventing orphaned draft entries in the target folder. When false or omitted, a failed upload may leave an empty metadata record behind that must be cleaned up manually. Agents performing unattended ingestion should set this to true for transactional safety.

Body Params

Multipart form data containing a JSON metadata part and a binary content part for the file to upload.

string
required

JSON string containing required file properties (name, parentFolderId, format) and optional properties such as ownerId, description, expiresAt, and externalId. See the discoverable Seismic.LibraryContentManagement.AddAFile.MetadataPart schema for the full structure including field types, constraints, and validation rules.

file
required

Binary payload of the file to upload. Streamed as the second multipart part with content type application/octet-stream and stored as the file's initial version content.

Headers
string
enum
Defaults to application/json; charset=utf-8

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; charset=utf-8
application/json