Skip to content
API Reference/Account Admin API/
/
Update a dataspace

SyncDocs Admin API (1.0.0)

SyncDocs Admin API

Complete enterprise content management system (ECM) core APIs for accessing ECM functionality programmatically.

Architecture Overview

When you start with Sync, you are assigned an Account with a unique ID. Each account can have:

  • Dataspaces: Fully isolated data segments within an account, similar to separate databases. Each dataspace is used to isolate different business use cases within a single enterprise. - Workspaces: Virtual computing resources for storing, retrieving and manipulating content (managed separately via Workspace APIs) - Libraries: External content sources that can be scraped and indexed for use as citation sources in AI queries - Users and Agents: Can interact with Dataspaces/Workspaces with assigned roles - Ontologies: Define how content is organized within dataspaces

Dataspace Resources

Each Dataspace contains: - A unique Ontology that defines the business-purpose categorization and metadata structure - Categories: Represent the grouping or classification of content (taxonomy) - Metadata Queries: Specific metadata fields that can be associated with content and bound to categories - A collection of Content and Projects (managed via Workspace APIs)

Metadata Query Binding

Metadata Queries can be bound to Categories to indicate required attributes for content in that category. When binding, you can specify: - Whether the attribute is required/mandatory for every Content item in that category - Whether the attribute should be part of the Unique Index (content with same unique index values are considered versions of the same content)

Authentication

All endpoints require authentication using a bearer token and a valid account ID.

Download OpenAPI description
sync-cloud-openapi.json
sync-cloud-openapi.yaml
Overview
License
Proprietary
Languages
Servers
Mock server
https://docs.syncdocs.ai/_mock/api/sync-cloud-openapi/
Production - Sync Cloud Admin Services
https://cloud.syncdocs.ai/api/
Development server
https://docs.syncdocs.ai/api/

Accounts

Account management operations. Each account represents a unique enterprise customer with isolated resources.

Operations

Dataspaces

Dataspace management operations. Dataspaces are fully isolated data segments within an account, similar to separate databases for different business use cases.

Operations

Create a new dataspace

Request

Create a new dataspace in an account. Requires authentication.

Security
bearerAuth
Path
accountIdstring^scd-[a-z0-9]{8}$required

Short account ID with scd- prefix

Example: scd-k2j8n4m1
Bodyapplication/json
namestringnon-emptyrequired

Name of the dataspace

Example: "Research Project Dataspace"
descriptionstringnon-emptyrequired

Description of the dataspace

Example: "A dataspace for organizing research documents"
ontologyIdstring(uuid)required

UUID of the ontology

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
curl -i -X POST \
  https://docs.syncdocs.ai/_mock/api/sync-cloud-openapi/accounts/scd-k2j8n4m1/dataspaces \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Research Project Dataspace",
    "description": "A dataspace for organizing research documents",
    "ontologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }'

Responses

Dataspace created successfully

Bodyapplication/json
idstring^sds-[a-z0-9]{8}$required

Short dataspace ID with sds- prefix

Example: "sds-a1b2c3d4"
namestringrequired
Example: "Research Project Dataspace"
descriptionstringrequired
Example: "A dataspace for organizing research documents"
accountIdstring^scd-[a-z0-9]{8}$required

Short account ID with scd- prefix

Example: "scd-k2j8n4m1"
ontologyIdstring(uuid)required
Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
createdAtstring(date-time)required
Example: "2024-01-15T10:30:00Z"
Response
application/json
{
  "id": "sds-a1b2c3d4",
  "name": "Research Project Dataspace",
  "description": "A dataspace for organizing research documents",
  "accountId": "scd-k2j8n4m1",
  "ontologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2024-01-15T10:30:00Z"
}

List all dataspaces for an account

Request

List all dataspaces in an account. Requires authentication.

Security
bearerAuth
Path
accountIdstring^scd-[a-z0-9]{8}$required

Short account ID with scd- prefix

Example: scd-k2j8n4m1
curl -i -X GET \
  https://docs.syncdocs.ai/_mock/api/sync-cloud-openapi/accounts/scd-k2j8n4m1/dataspaces \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of dataspaces

Bodyapplication/jsonArray [
idstring^sds-[a-z0-9]{8}$required

Short dataspace ID with sds- prefix

Example: "sds-a1b2c3d4"
namestringrequired
Example: "Research Project Dataspace"
descriptionstringrequired
Example: "A dataspace for organizing research documents"
ontologyIdstring(uuid)required
Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
createdAtstring(date-time)required
Example: "2024-01-15T10:30:00Z"
]
Response
application/json
[
  {
    "id": "sds-a1b2c3d4",
    "name": "Research Project Dataspace",
    "description": "A dataspace for organizing research documents",
    "ontologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdAt": "2024-01-15T10:30:00Z"
  }
]

