Seismic

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'seismic'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Seismic:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'seismic_generative_search',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "seismic"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Seismic:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="seismic_generative_search",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• Version upload workspace file, upload library file — Upload new content for an existing workspace file, creating a new version while preserving version history
• Update workspace file, library folder, library file — Update a workspace file’s metadata: rename it and/or move it to a different folder by changing its parentFolderId
• Document unpublish, submit, recall — Unpublish a previously published library content item, reverting it to draft state so it is no longer visible to end-users on the published channel
• Search content, generative — Search Seismic content (library and workspace) that the authenticated user has access to, using a full-text search term, optional field-level search/return field selection, filter expressions (by repository, format, dates, custom properties, etc.), and sort order
• Documents publish teamsite — Immediately publish or schedule publication of up to 10 unpublished Library documents within a teamsite
• List users, user teamsites, user recents — Get a list of users in the Seismic tenant (legacy endpoint)

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

seismic_add_item_comment#Add a comment to a specific version of a workspace item, with an optional page annotation (annotations are only supported on items of type file). Supports @mentions by embedding an object like {id='<user-guid>',type='user'} in the text, escaping literal { or } with a backslash, and using \n for line breaks. Triggers notifications for any @mentioned users. Requires the seismic.workspace.manage scope.7 params▾

Add a comment to a specific version of a workspace item, with an optional page annotation (annotations are only supported on items of type file). Supports @mentions by embedding an object like {id='<user-guid>',type='user'} in the text, escaping literal { or } with a backslash, and using \n for line breaks. Triggers notifications for any @mentioned users. Requires the seismic.workspace.manage scope.

NameTypeRequiredDescription

spaceIdstringrequiredThe unique identifier (UUID) of the workspace space that contains the item.

textstringrequiredComment text (or annotation textbox text). Embed @mentions as {id='<user-guid>',type='user'}. Escape literal { or } with a backslash, and use \n for line breaks.

workspaceContentIdstringrequiredThe unique identifier (UUID) of the workspace item to add a comment to.

workspaceVersionIdstringrequiredThe unique identifier (UUID) of the workspace item version to associate the comment with.

annotationobjectoptionalOptional page annotation, only supported on items of type file. Shape: {"type":"rectangle|oval|line|arrow|text|pen|callout","page":1,"points":[{"x":10,"y":20}]}. Points are % offsets from the top-left corner of the page; for 2D shapes provide top-left and bottom-right corners, for text/callout provide the top-left corner, for pen provide each point along the line.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_approve_reject_workflow_step#Apply an approval decision (approve, reject, or revoke) to a specific step within an active approval workflow, identified by approvalWorkflowId and stepId. The caller must be the step's assigned approver. Returns the full updated workflow state, including status, step decisions, and assignees, so the effects of the decision can be verified. An optional comment records rationale, and nextApprover can be provided to assign the upcoming step's approver when the workflow configuration allows dynamic routing.7 params▾

Apply an approval decision (approve, reject, or revoke) to a specific step within an active approval workflow, identified by approvalWorkflowId and stepId. The caller must be the step's assigned approver. Returns the full updated workflow state, including status, step decisions, and assignees, so the effects of the decision can be verified. An optional comment records rationale, and nextApprover can be provided to assign the upcoming step's approver when the workflow configuration allows dynamic routing.

NameTypeRequiredDescription

actionstringrequiredDecision to apply to the step: 'approve', 'reject', or 'revoke'.

approvalWorkflowIdstringrequiredUnique UUID identifier of the approval workflow instance that contains the target step.

stepIdstringrequiredUnique UUID identifier of the workflow step to approve, reject, or revoke.

commentstringoptionalOptional comment recording the rationale for the decision.

nextApproverobjectoptionalOptional principal to assign as the upcoming step's approver, when workflow configuration allows dynamic routing. Shape: {"id": "<guid>", "type": "User|Group", "isDefault": true}.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_copy_library_item#Create a copy of an existing Library item (file, folder, URL, or other supported content type) inside a destination folder. Use parent_folder_id 'root' to place the copy at the teamsite root, or a destination folder GUID to copy into a specific folder branch. The source item is unchanged; the copy receives new identifiers and fresh audit timestamps.5 params▾

Create a copy of an existing Library item (file, folder, URL, or other supported content type) inside a destination folder. Use parent_folder_id 'root' to place the copy at the teamsite root, or a destination folder GUID to copy into a specific folder branch. The source item is unchanged; the copy receives new identifiers and fresh audit timestamps.

NameTypeRequiredDescription

library_content_idstringrequiredIdentifier of the source library content item that will be copied into the destination folder.

parent_folder_idstringrequiredDestination folder identifier where the copied item should be created. Use 'root' to copy to the teamsite root folder.

teamsite_idstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_create_library_file#Upload a new file to the Library in a Seismic teamsite using a multipart request containing JSON metadata and the binary file content. Requires name, format, and parentFolderId (use 'root' for the teamsite root folder). Optionally include ownerId, description, expiresAt, externalId, externalConnectionId, experts, and custom properties. Use resolveNameCollision to auto-rename on filename conflicts, and rollbackOnError to automatically clean up a partially-created record if the content upload fails. Max file size is 2GB.16 params▾

Upload a new file to the Library in a Seismic teamsite using a multipart request containing JSON metadata and the binary file content. Requires name, format, and parentFolderId (use 'root' for the teamsite root folder). Optionally include ownerId, description, expiresAt, externalId, externalConnectionId, experts, and custom properties. Use resolveNameCollision to auto-rename on filename conflicts, and rollbackOnError to automatically clean up a partially-created record if the content upload fails. Max file size is 2GB.

NameTypeRequiredDescription

content_base64stringrequiredBase64-encoded binary contents of the file to upload as its initial version.

formatstringrequiredFile format identifier matching the binary content, as a short lowercase token corresponding to the file extension (e.g. pptx, pdf, docx, png).

namestringrequiredDisplay name for the new file as it will appear in the Library. Should include the file extension matching format.

parent_folder_idstringrequiredDestination folder identifier. Use 'root' to place the file at the top level of the teamsite, otherwise provide a folder UUID.

teamsite_idstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string.

