Attachments

Upload an attachment

Uploads a file as a task-level attachment.

Requires workflowRunId and taskId to identify the target task. Accepts multipart form data (fields workflowRunId + taskId + file) or JSON with base64-encoded content (fields workflowRunId + taskId + fileBase64). Maximum file size: 20 MB for multipart, 10 MB for base64. You can also send workflowRunId + taskId + fileUploadId to attach a file you uploaded with createFileUpload; the fileUploadId is single-use.

post/attachments

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/attachments
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

workflowRunIdstring required

The ID of the Workflow Run.

taskIdstring required

The ID of the Task.

filestring binary

Uploaded file reference. Use the upload endpoint to attach content.

fileUploadIdstring

Response

Example response

{
  "data": {
    "createdBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "taskId": "u5O-CcFjjqwBoZxtdS98fA",
    "workflowRunId": "u5O-CcFjjqwBoZxtdS98fA",
    "workflowId": "u5O-CcFjjqwBoZxtdS98fA",
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes

No recorded changes to this operation across all 16 revisions of this API.