Skip to content
API Reference/Workspace API/
/
Create and execute batch...

Sync Workspace API (1.0.0)

Sync Workspace API

Workspace-specific services for content management, project organization, and file processing.

Workspace Services

The Workspace APIs allow access to the resources contained within Workspaces and Dataspaces. Although Workspaces and Dataspaces are distinct, Dataspaces have no compute of their own, so operations on Dataspace resources must always be performed through a chosen workspace. Workspaces are bundled, fully-managed computational services used to: - Upload, process, and manage content files - Search and retrieve content with advanced filtering - Query content using AI with library citations and web search integration - Run AI workflows on the content - Organize content into projects according to business workflows - Generate file derivatives (images, thumbnails) and extract metadata - Handle content indexing with automated categorization

Content Processing

When files are uploaded, they undergo asynchronous processing which may include: - Virus scanning and security validation - File format conversion and derivative generation (TIFF, JPEG thumbnails) - Automated metadata extraction using AI - Content categorization and indexing according to dataspace ontology Processing status can be tracked using the Workflow Execution API.

Projects vs Content Organization

  • Content: Individual files with metadata, organized by categories defined in the dataspace ontology - Projects: Business workflow containers that group disparate content items according to business rules (e.g., application packets, case files)

Authentication

All endpoints require authentication using a bearer token.

Download OpenAPI description
workspace-openapi.json
workspace-openapi.yaml
Overview
License
Commercial
Languages
Servers
Mock server
https://docs.syncdocs.ai/_mock/api/workspace-openapi/
Production - Workspace Services
https://{workspaceId}.syncdocs.ai/api/
Development server
https://docs.syncdocs.ai/api/

Content

Content management operations. Handle file uploads, processing, metadata extraction, and content retrieval with advanced filtering capabilities.

Operations

Projects

Project management operations. Projects group content items according to business workflows and processes.

Operations

Workflow Executions

Workflow execution monitoring operations. Track the status and progress of AI workflow executions on content.

Operations

Batch Workflow Executions

Batch workflow execution operations. Execute workflows on multiple content items based on filters across multiple dataspaces.

Operations

Create and execute batch workflow

Request

Creates a batch workflow execution that discovers content across multiple dataspaces using the provided filters, then executes the specified workflow on each matching content item. The system automatically selects the first available agent for the user's account to execute the workflow tasks. The workflow execution reuses the existing single-content workflow logic. Returns immediately with a batch execution record while processing continues in the background. File Format Filters: The API supports both user-friendly file types and MIME types for filtering: - User-friendly: { "in": ["pdf", "docx", "xlsx"] } - MIME types: { "in": ["application/pdf", "application/vnd.openxmlformats-officedocument.wordprocessingml.document"] } Supported user-friendly file types: pdf, docx, xlsx, pptx, txt, doc, xls, ppt, json, xml, csv, html, css, js, jpg, jpeg, png, gif, bmp, svg, webp, tiff, mp4, avi, mov, wmv, flv, webm, mkv, mp3, wav, flac, aac, ogg, m4a, zip, rar, 7z, tar, gz, bz2.

Security
bearerAuth
Bodyapplication/json
queryobject

Content search filters to find matching content items

Example: {"categoryId":{"exists":false},"fileFormat":{"in":["pdf","docx"]},"metadata":{"author":{"exists":true},"status":{"in":["pending","draft"]}}}
workflowIdstring(uuid)required

UUID of the workflow to execute on matching content

Example: "987fcdeb-51a2-43d1-9c4e-5f6e7d8c9a0b"
workspaceIdstring^sws-[a-z0-9]{8}$required

Workspace ID where the batch execution should run

Example: "sws-abc12345"
scheduledAtstring(date-time)

Optional scheduled execution time (ISO datetime string) - not implemented yet

Example: "2025-01-20T15:30:00Z"
dataspaceIdsArray of stringsnon-emptyrequired

Array of dataspace IDs where the workflow should run