descriptionstringoptionalOptional free-text description for the file, shown to Library consumers.

expertsstringoptionalOptional JSON-encoded array of subject-matter experts to associate with the new file. Each entry is {"id": "...", "type": "user"|"group"}.

expires_atstringoptionalOptional expiration date in YYYY-MM-DD format. Must be a future date when set.

external_connection_idstringoptionalOptional identifier of the external content connection that sourced this file, used when ingesting content from a connected third-party repository.

external_idstringoptionalOptional external identifier used to correlate this file with a record in an external system.

owner_idstringoptionalOptional override for the owning user. May be '1' or '2' for built-in accounts, or a UUID for a tenant user. Defaults to the caller when omitted.

propertiesstringoptionalOptional JSON-encoded array of custom property assignments to apply to the new file. Each entry is {"id": "...", "values": [...]}.

resolve_name_collisionbooleanoptionalWhen true, automatically appends an incremented index such as (1), (2), (3) to the file name until no naming conflict exists in the target folder. Defaults to true.

rollback_on_errorbooleanoptionalWhen true, the service automatically deletes any partially-created Library file record if the binary content upload fails. Defaults to false.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_create_library_folder#Add a new folder inside a target parent folder within the specified teamsite. Use the special keyword 'root' as parent_folder_id to create the new folder directly under the teamsite root. To create a nested path of multiple folders in one call, use Get Or Create Library Folder Path instead.7 params▾

Add a new folder inside a target parent folder within the specified teamsite. Use the special keyword 'root' as parent_folder_id to create the new folder directly under the teamsite root. To create a nested path of multiple folders in one call, use Get Or Create Library Folder Path instead.

NameTypeRequiredDescription

namestringrequiredName of the new folder.

parent_folder_idstringrequiredDestination parent folder identifier. Use 'root' to create the folder at the top level of the teamsite, otherwise provide a folder UUID.

teamsite_idstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string.

external_connection_idstringoptionalOptional identifier of the external content connection associated with this folder.

external_idstringoptionalOptional external identifier used to correlate this folder with a record in an external system.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_create_library_url#Add a new URL content item to a Library teamsite. Requires name, parent_folder_id, and url. Optionally include experts, properties, expiresAt, description, format, whether the link opens in a new window, and external system correlation identifiers. On success, returns the full metadata of the newly created URL content item.14 params▾

Add a new URL content item to a Library teamsite. Requires name, parent_folder_id, and url. Optionally include experts, properties, expiresAt, description, format, whether the link opens in a new window, and external system correlation identifiers. On success, returns the full metadata of the newly created URL content item.

NameTypeRequiredDescription

namestringrequiredDisplay name for the new URL content item.

parent_folder_idstringrequiredDestination folder identifier. Use 'root' to place the URL item at the top level of the teamsite, otherwise provide a folder UUID.

teamsite_idstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string.

urlstringrequiredThe target URL string this Library item points to.

descriptionstringoptionalOptional free-text description for the URL item.

expertsstringoptionalOptional JSON-encoded array of subject-matter experts to associate with the new URL item. Each entry is {"id": "...", "type": "user"|"group"}.

expires_atstringoptionalOptional expiration date in YYYY-MM-DD format. Must be a future date when set.

external_connection_idstringoptionalOptional identifier of the external content connection or source integration for this URL item.

external_idstringoptionalOptional external identifier used to correlate this URL item with a record in an external system.

formatstringoptionalOptional format identifier for the URL item. Defaults to 'Url' when omitted.

open_in_new_windowbooleanoptionalWhether the link should open in a new browser window/tab when a consumer clicks it. Omit to use the Library default.

propertiesstringoptionalOptional JSON-encoded array of custom property assignments to apply to the new URL item. Each entry is {"id": "...", "values": [...]}.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_create_livesend_link#Generate a LiveSend shareable link for one or more Seismic contents, with optional recipients, CRM contexts, and delivery settings (expiration, password, download permission, notification type). Returns the new LiveSend's id, an internal detail-page URL for tracking and management, and an external URL for recipients to view the content. Requires at least one universal content ID in contents.7 params▾

Generate a LiveSend shareable link for one or more Seismic contents, with optional recipients, CRM contexts, and delivery settings (expiration, password, download permission, notification type). Returns the new LiveSend's id, an internal detail-page URL for tracking and management, and an external URL for recipients to view the content. Requires at least one universal content ID in contents.

NameTypeRequiredDescription

contentsarrayrequiredList of universal content IDs to include in the LiveSend. Must contain at least one item. Workspace content format: 'Workspace__{Type}__{ContentId}__{VersionId}'. DocCenter content format: 'ContentManager__{Type}__{ContentId}__{VersionId}__{TeamSiteId}'.

contextsarrayoptionalOptional list of CRM or interaction contexts that associate the LiveSend with relevant business records (contextId, contextName, contextType, source, sourceType, systemId, systemType).

delegatorIdstringoptionalOptional Seismic user ID of the user authorizing this request on behalf of the authenticated user.

recipientsarrayoptionalOptional list of recipients, each with an email, optional first/last name, and optional recipient-specific CRM contexts.

schema_versionstringoptionalSchema version

settingsobjectoptionalOptional LiveSend behavior settings. expiresAt is an RFC 3339 UTC date-time; password protects access; allowDownload controls whether viewers may download; notificationType is one of None, Summary, All. If omitted, tenant-level defaults are used.

tool_versionstringoptionalTool version

seismic_create_workspace_file#Upload a new file to the user's personal Seismic workspace, creating the initial version of the content. Sent as multipart/form-data with a JSON metadata part (name, format, parentFolderId) and a content part carrying the file bytes. Use "root" as parentFolderId to add the file to the user's root folder. Requires the seismic.workspace.manage scope.6 params▾

Upload a new file to the user's personal Seismic workspace, creating the initial version of the content. Sent as multipart/form-data with a JSON metadata part (name, format, parentFolderId) and a content part carrying the file bytes. Use "root" as parentFolderId to add the file to the user's root folder. Requires the seismic.workspace.manage scope.

NameTypeRequiredDescription

file_content_base64stringrequiredBase64-encoded contents of the file to upload.