Get a dataspace by ID

Request

Get details of a specific dataspace. Requires authentication.

Security
bearerAuth
Path
accountIdstring^scd-[a-z0-9]{8}$required

Short account ID with scd- prefix

Example: scd-k2j8n4m1
dataspaceIdstring^sds-[a-z0-9]{8}$required

Short dataspace ID with sds- prefix

Example: sds-a1b2c3d4
curl -i -X GET \
  https://docs.syncdocs.ai/_mock/api/sync-cloud-openapi/accounts/scd-k2j8n4m1/dataspaces/sds-a1b2c3d4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Dataspace details

Bodyapplication/json
idstring^sds-[a-z0-9]{8}$required

Short dataspace ID with sds- prefix

Example: "sds-a1b2c3d4"
namestringrequired
Example: "Research Project Dataspace"
descriptionstringrequired
Example: "A dataspace for organizing research documents"
ontologyIdstring(uuid)required
Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
createdAtstring(date-time)required
Example: "2024-01-15T10:30:00Z"
Response
application/json
{
  "id": "sds-a1b2c3d4",
  "name": "Research Project Dataspace",
  "description": "A dataspace for organizing research documents",
  "ontologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2024-01-15T10:30:00Z"
}

Update a dataspace

Request

Update details of a specific dataspace. Requires authentication.

Security
bearerAuth
Path
accountIdstring^scd-[a-z0-9]{8}$required

Short account ID with scd- prefix

Example: scd-k2j8n4m1
dataspaceIdstring^sds-[a-z0-9]{8}$required

Short dataspace ID with sds- prefix

Example: sds-a1b2c3d4
Bodyapplication/json
namestringnon-empty

Name of the dataspace

Example: "Updated Research Project Dataspace"
descriptionstringnon-empty

Description of the dataspace

Example: "Updated description for research documents dataspace"
curl -i -X PUT \
  https://docs.syncdocs.ai/_mock/api/sync-cloud-openapi/accounts/scd-k2j8n4m1/dataspaces/sds-a1b2c3d4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated Research Project Dataspace",
    "description": "Updated description for research documents dataspace"
  }'

Responses

Dataspace updated successfully

Bodyapplication/json
idstring^sds-[a-z0-9]{8}$required

Short dataspace ID with sds- prefix

Example: "sds-a1b2c3d4"
namestringrequired
Example: "Research Project Dataspace"
descriptionstringrequired
Example: "A dataspace for organizing research documents"
ontologyIdstring(uuid)required
Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
createdAtstring(date-time)required
Example: "2024-01-15T10:30:00Z"
Response
application/json
{
  "id": "sds-a1b2c3d4",
  "name": "Research Project Dataspace",
  "description": "A dataspace for organizing research documents",
  "ontologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2024-01-15T10:30:00Z"
}

Delete a dataspace

Request

Delete a specific dataspace. Requires authentication.

Security
bearerAuth
Path
accountIdstring^scd-[a-z0-9]{8}$required

Short account ID with scd- prefix

Example: scd-k2j8n4m1
dataspaceIdstring^sds-[a-z0-9]{8}$required

Short dataspace ID with sds- prefix

Example: sds-a1b2c3d4
curl -i -X DELETE \
  https://docs.syncdocs.ai/_mock/api/sync-cloud-openapi/accounts/scd-k2j8n4m1/dataspaces/sds-a1b2c3d4 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Dataspace deleted successfully

Response
No content

Workspaces

Workspace management operations. Workspaces are virtual computing resources that provide stateless computational services for content processing.

Operations

Ontologies

Ontology management operations. Ontologies define the categorization, indexing and metadata tagging structure for content within dataspaces.

Operations

Categories

Category management operations. Categories represent the grouping or classification of content within a dataspace (taxonomy).

Operations

Metadata Queries

Metadata key management operations. Metadata keys define specific metadata fields that can be associated with content and bound to categories.

Operations

Users

User management operations. Users can interact with dataspaces and workspaces with assigned roles and permissions.

Operations

Libraries

Library management operations. Libraries are external content sources that can be scraped and indexed for use as citation sources in AI queries.

Operations

Library Bindings

Library binding operations. Bind libraries to workspaces to enable access to library content for AI queries.

Operations

Agents

Agent management operations. Agents are automated entities that can perform operations on behalf of users.

Operations

Workflows

Workflow management operations. Workflows define automated processes for content handling and business logic.

Operations

Task Definitions

Task definition management operations

Operations

Helpers

Helper utility operations

Operations