accepts-api-key

Analysis Preflight

Changed on

Report what analysing this asset would do, without dispatching anything.

The dry run for the two routes above, and it takes what they take: a file or a folder. description_asset_count and transcript_asset_count are how many assets each would dispatch — 0 or 1 for a file, the whole subtree for a folder — counted through the very same path, permission, type and upload-status filters the walk uses, so the number is what will actually run rather than an estimate.

config is the tellers-config the dispatched tasks will read, resolved at this asset's own path. It is a complete TellersConfigFile — the same object GET /asset/tellers-config/{asset_id} returns — with the merged analysis settings and entity ids in it rather than beside it, so reading config.analysis gives what will actually apply. config_assets lists the config files that contributed, nearest last.

For a folder the counts cover the whole subtree while config is what a file sitting directly in it resolves. overriding_config_assets lists the tellers-configs nested deeper that make those two disagree: assets under one of those resolve it instead, so while this is non-empty the reported config does not describe everything counted. It is capped, and overriding_config_assets_truncated says when there were more.

An optional body forces a configuration, and config then reports what that leaves in force — through apply_config_override, the same function the analysis itself applies it with, so what this shows is what would run. Since an override replaces the folder tree outright, this is also how to see what a given body drops: config_assets comes back empty, and any entity the tree contributed is gone unless the body names it again. Its entity ids are validated exactly as the run routes validate them, which makes this the way to find out whether an override will be accepted without spending anything on it.

It is a POST because of that body, not because it changes anything: it dispatches nothing and bills nothing.

Requires WRITE access, like the routes it previews: a folder's counts only include assets the caller can write, so the same call by two people can legitimately return different numbers.

post/video/analysis-preflight/{source_file_id}

Request

  • Base URL
    https://api.tellers.ai (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

source_file_idstring uuid required

Headers

x-api-keystring nullable
authorizationstring nullable

Request body

Response

Successful Response

asset_idstring required
in_app_pathstring required
is_folderboolean required
description_asset_countinteger required
transcript_asset_countinteger required
overriding_config_assets_truncatedboolean required

Changes

    • info

      added the new optional request property ////

    • info

      added the optional property /// to the response with the status