formatstringrequiredFile format/extension of the content being uploaded, e.g. pptx, docx, xlsx, pdf.

namestringrequiredDisplay name for the new file, including its file name (extension is typically implied by the format field).

parentFolderIdstringrequiredUUID of the destination workspace folder. Use "root" to add the file to the user's root workspace folder.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_create_workspace_folder#Add a new folder inside a given folder in the user's Seismic workspace, for organizing content hierarchically. Use the special value "root" as parentFolderId to create the new folder at the user's root level. Folder names must be unique within their parent folder. Requires the seismic.workspace.manage scope.4 params▾

Add a new folder inside a given folder in the user's Seismic workspace, for organizing content hierarchically. Use the special value "root" as parentFolderId to create the new folder at the user's root level. Folder names must be unique within their parent folder. Requires the seismic.workspace.manage scope.

NameTypeRequiredDescription

namestringrequiredDisplay name for the new folder. Must be unique within the parent folder.

parentFolderIdstringrequiredUUID of the parent folder where the new folder will be created. Use "root" to create the folder at the user's root level.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_download_library_file#Download the latest binary content of a Seismic Library file in the specified teamsite. Returns raw file bytes (application/octet-stream), not JSON. Set redirect=true to have the API respond with a 302 redirect containing the temporary download link in the Location header (for clients that can follow redirects and stream directly); set redirect=false (default) to instead get a 200 response whose body contains a temporary download URL, for custom transfer or deferred-download handling. Do not use this to download a specific historical version — use the version-pinned download endpoint instead.5 params▾

Download the latest binary content of a Seismic Library file in the specified teamsite. Returns raw file bytes (application/octet-stream), not JSON. Set redirect=true to have the API respond with a 302 redirect containing the temporary download link in the Location header (for clients that can follow redirects and stream directly); set redirect=false (default) to instead get a 200 response whose body contains a temporary download URL, for custom transfer or deferred-download handling. Do not use this to download a specific historical version — use the version-pinned download endpoint instead.

NameTypeRequiredDescription

libraryContentIdstringrequiredIdentifier of the Library file whose binary content you want to download. Must identify file content (not folder/URL); must be a UUID.

teamsiteIdstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string, depending on the tenant's Library configuration.

redirectbooleanoptionalControls response mode. When true, the API responds with 302 and returns the temporary download link in the Location header. When false (default), the API responds with 200 and returns a temporary download URL in the response body.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_download_livedoc_output#Download a particular generated Document Generator (LiveDoc) output file, such as .pptx, .docx, .pdf, or .xlsx. Returns raw file bytes (application/octet-stream), not JSON. Supports the special outputId alias keywords 'pptx', 'docx', 'pdf', 'gslides', and 'gdoc' so callers can download without first looking up the generated outputId. Set redirect=true (default) to have the API respond with a 302 redirect to the download URL; set redirect=false to instead get a 200 response with a JSON body containing the download URL. Confirm the LiveDoc generation is complete before calling this; do not use it to start generation or check status.5 params▾

Download a particular generated Document Generator (LiveDoc) output file, such as .pptx, .docx, .pdf, or .xlsx. Returns raw file bytes (application/octet-stream), not JSON. Supports the special outputId alias keywords 'pptx', 'docx', 'pdf', 'gslides', and 'gdoc' so callers can download without first looking up the generated outputId. Set redirect=true (default) to have the API respond with a 302 redirect to the download URL; set redirect=false to instead get a 200 response with a JSON body containing the download URL. Confirm the LiveDoc generation is complete before calling this; do not use it to start generation or check status.

NameTypeRequiredDescription

generatedLivedocIdstringrequiredIdentifier of the generated LiveDoc job that contains the output to download.

outputIdstringrequiredOutput identifier for the specific generated file, or an alias keyword: pptx, docx, pdf, gslides, or gdoc.

redirectbooleanoptionalControls response mode. When true (default), the API responds with 302 and redirects to the output's temporary download URL. When false, the API responds with 200 and returns the temporary download URL in the response body.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_download_workspace_file#Download the binary content of a file from the authenticated user's personal Seismic workspace. Returns raw file bytes (application/octet-stream), not JSON. Set redirect=true (default) to have the API respond with a 302 redirect to the file's download URL, for clients that can follow redirects; set redirect=false to instead get a 200 response with a JSON body containing the download URL. This is a read-only operation and does not modify server state. Do not use this to fetch file metadata or Library content.4 params▾

Download the binary content of a file from the authenticated user's personal Seismic workspace. Returns raw file bytes (application/octet-stream), not JSON. Set redirect=true (default) to have the API respond with a 302 redirect to the file's download URL, for clients that can follow redirects; set redirect=false to instead get a 200 response with a JSON body containing the download URL. This is a read-only operation and does not modify server state. Do not use this to fetch file metadata or Library content.

NameTypeRequiredDescription

workspaceContentIdstringrequiredThe unique identifier of the workspace file whose binary content to download.

redirectbooleanoptionalControls response mode. When true (default), the API responds with 302 and redirects to the file's temporary download URL. When false, the API responds with 200 and returns the temporary download URL in the response body.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_generate_livedoc#Start a LiveDoc generation job for the specified teamsite and library content version, producing one or more document outputs (PPTX, DOCX, PDF, XLSX, GSLIDES, or GDOC). Provide adHocInputs matching the schema discovered via the list-generator-inputs endpoint, and at least one entry in outputs — the call fails with a 4xx error if outputs is empty. Generated outputs are only available for download for 24 hours from generation time. Returns a generatedLivedocId used to poll generation status. This endpoint is rate-limited; avoid rapid repeated calls.8 params▾

Start a LiveDoc generation job for the specified teamsite and library content version, producing one or more document outputs (PPTX, DOCX, PDF, XLSX, GSLIDES, or GDOC). Provide adHocInputs matching the schema discovered via the list-generator-inputs endpoint, and at least one entry in outputs — the call fails with a 4xx error if outputs is empty. Generated outputs are only available for download for 24 hours from generation time. Returns a generatedLivedocId used to poll generation status. This endpoint is rate-limited; avoid rapid repeated calls.

NameTypeRequiredDescription

