Skip to content
API Reference/
/Task Executions

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

Task Executions

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

Operations

Get a paginated list of task executions

Request

List task executions with optional filtering

Security
bearerAuth
Query
primaryScopeDataspaceIdstring^sds-[a-z0-9]{8}$

Optional filter by dataspace ID

Example: primaryScopeDataspaceId=sds-abc12345
statusstring

Filter by execution status

Enum"started""completed""failed"
Example: status=completed
workflowExecutionIdstring(uuid)

Filter by workflow execution ID

Example: workflowExecutionId=123e4567-e89b-12d3-a456-426614174000
taskDefinitionIdstring(uuid)

Filter by task definition ID

Example: taskDefinitionId=abc1234d-e89b-12d3-a456-426614174003
primaryScopeObjectIdstring(uuid)

Filter by primary scope object ID

Example: primaryScopeObjectId=456e7890-e89b-12d3-a456-426614174001
limitinteger[ 1 .. 100 ]

Number of items to return

Default 20
Example: limit=20
offsetinteger or null>= 0

Number of items to skip

Default 0
Example: offset=0
curl -i -X GET \
  'https://docs.syncdocs.ai/_mock/api/workspace-openapi/task-executions?primaryScopeDataspaceId=sds-abc12345&status=completed&workflowExecutionId=123e4567-e89b-12d3-a456-426614174000&taskDefinitionId=abc1234d-e89b-12d3-a456-426614174003&primaryScopeObjectId=456e7890-e89b-12d3-a456-426614174001&limit=20&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Task executions retrieved successfully

Bodyapplication/json
dataArray of objectsrequired

Array of task execution objects

data[].​idstring(uuid)required
Example: "789e0123-e89b-12d3-a456-426614174002"
data[].​workflowExecutionIdstring(uuid)required
Example: "123e4567-e89b-12d3-a456-426614174000"
data[].​taskDefinitionIdstring(uuid)required
Example: "abc1234d-e89b-12d3-a456-426614174003"
data[].​taskNamestringrequired
Example: "Categorize Document"
data[].​primaryScopeObjectIdstring(uuid)required
Example: "456e7890-e89b-12d3-a456-426614174001"
data[].​primaryScopeDataspaceIdstring^sds-[a-z0-9]{8}$required

Short dataspace ID with sds- prefix

Example: "sds-abc12345"
data[].​statusstringrequired
Enum"started""completed""failed"
Example: "completed"
data[].​startedAtstring(date-time)required
Example: "2025-01-15T10:30:30Z"
data[].​completedAtstring or null(date-time)required
Example: "2025-01-15T10:32:00Z"
data[].​errorMessagestring or nullrequired
Example: "Task failed due to invalid input format"
totalCountintegerrequired

Total number of task executions matching the query

Example: 42
limitintegerrequired

Number of items requested

Example: 20
offsetintegerrequired

Number of items skipped

Example: 0
Response
application/json
{
  "data": [
    { … }
  ],
  "totalCount": 42,
  "limit": 20,
  "offset": 0
}

Retrieve a single task execution by its ID

Request

Get task execution by ID

Security
bearerAuth
Path
taskExecutionIdstring(uuid)required

UUID of the task execution

Example: 789e0123-e89b-12d3-a456-426614174002
curl -i -X GET \
  https://docs.syncdocs.ai/_mock/api/workspace-openapi/task-executions/789e0123-e89b-12d3-a456-426614174002 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Task execution retrieved successfully

Bodyapplication/json
idstring(uuid)required
Example: "789e0123-e89b-12d3-a456-426614174002"
workflowExecutionIdstring(uuid)required
Example: "123e4567-e89b-12d3-a456-426614174000"
taskDefinitionIdstring(uuid)required
Example: "abc1234d-e89b-12d3-a456-426614174003"
taskNamestringrequired
Example: "Categorize Document"
primaryScopeObjectIdstring(uuid)required
Example: "456e7890-e89b-12d3-a456-426614174001"
primaryScopeDataspaceIdstring^sds-[a-z0-9]{8}$required

Short dataspace ID with sds- prefix

Example: "sds-abc12345"
statusstringrequired
Enum"started""completed""failed"
Example: "completed"
startedAtstring(date-time)required
Example: "2025-01-15T10:30:30Z"
completedAtstring or null(date-time)required
Example: "2025-01-15T10:32:00Z"
errorMessagestring or nullrequired
Example: "Task failed due to invalid input format"
Response
application/json
{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "workflowExecutionId": "123e4567-e89b-12d3-a456-426614174000",
  "taskDefinitionId": "abc1234d-e89b-12d3-a456-426614174003",
  "taskName": "Categorize Document",
  "primaryScopeObjectId": "456e7890-e89b-12d3-a456-426614174001",
  "primaryScopeDataspaceId": "sds-abc12345",
  "status": "completed",
  "startedAt": "2025-01-15T10:30:30Z",
  "completedAt": "2025-01-15T10:32:00Z",
  "errorMessage": "Task failed due to invalid input format"
}

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