Skip to content
API Reference/Account Admin API/
/
Create a new AI agent for...

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

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

Create a new AI agent for an account

Request

Creates a new AI agent with specified instructions and behavior for the account

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 agent

Example: "Document Categorization Agent"
descriptionstringnon-emptyrequired

Description of the agent's purpose

Example: "Categorizes incoming documents according to the dataspace ontology"
instructionsstringnon-emptyrequired

Text instructions that act as a system prompt describing the agent's general behavior across all tasks

Example: "You are a document categorization agent. Analyze incoming documents and categorize them according to the provided ontology. Always provide clear reasoning for your categorization decisions."
defaultContextobject or null

Optional default context configuration that will be pre-selected when using this agent

curl -i -X POST \
  https://docs.syncdocs.ai/_mock/api/sync-cloud-openapi/accounts/scd-k2j8n4m1/agents \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Document Categorization Agent",
    "description": "Categorizes incoming documents according to the dataspace ontology",
    "instructions": "You are a document categorization agent. Analyze incoming documents and categorize them according to the provided ontology. Always provide clear reasoning for your categorization decisions.",
    "defaultContext": {
      "libraries": [
        "01234567-89ab-cdef-0123-456789abcdef"
      ],
      "includeWebSearchResults": false
    }
  }'

Responses

Agent created successfully

Bodyapplication/json
agentIdstring(uuid)required

The UUID of the agent

Example: "550e8400-e29b-41d4-a716-446655440000"
accountIdstring^scd-[a-z0-9]{8}$required

Short account ID with scd- prefix

Example: "scd-k2j8n4m1"
namestringrequired

Name of the agent

Example: "Document Categorization Agent"
descriptionstringrequired

Description of the agent's purpose

Example: "Categorizes incoming documents according to the dataspace ontology"
instructionsstringrequired

Text instructions that act as a system prompt describing the agent's general behavior across all tasks

Example: "You are a document categorization agent. Analyze incoming documents and categorize them according to the provided ontology."
defaultContextobject or null

Optional default context configuration that will be pre-selected when using this agent

createdBystring(uuid)required

ID of the user that created the agent

Example: "123e4567-e89b-12d3-a456-426614174001"
createdAtstring(date-time)required
Example: "2024-01-15T10:30:00Z"
lastUpdatedAtstring or null(date-time)required
Example: "2024-01-15T14:30:00Z"
Response
application/json
{
  "agentId": "550e8400-e29b-41d4-a716-446655440000",
  "accountId": "scd-k2j8n4m1",
  "name": "Document Categorization Agent",
  "description": "Categorizes incoming documents according to the dataspace ontology",
  "instructions": "You are a document categorization agent. Analyze incoming documents and categorize them according to the provided ontology.",
  "defaultContext": {
    "libraries": [ … ],
    "includeWebSearchResults": false
  },
  "createdBy": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2024-01-15T10:30:00Z",
  "lastUpdatedAt": "2024-01-15T14:30:00Z"
}

List all agents for an account

Request

Retrieves a list of all AI agents associated with the specified account

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/agents \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of agents retrieved successfully

Bodyapplication/jsonArray [
agentIdstring(uuid)required

The UUID of the agent

Example: "550e8400-e29b-41d4-a716-446655440000"
accountIdstring^scd-[a-z0-9]{8}$required

Short account ID with scd- prefix

Example: "scd-k2j8n4m1"
namestringrequired

Name of the agent

Example: "Document Categorization Agent"
descriptionstringrequired

Description of the agent's purpose

Example: "Categorizes incoming documents according to the dataspace ontology"
instructionsstringrequired

Text instructions that act as a system prompt describing the agent's general behavior across all tasks

Example: "You are a document categorization agent. Analyze incoming documents and categorize them according to the provided ontology."
defaultContextobject or null

Optional default context configuration that will be pre-selected when using this agent

createdBystring(uuid)required

ID of the user that created the agent

Example: "123e4567-e89b-12d3-a456-426614174001"
createdAtstring(date-time)required
Example: "2024-01-15T10:30:00Z"
lastUpdatedAtstring or null(date-time)required
Example: "2024-01-15T14:30:00Z"
]
Response
application/json
[
  {
    "agentId": "550e8400-e29b-41d4-a716-446655440000",
    "accountId": "scd-k2j8n4m1",
    "name": "Document Categorization Agent",
    "description": "Categorizes incoming documents according to the dataspace ontology",
    "instructions": "You are a document categorization agent. Analyze incoming documents and categorize them according to the provided ontology.",
    "defaultContext": { … },
    "createdBy": "123e4567-e89b-12d3-a456-426614174001",
    "createdAt": "2024-01-15T10:30:00Z",
    "lastUpdatedAt": "2024-01-15T14:30:00Z"
  }
]

Get a specific agent by ID

Request

Retrieves detailed information about a specific AI agent

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

Short account ID with scd- prefix

Example: scd-k2j8n4m1
agentIdstring(uuid)required

The UUID of the agent

Example: 550e8400-e29b-41d4-a716-446655440000
curl -i -X GET \
  https://docs.syncdocs.ai/_mock/api/sync-cloud-openapi/accounts/scd-k2j8n4m1/agents/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Agent retrieved successfully