libraryContentVersionIdstringrequiredIdentifier of the LiveDoc library content version to generate from.

outputsarrayrequiredArray of desired output definitions; at least one is required. Each entry needs a format (e.g. PPTX, DOCX, PDF, XLSX, GSLIDES, GDOC), a display name, and a filename, plus optional format-specific option objects (pptxOptions, docxOptions, pdfOptions). Example: [{"format": "PPTX", "name": "STS for Callahan Autoparts", "filename": "STS for Callahan Autoparts.pptx", "pptxOptions": {"imageDpi": 200, "clearNotes": false}}]

teamsiteIdstringrequiredIdentifier of the teamsite that owns the LiveDoc version.

adHocInputsarrayoptionalOptional array of adHoc input values matching the input schema discovered via the list-generator-inputs endpoint. Single variables: {"name": "adhoc_1", "value": 100}. Table variables: {"name": "adhoc_4", "value": {"columns": ["StrCol", "IntCol"], "rows": [["hello", 1], ["goodbye", 2]]}}.

regionalFormatstringoptionalRegional number and date format standard to apply. Defaults to en-US.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

useMinorVersionForTestbooleanoptionalIf true, the Document Generator pulls in the latest minor version of each component; otherwise it uses the latest major version. Defaults to false.

seismic_generative_search#Run a generative (AI) content search against Seismic using a natural-language prompt or keywords. Returns synthesized answers and/or matching source content, optionally scoped by a filter expression and restricted to externally shareable content only.5 params▾

Run a generative (AI) content search against Seismic using a natural-language prompt or keywords. Returns synthesized answers and/or matching source content, optionally scoped by a filter expression and restricted to externally shareable content only.

NameTypeRequiredDescription

filterobjectoptionalOptional filter expression to narrow which content is considered, e.g. by repository. Shape: {"operator":"and|or","conditions":[{"attribute":"repository","operator":"in","value":["DocCenter"]}],"filters":[]}. Filters can be nested.

isShareablebooleanoptionalOptional shareability filter. When true, only externally shareable content is returned. When false, only non-shareable content is returned. If omitted, all content is returned regardless of shareable status and the response documents will not include an isShareable field.

schema_versionstringoptionalSchema version

termstringoptionalNatural-language prompt or keyword query, e.g. "What is our enterprise pricing model?". Omit to search without a specific prompt (not typical for generative search).

tool_versionstringoptionalTool version

seismic_get_generated_livedoc_status#Retrieve the current status of a LiveDoc generation job, including the overall status and a per-output breakdown of readiness (for example, a PPTX output may be ready for download while a PDF output is still generating). Poll this after calling generate-livedoc and before attempting to download outputs.3 params▾

Retrieve the current status of a LiveDoc generation job, including the overall status and a per-output breakdown of readiness (for example, a PPTX output may be ready for download while a PDF output is still generating). Poll this after calling generate-livedoc and before attempting to download outputs.

NameTypeRequiredDescription

generatedLivedocIdstringrequiredIdentifier of the generated LiveDoc job to check, returned by the generate-livedoc call.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_get_library_url#Retrieve the current metadata and properties for a URL content item stored in the Seismic Library, identified by libraryContentId within the specified teamsite. The response includes ownership, versioning, profile assignments, custom properties, expert associations, and the target URL details. Only call when libraryContentId is known to resolve to a URL item; use the generic item-info endpoint if the content type is uncertain.4 params▾

Retrieve the current metadata and properties for a URL content item stored in the Seismic Library, identified by libraryContentId within the specified teamsite. The response includes ownership, versioning, profile assignments, custom properties, expert associations, and the target URL details. Only call when libraryContentId is known to resolve to a URL item; use the generic item-info endpoint if the content type is uncertain.

NameTypeRequiredDescription

libraryContentIdstringrequiredIdentifier of the Library URL content item to retrieve metadata for. Must be a UUID.

teamsiteIdstringrequiredTeamsite identifier that scopes the request to one teamsite context. May be the literal value '1' or a GUID-formatted string.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_get_livesend_link_version#Retrieve the complete, read-only details of a specific version of a LiveSend, identified by livesendId and livesendVersionId — including metadata, settings, contents, recipients, and contextual information. Useful for UI rendering, auditing, or automated analysis. Set includeDownloadUrls to true only when download links are required and permitted for the caller context.5 params▾

Retrieve the complete, read-only details of a specific version of a LiveSend, identified by livesendId and livesendVersionId — including metadata, settings, contents, recipients, and contextual information. Useful for UI rendering, auditing, or automated analysis. Set includeDownloadUrls to true only when download links are required and permitted for the caller context.

NameTypeRequiredDescription

livesendIdstringrequiredUnique identifier (UUID) for the LiveSend used to retrieve and authorize access to the resource.

livesendVersionIdstringrequiredVersion identifier (UUID) for the LiveSend resource, identifying the specific snapshot to fetch.

includeDownloadUrlsbooleanoptionalOptional flag to include per-content download URLs when available. Defaults to false; set to true only when download URLs are explicitly needed and authorized for the caller context.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_get_or_create_library_folder_path#Creates a folder hierarchy or retrieves the existing folder identifier for a folder path that already exists, based on the forward-slash-delimited path given in folderpath (e.g. /Marketing/Q4 Campaign/Assets). Any missing segment of the path is created automatically; if the full path already exists, the existing leaf folder is returned without modification. The response includes the id of the deepest (leaf) folder and a path array describing each segment from root to leaf. Use the returned leaf id as the parentFolderId for subsequent upload or move operations.4 params▾

Creates a folder hierarchy or retrieves the existing folder identifier for a folder path that already exists, based on the forward-slash-delimited path given in folderpath (e.g. /Marketing/Q4 Campaign/Assets). Any missing segment of the path is created automatically; if the full path already exists, the existing leaf folder is returned without modification. The response includes the id of the deepest (leaf) folder and a path array describing each segment from root to leaf. Use the returned leaf id as the parentFolderId for subsequent upload or move operations.

NameTypeRequiredDescription

folderpathstringrequiredForward-slash-delimited folder path to create or resolve. Each segment between slashes becomes a folder name. A leading slash is required. Missing intermediate folders are created on the fly.