Example: ["sds-abc12345","sds-def67890"]
curl -i -X POST \
  https://docs.syncdocs.ai/_mock/api/workspace-openapi/batch-workflow-executions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": {
      "fileFormat": {
        "in": [
          "pdf",
          "docx"
        ]
      },
      "metadata": {
        "author": {
          "exists": true
        },
        "status": {
          "in": [
            "pending",
            "draft"
          ]
        }
      },
      "categoryId": {
        "exists": false
      }
    },
    "workflowId": "987fcdeb-51a2-43d1-9c4e-5f6e7d8c9a0b",
    "workspaceId": "sws-abc12345",
    "dataspaceIds": [
      "sds-abc12345",
      "sds-def67890"
    ],
    "scheduledAt": "2025-01-20T15:30:00Z"
  }'

Responses

Batch workflow execution created and started successfully

Bodyapplication/json
idstring(uuid)required

UUID of the batch workflow execution

Example: "123e4567-e89b-12d3-a456-426614174000"
queryobject

Original query used to fetch the content

Example: {"categoryId":{"exists":false},"fileFormat":{"in":["application/pdf"]}}
workflowIdstring(uuid)required

UUID of the workflow used

Example: "987fcdeb-51a2-43d1-9c4e-5f6e7d8c9a0b"
workspaceIdstring^sws-[a-z0-9]{8}$required

Workspace ID where the batch execution ran

Example: "sws-abc12345"
dataspaceIdsArray of stringsrequired

Array of dataspace IDs where the workflow ran

Example: ["sds-abc12345","sds-def67890"]
workflowExecutionIdsArray of strings(uuid)required

Array of individual workflow execution IDs (one for each content based on the filters)

Example: ["789e0123-e89b-12d3-a456-426614174002","abc1234d-e89b-12d3-a456-426614174003","def5678e-e89b-12d3-a456-426614174004"]
statusstringrequired

Status of the batch execution

Enum"started""completed""failed"
Example: "completed"
errorMessagestring or nullrequired

Error message if the batch execution failed

Example: "Workflow validation failed: Invalid agent ID"
createdAtstring(date-time)required

When the batch execution was created

Example: "2025-01-15T10:30:00Z"
completedAtstring or null(date-time)

When the batch execution completed

Example: "2025-01-15T10:45:00Z"
Response
application/json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "query": {
    "fileFormat": { … },
    "metadata": { … }
  },
  "workflowId": "987fcdeb-51a2-43d1-9c4e-5f6e7d8c9a0b",
  "workspaceId": "sws-abc12345",
  "dataspaceIds": [
    "sds-abc12345",
    "sds-def67890"
  ],
  "workflowExecutionIds": [
    "789e0123-e89b-12d3-a456-426614174002",
    "abc1234d-e89b-12d3-a456-426614174003",
    "def5678e-e89b-12d3-a456-426614174004"
  ],
  "status": "completed",
  "errorMessage": null,
  "createdAt": "2025-01-15T10:30:00Z",
  "completedAt": "2025-01-15T10:45:00Z"
}

Get batch workflow execution status

Request

Returns real-time status information about a batch workflow execution, including progress tracking of individual workflow executions. This provides a summary of how many executions are completed, failed, or still in progress, along with the overall batch status.

Security
bearerAuth
Path
batchExecutionIdstring(uuid)required

UUID of the batch workflow execution

Example: 123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  https://docs.syncdocs.ai/_mock/api/workspace-openapi/batch-workflow-executions/123e4567-e89b-12d3-a456-426614174000/status \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Batch workflow execution status retrieved successfully

Bodyapplication/json
totalnumberrequired

Total number of individual workflow executions in this batch

Example: 15
completednumberrequired

Number of workflow executions that have completed successfully

Example: 12
failednumberrequired

Number of workflow executions that have failed

Example: 1
inProgressnumberrequired

Number of workflow executions currently in progress

Example: 2
statusstringrequired

Overall status of the batch execution

Enum"completed""processing""failed"
Example: "processing"
Response
application/json
{
  "total": 15,
  "completed": 12,
  "failed": 1,
  "inProgress": 2,
  "status": "processing"
}

Task Executions

Task execution monitoring operations. Track individual task executions within workflows and retrieve their outputs.

Operations

Task Execution Outputs

Task execution output retrieval operations. Access the results and outputs generated by completed task executions.

Operations

Registered Workflows

Registered workflow operations. Access workflows cached from sync-apis for fast lookup during workflow execution.

Operations

Query Logs

Query logging and retrieval operations. Track and analyze API operations performed on resources with detailed audit trails.

Operations

Content Upload Sessions

Content upload session management operations. Handle reliable file uploads through chunked upload sessions with progress tracking.

Operations