Bodyapplication/json
agentIdstring(uuid)required

The UUID of the agent

Example: "550e8400-e29b-41d4-a716-446655440000"
accountIdstring^scd-[a-z0-9]{8}$required

Short account ID with scd- prefix

Example: "scd-k2j8n4m1"
namestringrequired

Name of the agent

Example: "Document Categorization Agent"
descriptionstringrequired

Description of the agent's purpose

Example: "Categorizes incoming documents according to the dataspace ontology"
instructionsstringrequired

Text instructions that act as a system prompt describing the agent's general behavior across all tasks

Example: "You are a document categorization agent. Analyze incoming documents and categorize them according to the provided ontology."
defaultContextobject or null

Optional default context configuration that will be pre-selected when using this agent

createdBystring(uuid)required

ID of the user that created the agent

Example: "123e4567-e89b-12d3-a456-426614174001"
createdAtstring(date-time)required
Example: "2024-01-15T10:30:00Z"
lastUpdatedAtstring or null(date-time)required
Example: "2024-01-15T14:30:00Z"
Response
application/json
{
  "agentId": "550e8400-e29b-41d4-a716-446655440000",
  "accountId": "scd-k2j8n4m1",
  "name": "Document Categorization Agent",
  "description": "Categorizes incoming documents according to the dataspace ontology",
  "instructions": "You are a document categorization agent. Analyze incoming documents and categorize them according to the provided ontology.",
  "defaultContext": {
    "libraries": [ … ],
    "includeWebSearchResults": false
  },
  "createdBy": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2024-01-15T10:30:00Z",
  "lastUpdatedAt": "2024-01-15T14:30:00Z"
}

Update an existing agent

Request

Updates the properties of an existing AI agent

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

Short account ID with scd- prefix

Example: scd-k2j8n4m1
agentIdstring(uuid)required

The UUID of the agent

Example: 550e8400-e29b-41d4-a716-446655440000
Bodyapplication/json
namestringnon-empty

Name of the agent

Example: "Updated Document Categorization Agent"
descriptionstringnon-empty

Description of the agent's purpose

Example: "Updated description for document categorization"
instructionsstringnon-empty

Text instructions that act as a system prompt describing the agent's general behavior across all tasks

Example: "Updated instructions for document categorization behavior"
defaultContextobject or null

Optional default context configuration that will be pre-selected when using this agent

curl -i -X PUT \
  https://docs.syncdocs.ai/_mock/api/sync-cloud-openapi/accounts/scd-k2j8n4m1/agents/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated Document Categorization Agent",
    "description": "Updated description for document categorization",
    "instructions": "Updated instructions for document categorization behavior",
    "defaultContext": {
      "libraries": [
        "01234567-89ab-cdef-0123-456789abcdef"
      ],
      "includeWebSearchResults": false
    }
  }'

Responses

Agent updated successfully

Bodyapplication/json
agentIdstring(uuid)required

The UUID of the agent

Example: "550e8400-e29b-41d4-a716-446655440000"
accountIdstring^scd-[a-z0-9]{8}$required

Short account ID with scd- prefix

Example: "scd-k2j8n4m1"
namestringrequired

Name of the agent

Example: "Document Categorization Agent"
descriptionstringrequired

Description of the agent's purpose

Example: "Categorizes incoming documents according to the dataspace ontology"
instructionsstringrequired

Text instructions that act as a system prompt describing the agent's general behavior across all tasks

Example: "You are a document categorization agent. Analyze incoming documents and categorize them according to the provided ontology."
defaultContextobject or null

Optional default context configuration that will be pre-selected when using this agent

createdBystring(uuid)required

ID of the user that created the agent

Example: "123e4567-e89b-12d3-a456-426614174001"
createdAtstring(date-time)required
Example: "2024-01-15T10:30:00Z"
lastUpdatedAtstring or null(date-time)required
Example: "2024-01-15T14:30:00Z"
Response
application/json
{
  "agentId": "550e8400-e29b-41d4-a716-446655440000",
  "accountId": "scd-k2j8n4m1",
  "name": "Document Categorization Agent",
  "description": "Categorizes incoming documents according to the dataspace ontology",
  "instructions": "You are a document categorization agent. Analyze incoming documents and categorize them according to the provided ontology.",
  "defaultContext": {
    "libraries": [ … ],
    "includeWebSearchResults": false
  },
  "createdBy": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2024-01-15T10:30:00Z",
  "lastUpdatedAt": "2024-01-15T14:30:00Z"
}

Delete an agent

Request

Permanently deletes an AI agent from the account

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

Short account ID with scd- prefix

Example: scd-k2j8n4m1
agentIdstring(uuid)required

The UUID of the agent

Example: 550e8400-e29b-41d4-a716-446655440000
curl -i -X DELETE \
  https://docs.syncdocs.ai/_mock/api/sync-cloud-openapi/accounts/scd-k2j8n4m1/agents/550e8400-e29b-41d4-a716-446655440000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Agent deleted successfully

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