teamsite_idstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_get_teamsite#Returns metadata for a single Seismic teamsite identified by teamsiteId, including its display name and whether it is the tenant default teamsite. Use `1` for the tenant default teamsite or a UUID for a custom teamsite.3 params▾

Returns metadata for a single Seismic teamsite identified by teamsiteId, including its display name and whether it is the tenant default teamsite. Use `1` for the tenant default teamsite or a UUID for a custom teamsite.

NameTypeRequiredDescription

teamsiteIdstringrequiredTeamsite identifier to retrieve. Use `1` for the tenant default teamsite or a UUID for a custom teamsite.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_get_teamsite_folder#Retrieve metadata for a single Seismic Library folder in a teamsite by libraryContentId, including naming, parent placement, external mapping identifiers, and audit timestamps. Only call this when libraryContentId is known to resolve to folder content; use the generic item-info endpoint if the content type is uncertain.4 params▾

Retrieve metadata for a single Seismic Library folder in a teamsite by libraryContentId, including naming, parent placement, external mapping identifiers, and audit timestamps. Only call this when libraryContentId is known to resolve to folder content; use the generic item-info endpoint if the content type is uncertain.

NameTypeRequiredDescription

libraryContentIdstringrequiredIdentifier of the Library folder to retrieve metadata for. Must identify folder content; must be a UUID.

teamsiteIdstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string, depending on the tenant's Library configuration.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_get_teamsite_item#Retrieve canonical metadata for a single Seismic Library item by libraryContentId, including built-in fields and custom property values. Use this for generic item-level lookups when the content type (file, folder, URL, or other) is not known in advance; use the returned 'type' field to route to a type-specific info call if richer fields are needed.4 params▾

Retrieve canonical metadata for a single Seismic Library item by libraryContentId, including built-in fields and custom property values. Use this for generic item-level lookups when the content type (file, folder, URL, or other) is not known in advance; use the returned 'type' field to route to a type-specific info call if richer fields are needed.

NameTypeRequiredDescription

libraryContentIdstringrequiredIdentifier of the Library content item to retrieve metadata for. Must be a UUID.

teamsiteIdstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string, depending on the tenant's Library configuration.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_get_user#Get the user details for the specified user id (legacy endpoint). New integrations should prefer the SCIM API to retrieve a user by GUID.3 params▾

Get the user details for the specified user id (legacy endpoint). New integrations should prefer the SCIM API to retrieve a user by GUID.

NameTypeRequiredDescription

userIdstringrequiredThe unique identifier of the Seismic user to retrieve.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_get_workspace_file#Get the basic information for a specific file in the user's Seismic workspace, including creation/modification details, current version, delivery options, application URLs, and resource URL. Read-only; does not download file content (use the download content endpoint for that). Requires seismic.workspace.view or seismic.workspace.manage scope.3 params▾

Get the basic information for a specific file in the user's Seismic workspace, including creation/modification details, current version, delivery options, application URLs, and resource URL. Read-only; does not download file content (use the download content endpoint for that). Requires seismic.workspace.view or seismic.workspace.manage scope.

NameTypeRequiredDescription

workspaceContentIdstringrequiredThe unique identifier (UUID) of the workspace file to retrieve information for.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_list_approval_workflows#Return a paginated list of all approval workflows across the tenant, including their current status, steps, assigned approvers, and submitted library content. Supports offset-based pagination via limit/offset and cursor-based pagination via continuationToken (which takes precedence over offset when provided). Poll with a status filter in mind to discover pending approvals, or iterate with continuationToken to audit all historical workflows.5 params▾

Return a paginated list of all approval workflows across the tenant, including their current status, steps, assigned approvers, and submitted library content. Supports offset-based pagination via limit/offset and cursor-based pagination via continuationToken (which takes precedence over offset when provided). Poll with a status filter in mind to discover pending approvals, or iterate with continuationToken to audit all historical workflows.

NameTypeRequiredDescription

continuationTokenstringoptionalOpaque cursor token returned by a previous response for cursor-based pagination. When provided, takes precedence over limit/offset.

limitintegeroptionalMaximum number of entries to return per page. Must be a positive integer between 1 and 1000. Defaults to 100.

offsetintegeroptionalZero-based index of the first entry to return. Use with limit for offset-based pagination. Defaults to 0.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_list_item_comments#Get the comments on a workspace item (a space's item, typically a file), including replies and page annotations. Optionally filter to a specific version and paginate with offset/limit. Read-only. Requires seismic.workspace.view or seismic.workspace.manage scope.7 params▾

