Skip to main content
GET
Get a debug file's download link
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/workflows/getDebugFileUrl Returns a download link for a file the attempt bound. You also need workflows:use at every company the file carries. The read is recorded (surface api, your credential) before the link exists; when it cannot be recorded, no link is made and the route answers 503. The link is a bearer link: anyone holding it can read the file. Do not log or share it.

Authentication

Personal key, External App credential or platform API key. Requires permission workflows:use, and the credential’s scopes must also reach workflows:read (a 403 naming it otherwise). Both are decided at the workflow’s home org unit. A debug attempt is personal, as in the Console: you debug drafts you created and read attempts you started. With a Personal key that is its owner; an External App or a platform key is its own creator (externalApp:<id>, apiKey:<id>). When draft debugging (workflow_debug_execution) is off for you (a Personal key’s owner) or for the deployment (an app or platform key), the route answers 409 conflict.

Query parameters

string
required
The debug attempt’s id.
string
required
The file’s id, from listDebugFiles.

Responses

200 with data.url, data.filename, data.mimeType and data.sizeBytes.

Errors

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

attemptId
string
required

The debug attempt's id. Give it exactly once.

Minimum string length: 1
fileId
string
required

The file's id, from listDebugFiles. Give it exactly once.

Minimum string length: 1

Response

The download link

data
object
required
meta
object
required