Get Upload URL

curl --request POST \
  --url https://operator.opus.com/api/v1/file/upload/presigned \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: {YOUR_SERVICE_KEY}' \
  --data '{
    "fileExtension": ".pdf",
    "originalName": "Q4-Report.pdf",
    "workflowId": "{YOUR_WORKFLOW_ID}"
  }'

import requests

url = "https://operator.opus.com/api/v1/file/upload/presigned"
headers = {
    "Content-Type": "application/json",
    "x-service-key": "{YOUR_SERVICE_KEY}"
}
payload = {
    "fileExtension": ".pdf",
    "originalName": "Q4-Report.pdf",
    "workflowId": "{YOUR_WORKFLOW_ID}"
    # Or target a workspace directly instead:
    # "workspaceId": "{YOUR_WORKSPACE_ID}"
}

response = requests.post(url, json=payload, headers=headers)
data = response.json()
print(data)

const response = await fetch(
  "https://operator.opus.com/api/v1/file/upload/presigned",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-service-key": "{YOUR_SERVICE_KEY}",
    },
    body: JSON.stringify({
      fileExtension: ".pdf",
      originalName: "Q4-Report.pdf",
      workflowId: "{YOUR_WORKFLOW_ID}",
      // Or target a workspace directly instead:
      // workspaceId: "{YOUR_WORKSPACE_ID}",
    }),
  }
);

const data = await response.json();
console.log(data);

{
  "presignedUrl": "{PRESIGNED_URL}",
  "fileUrl": "{FILE_URL}"
}

POST

api

file

upload

presigned

curl --request POST \
  --url https://operator.opus.com/api/v1/file/upload/presigned \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: {YOUR_SERVICE_KEY}' \
  --data '{
    "fileExtension": ".pdf",
    "originalName": "Q4-Report.pdf",
    "workflowId": "{YOUR_WORKFLOW_ID}"
  }'

import requests

url = "https://operator.opus.com/api/v1/file/upload/presigned"
headers = {
    "Content-Type": "application/json",
    "x-service-key": "{YOUR_SERVICE_KEY}"
}
payload = {
    "fileExtension": ".pdf",
    "originalName": "Q4-Report.pdf",
    "workflowId": "{YOUR_WORKFLOW_ID}"
    # Or target a workspace directly instead:
    # "workspaceId": "{YOUR_WORKSPACE_ID}"
}

response = requests.post(url, json=payload, headers=headers)
data = response.json()
print(data)

const response = await fetch(
  "https://operator.opus.com/api/v1/file/upload/presigned",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-service-key": "{YOUR_SERVICE_KEY}",
    },
    body: JSON.stringify({
      fileExtension: ".pdf",
      originalName: "Q4-Report.pdf",
      workflowId: "{YOUR_WORKFLOW_ID}",
      // Or target a workspace directly instead:
      // workspaceId: "{YOUR_WORKSPACE_ID}",
    }),
  }
);

const data = await response.json();
console.log(data);

{
  "presignedUrl": "{PRESIGNED_URL}",
  "fileUrl": "{FILE_URL}"
}

If your workflow contains file inputs (type: file or array_files), you must upload files before executing the case. This endpoint generates a presigned URL for uploading.

Call this endpoint once for each file you need to upload. After receiving the presigned URL, proceed to Upload File to complete the upload.

Headers

string

required

Your API authentication key

Body Parameters

string

required

The file extension including the dot (e.g., .pdf, .docx)

string

Access scope for the file. Options: workspace, unlisted. If omitted, the file is uploaded as unlisted — tracked by the platform but not shown in the file library.

string

The original filename of the file being uploaded (e.g., Q4-Report.pdf). Surfaced in the Opus file library to make the file easier to identify later.

string

Target workspace ID (UUID) for the file — the workspace the upload is checked against. Required unless workflowId is provided.

string

Target workflow ID (UUID) for the file. The workspace that owns this workflow becomes the owner of the file. Required unless workspaceId is provided.

Every upload is checked against a workspace — you must provide either workspaceId or workflowId, regardless of accessScope.

Supported File Types

Extension	Description
`.pdf`	PDF documents
`.docx`	Word documents
`.csv`	CSV spreadsheets
`.xls`, `.xlsx`	Excel spreadsheets
`.txt`	Plain text files
`.json`	JSON files
`.html`	HTML files
`.xml`	XML files
`.jpeg`, `.jpg`, `.png`	Image files

The maximum file size for uploads is 10 MB. Files exceeding this limit will be rejected.

Response

string

required

Temporary URL for uploading your file. Use this in the Upload File step.

string

required

Permanent URL to reference this file in your Execute Case request.

Errors

Unauthorized

Missing, invalid, or expired API key.

Not Found

The workspace or workflow does not exist.

curl --request POST \
  --url https://operator.opus.com/api/v1/file/upload/presigned \
  --header 'Content-Type: application/json' \
  --header 'x-service-key: {YOUR_SERVICE_KEY}' \
  --data '{
    "fileExtension": ".pdf",
    "originalName": "Q4-Report.pdf",
    "workflowId": "{YOUR_WORKFLOW_ID}"
  }'

import requests

url = "https://operator.opus.com/api/v1/file/upload/presigned"
headers = {
    "Content-Type": "application/json",
    "x-service-key": "{YOUR_SERVICE_KEY}"
}
payload = {
    "fileExtension": ".pdf",
    "originalName": "Q4-Report.pdf",
    "workflowId": "{YOUR_WORKFLOW_ID}"
    # Or target a workspace directly instead:
    # "workspaceId": "{YOUR_WORKSPACE_ID}"
}

response = requests.post(url, json=payload, headers=headers)
data = response.json()
print(data)

const response = await fetch(
  "https://operator.opus.com/api/v1/file/upload/presigned",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-service-key": "{YOUR_SERVICE_KEY}",
    },
    body: JSON.stringify({
      fileExtension: ".pdf",
      originalName: "Q4-Report.pdf",
      workflowId: "{YOUR_WORKFLOW_ID}",
      // Or target a workspace directly instead:
      // workspaceId: "{YOUR_WORKSPACE_ID}",
    }),
  }
);

const data = await response.json();
console.log(data);

{
  "presignedUrl": "{PRESIGNED_URL}",
  "fileUrl": "{FILE_URL}"
}

⌘I

Get Started

Workflows

Cases

Files

Deprecated

Headers

Body Parameters

Supported File Types

Response

Errors

​Headers

​Body Parameters

​Supported File Types

​Response

​Errors

Headers

Body Parameters

Supported File Types

Response

Errors