Get the comments on a workspace item (a space's item, typically a file), including replies and page annotations. Optionally filter to a specific version and paginate with offset/limit. Read-only. Requires seismic.workspace.view or seismic.workspace.manage scope.

NameTypeRequiredDescription

spaceIdstringrequiredThe unique identifier (UUID) of the workspace space that contains the item.

workspaceContentIdstringrequiredThe unique identifier (UUID) of the workspace item whose comments to retrieve.

limitstringoptionalMaximum number of comment records to return per page (1-100). API default is 40.

offsetstringoptionalNumber of comment records to skip for pagination. API default is 0.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

versionIdstringoptionalWorkspace content version identifier; filters comments to the specified version only. Omit to return comments across all versions.

seismic_list_item_versions#Retrieve the version history for a specific Seismic Library item within a teamsite, returned newest to oldest. Use this to enumerate version identifiers before performing version-pinned downloads, restores, or audits. Each returned versionId is a stable key for version-scoped follow-up operations.4 params▾

Retrieve the version history for a specific Seismic Library item within a teamsite, returned newest to oldest. Use this to enumerate version identifiers before performing version-pinned downloads, restores, or audits. Each returned versionId is a stable key for version-scoped follow-up operations.

NameTypeRequiredDescription

libraryContentIdstringrequiredIdentifier of the Library content item whose version history you want to retrieve. Must be a UUID.

teamsiteIdstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string, depending on the tenant's Library configuration.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_list_livedoc_generator_inputs#Retrieve the adHoc input definitions required to generate a LiveDoc for the specified teamsite and library content version. Call this before generation to discover expected input names, value types (string, integer, date, table), and table column structure, then use the result to construct a valid request body for the generate operation.4 params▾

Retrieve the adHoc input definitions required to generate a LiveDoc for the specified teamsite and library content version. Call this before generation to discover expected input names, value types (string, integer, date, table), and table column structure, then use the result to construct a valid request body for the generate operation.

NameTypeRequiredDescription

libraryContentVersionIdstringrequiredIdentifier of the LiveDoc library content version to inspect.

teamsiteIdstringrequiredIdentifier of the teamsite that owns the LiveDoc version.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_list_teamsite_folder_items#Retrieve a paginated list of items contained in a specific Seismic Library folder in the requested teamsite. Use limit/offset to page through results. Only lists the immediate children of the folder — call once per folder rather than recursively traversing descendants. Only call when libraryContentId is known to resolve to folder content.8 params▾

Retrieve a paginated list of items contained in a specific Seismic Library folder in the requested teamsite. Use limit/offset to page through results. Only lists the immediate children of the folder — call once per folder rather than recursively traversing descendants. Only call when libraryContentId is known to resolve to folder content.

NameTypeRequiredDescription

libraryContentIdstringrequiredIdentifier of the Library folder whose immediate child items you want to list. Must identify folder content; must be a UUID.

teamsiteIdstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string, depending on the tenant's Library configuration.

includeExpirationbooleanoptionalIf true, each returned item's ExpiresAt field is populated when the item has an expiration date. Defaults to true.

includePropertiesbooleanoptionalIf true, each returned item's Properties field is populated when the item has custom properties. Defaults to true.

limitintegeroptionalMaximum number of items to return in one page. Cannot exceed 1000. Defaults to 1000 if not specified.

offsetintegeroptionalZero-based number of items to skip before returning results, for pagination. Defaults to 0.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_list_teamsite_items#Get the list of Library items in a Seismic teamsite that match the supplied external-system filters, returning up to 50 items per request. Items may be files, folders, URLs, or other Library content types. At least one of externalId or externalConnectionId must be provided or the API returns 400 Bad Request. Use this to look up Library items that originate from an integrated external system rather than to browse a folder's children.5 params▾

Get the list of Library items in a Seismic teamsite that match the supplied external-system filters, returning up to 50 items per request. Items may be files, folders, URLs, or other Library content types. At least one of externalId or externalConnectionId must be provided or the API returns 400 Bad Request. Use this to look up Library items that originate from an integrated external system rather than to browse a folder's children.

NameTypeRequiredDescription

teamsiteIdstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string, depending on the tenant's Library configuration.

externalConnectionIdstringoptionalExternal connection identifier used to filter items linked to a specific external integration. Used together with externalId to disambiguate when the same external identifier appears across multiple integrations. At least one of externalId or externalConnectionId must be supplied, or the API responds with 400 Bad Request.

externalIdstringoptionalExternal identifier used to filter items linked to an external system. Only items whose externalId matches this value are returned. At least one of externalId or externalConnectionId must be supplied, or the API responds with 400 Bad Request.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_list_teamsites#Returns all teamsites defined in the Seismic tenant, including teamsites the current user may not have direct content access to. Use this endpoint to discover valid teamsite identifiers before calling teamsite-scoped APIs such as Library Content Management endpoints.2 params▾

Returns all teamsites defined in the Seismic tenant, including teamsites the current user may not have direct content access to. Use this endpoint to discover valid teamsite identifiers before calling teamsite-scoped APIs such as Library Content Management endpoints.

NameTypeRequiredDescription

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_list_user_favorites#Get the current authenticated user's favorite contents in Seismic, including library content, workspace content, and metadata such as thumbnails and download links.2 params▾

Get the current authenticated user's favorite contents in Seismic, including library content, workspace content, and metadata such as thumbnails and download links.

NameTypeRequiredDescription

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_list_user_profiles#Get the list of content profiles that the current authenticated user has access to in Seismic. Optionally filter by application or restrict to predictive-only profiles.4 params▾

Get the list of content profiles that the current authenticated user has access to in Seismic. Optionally filter by application or restrict to predictive-only profiles.

NameTypeRequiredDescription

applicationstringoptionalRestrict results to content profiles associated with the given application.

isPredictiveOnlystringoptionalRestrict results to profiles that are predictive-only.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_list_user_recents#Get the current authenticated user's recently accessed contents in Seismic, including library content, workspace content, and metadata such as thumbnails and download links.2 params▾

Get the current authenticated user's recently accessed contents in Seismic, including library content, workspace content, and metadata such as thumbnails and download links.

NameTypeRequiredDescription

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_list_user_teamsites#Get the current authenticated user's assigned teamsites in Seismic, including each teamsite's id, name, and whether it is the default teamsite.2 params▾

Get the current authenticated user's assigned teamsites in Seismic, including each teamsite's id, name, and whether it is the default teamsite.

NameTypeRequiredDescription

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_list_users#Get a list of users in the Seismic tenant (legacy endpoint). Supports pagination via limit/offset and a starts-with text filter matched against email, username, first name, or last name. New integrations should prefer the SCIM API to manage users.5 params▾

Get a list of users in the Seismic tenant (legacy endpoint). Supports pagination via limit/offset and a starts-with text filter matched against email, username, first name, or last name. New integrations should prefer the SCIM API to manage users.

NameTypeRequiredDescription

filterstringoptionalFree text filter. Performs a starts-with match against email, username, first name, or last name.

limitstringoptionalMaximum number of users to return. Default 1000 per the API, though the endpoint's own schema default is 10.

offsetstringoptionalNumber of users to skip before returning results. Default 0.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_publish_teamsite_documents#Immediately publish or schedule publication of up to 10 unpublished Library documents within a teamsite. Each document is identified by its library content id in the content array; the endpoint always publishes the latest version of each document, transitioning it from Draft to Published. Provide publishAt in 'YYYY-MM-DD HH:MM AM|PM' or 'YYYY-MM-DD' format (processed in UTC) to schedule a future publish, or omit it to publish immediately. Set IsSendNotification to true to notify subscribers. Returns counts of total, succeeded, error, and warning items along with detail arrays.7 params▾

Immediately publish or schedule publication of up to 10 unpublished Library documents within a teamsite. Each document is identified by its library content id in the content array; the endpoint always publishes the latest version of each document, transitioning it from Draft to Published. Provide publishAt in 'YYYY-MM-DD HH:MM AM|PM' or 'YYYY-MM-DD' format (processed in UTC) to schedule a future publish, or omit it to publish immediately. Set IsSendNotification to true to notify subscribers. Returns counts of total, succeeded, error, and warning items along with detail arrays.

NameTypeRequiredDescription

contentarrayrequiredArray of up to 10 objects, each with an 'id' field naming a library content item to publish. Example: [{"id": "28608761-7a2e-4789-beef-8cab4081a8ae"}]

teamsiteIdstringrequiredIdentifier of the teamsite context for the request. May be a GUID-formatted value or the special value '1'.

commentstringoptionalOptional comment describing this publish action.

IsSendNotificationbooleanoptionalWhether to send a notification to subscribers when the content is published. Defaults to false.

publishAtstringoptionalOptional scheduled publish date/time in 'YYYY-MM-DD HH:MM AM|PM' or 'YYYY-MM-DD' format, processed in UTC. If omitted, documents publish immediately.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_recall_document#Recall a library content item from an active approval workflow, withdrawing it from the review process and returning it to its previous state. Use this when a content owner needs to pull back a document that was submitted for approval prematurely. Supply an optional comment explaining the reason for the recall.5 params▾

Recall a library content item from an active approval workflow, withdrawing it from the review process and returning it to its previous state. Use this when a content owner needs to pull back a document that was submitted for approval prematurely. Supply an optional comment explaining the reason for the recall.

NameTypeRequiredDescription

libraryContentIdstringrequiredIdentifier (GUID) of the library content item currently in an approval workflow.

teamsiteIdstringrequiredIdentifier of the teamsite that contains the content. Accepts either the special value '1' (the default teamsite) or a GUID-formatted teamsite identifier.

commentsstringoptionalOptional comment explaining why the document is being recalled from the workflow.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_search_content#Search Seismic content (library and workspace) that the authenticated user has access to, using a full-text search term, optional field-level search/return field selection, filter expressions (by repository, format, dates, custom properties, etc.), and sort order. Omit the term or send an empty query to match all accessible content. Supports pagination via a continuation token returned in a previous response.10 params▾

Search Seismic content (library and workspace) that the authenticated user has access to, using a full-text search term, optional field-level search/return field selection, filter expressions (by repository, format, dates, custom properties, etc.), and sort order. Omit the term or send an empty query to match all accessible content. Supports pagination via a continuation token returned in a previous response.

NameTypeRequiredDescription

continuationTokenstringoptionalOpaque pagination token returned in a previous response's results. Pass this value to retrieve the next page. Omit on the first request.

enableSuggestedQueryResultsbooleanoptionalWhen true, if the initial search returns no results, the service attempts to retrieve results based on related suggested terms. Defaults to false.

filterobjectoptionalOptional filter expression to narrow results by repository, format, date range, custom properties, and more. Shape: {"operator":"and|or","conditions":[{"attribute":"repository","operator":"in","value":["library","workspace"]}],"filters":[]}. Filters can be nested up to 2 levels deep.

pageSizeintegeroptionalMaximum number of results per page, between 0 and 100. Defaults to 40 when omitted.

returnFieldsarrayoptionalSubset of content property fields to return for each matching result, e.g. repository, name, teamsiteId, id, versionId, type, applicationUrls, format, description, properties, thumbnailUrl, downloadUrl, createdDate, publishDate, modifiedDate, majorVersion, minorVersion. When omitted, returns the default field set (repository, name, teamsiteId, id, versionId, type, applicationUrls, format).

schema_versionstringoptionalSchema version

searchFieldsarrayoptionalSubset of fields to search within. Supported values: "name", "description", "body", "properties". Defaults to all fields when omitted.

sortarrayoptionalList of sort criteria, each an object with "field" (name, createdDate, publishDate, modifiedDate, majorVersion, minorVersion) and "order" (asc or desc). Results are sorted by relevance when omitted.

termstringoptionalFull-text search term matched against content. Omit or leave empty to return all accessible content instead of matching a specific term.

tool_versionstringoptionalTool version

seismic_submit_document#Submit a library content item into an approval workflow within a specific teamsite, initiating the review process before publication. Routes the document identified by libraryContentId through the configured workflow steps so designated approvers can review, approve, or reject it. Returns an array of approval workflow instance identifiers created by the submission. Use an optional comment to give reviewers context, and set attestationsConfirmed to true to auto-confirm required workflow acknowledgments on the submitter's behalf.6 params▾

Submit a library content item into an approval workflow within a specific teamsite, initiating the review process before publication. Routes the document identified by libraryContentId through the configured workflow steps so designated approvers can review, approve, or reject it. Returns an array of approval workflow instance identifiers created by the submission. Use an optional comment to give reviewers context, and set attestationsConfirmed to true to auto-confirm required workflow acknowledgments on the submitter's behalf.

NameTypeRequiredDescription

libraryContentIdstringrequiredIdentifier (GUID) of the library content item to submit into the approval workflow.

teamsiteIdstringrequiredIdentifier of the teamsite context for the request. Accepts either the special value '1' (the default teamsite) or a GUID-formatted teamsite identifier.

attestationsConfirmedbooleanoptionalIf true, required workflow attestation acknowledgments are automatically confirmed by the submitter when the file is submitted. If false or omitted, acknowledgments are left unconfirmed.

commentsstringoptionalOptional comment providing context to reviewers about this submission.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_unpublish_document#Unpublish a previously published library content item, reverting it to draft state so it is no longer visible to end-users on the published channel. This operation is idempotent — calling it on an item that is already unpublished still returns a successful response. Requires the seismic.library.manage scope.4 params▾

Unpublish a previously published library content item, reverting it to draft state so it is no longer visible to end-users on the published channel. This operation is idempotent — calling it on an item that is already unpublished still returns a successful response. Requires the seismic.library.manage scope.

NameTypeRequiredDescription

libraryContentIdstringrequiredIdentifier (GUID) of the library content item to unpublish. Must reference an existing published item.

teamsiteIdstringrequiredIdentifier of the teamsite context for the request. May be a GUID-formatted value or the special value '1'.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_update_library_file#Update metadata for an existing Library file in a teamsite: move it to another folder, change ownership, update custom properties, set an expiration date, or modify expert assignments. Include only the fields you want to change; omitted fields remain unchanged. Set includeResponse to false to receive an empty 200 response instead of the full updated metadata, useful for bulk patch workflows.14 params▾

Update metadata for an existing Library file in a teamsite: move it to another folder, change ownership, update custom properties, set an expiration date, or modify expert assignments. Include only the fields you want to change; omitted fields remain unchanged. Set includeResponse to false to receive an empty 200 response instead of the full updated metadata, useful for bulk patch workflows.

NameTypeRequiredDescription

library_content_idstringrequiredIdentifier of the library content item to update. Must identify file content, not other content types.

teamsite_idstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string.

descriptionstringoptionalNew description for the file. Omit to leave unchanged.

expertsstringoptionalJSON-encoded array of experts to set for this file, replacing the current list. Each entry is {"id": "...", "type": "user"|"group"}. Omit to leave unchanged.

expires_atstringoptionalNew expiration date, which can only be set to the future. Specify as UTC YYYY-MM-DD without a time component. Omit to leave unchanged.

external_connection_idstringoptionalNew identifier of the external content connection that sourced this file. Omit to leave unchanged.

external_idstringoptionalNew external identifier used to correlate this file with a record in an external system. Omit to leave unchanged.

include_responsebooleanoptionalWhen true, the response body contains the full updated file metadata. When false, returns an empty 200 response. Defaults to true.

namestringoptionalNew name for the file. Omit to leave unchanged.

owner_idstringoptionalNew userId of the owner of the file. Omit to leave unchanged.

parent_folder_idstringoptionalGUID of the file's new parent folder. Changing this value moves the file. Use 'root' to place it at the teamsite root. Omit to leave unchanged.

propertiesstringoptionalJSON-encoded array of custom property assignments to set, replacing the current list. Each entry is {"id": "...", "values": [...]}. Omit to leave unchanged.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_update_library_folder#Update metadata for an existing Library folder in a teamsite: rename it, move it to a different parent folder, or update external system mapping identifiers used by integrations. Include only the fields you want to change; omitted fields remain unchanged.8 params▾

Update metadata for an existing Library folder in a teamsite: rename it, move it to a different parent folder, or update external system mapping identifiers used by integrations. Include only the fields you want to change; omitted fields remain unchanged.

NameTypeRequiredDescription

library_content_idstringrequiredIdentifier of the library content item to update. Must identify folder content.

teamsite_idstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string.

external_connection_idstringoptionalNew identifier of the external content connection associated with this folder. Omit to leave unchanged.

external_idstringoptionalNew external identifier used to correlate this folder with a record in an external system. Omit to leave unchanged.

namestringoptionalNew name for the folder. Omit to leave unchanged.

parent_folder_idstringoptionalGUID of the folder's new parent folder. Changing this value moves the folder. Use 'root' to place it at the teamsite root. Omit to leave unchanged.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_update_workspace_file#Update a workspace file's metadata: rename it and/or move it to a different folder by changing its parentFolderId. The PATCH structure mirrors the Get Workspace File response, so a common flow is to get the file, modify the relevant fields, and PATCH the result. Provide at least one of name or parentFolderId. Use "root" to move a file to the user's root folder. File names must be unique within the target folder. Requires the seismic.workspace.manage scope.5 params▾

Update a workspace file's metadata: rename it and/or move it to a different folder by changing its parentFolderId. The PATCH structure mirrors the Get Workspace File response, so a common flow is to get the file, modify the relevant fields, and PATCH the result. Provide at least one of name or parentFolderId. Use "root" to move a file to the user's root folder. File names must be unique within the target folder. Requires the seismic.workspace.manage scope.

NameTypeRequiredDescription

workspaceContentIdstringrequiredThe unique identifier (UUID) of the workspace file to update.

namestringoptionalNew display name for the file. Must be unique within the parent folder. Required if you are not moving the file (i.e. omitting parentFolderId).

parentFolderIdstringoptionalUUID of the destination folder to move the file to. Use "root" for the user's root folder. Required if you are not renaming the file (i.e. omitting name).

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_upload_library_file_version#Upload a new binary version for an existing Library file, identified by libraryContentId, in the specified teamsite. The file's identity (id) stays the same while version metadata such as version and versionId are updated in the response. Use this for version replacement on a file that already exists; to create a brand-new file record use Create Library File instead. Max file size is 2GB.5 params▾

Upload a new binary version for an existing Library file, identified by libraryContentId, in the specified teamsite. The file's identity (id) stays the same while version metadata such as version and versionId are updated in the response. Use this for version replacement on a file that already exists; to create a brand-new file record use Create Library File instead. Max file size is 2GB.

NameTypeRequiredDescription

content_base64stringrequiredBase64-encoded binary bytes of the new file version to upload. This carries the replacement file content sent as the multipart 'content' part; the file's id, ownership, and other metadata are preserved while a new version record is created.

library_content_idstringrequiredIdentifier of the library content item to add a new version to. Must identify file content, not other content types.

teamsite_idstringrequiredIdentifier of the teamsite context for the request. May be the literal value '1' or a GUID-formatted string.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

seismic_upload_workspace_file_version#Upload new content for an existing workspace file, creating a new version while preserving version history. The file's versionId changes while its id remains constant; previous versions remain accessible. Sent as multipart/form-data with a single content part carrying the new file bytes; the file format should typically match the original. Requires the seismic.workspace.manage scope.4 params▾

Upload new content for an existing workspace file, creating a new version while preserving version history. The file's versionId changes while its id remains constant; previous versions remain accessible. Sent as multipart/form-data with a single content part carrying the new file bytes; the file format should typically match the original. Requires the seismic.workspace.manage scope.

NameTypeRequiredDescription

content_base64stringrequiredBase64-encoded contents of the new file version. The format should typically match the original file's format.

workspaceContentIdstringrequiredThe unique identifier (UUID) of the workspace file to upload a new version for.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version