> ## Documentation Index
> Fetch the complete documentation index at: https://cortex-e852fafe-t3code-rewrite-docs-declutter.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Sync Connector
> Sync a connector now instead of waiting for its schedule.
Starts a sync of every configured resource now. Connectors already sync on their own every `sync_interval_seconds` (one hour by default), and [Configure Connector](/api-reference/v2/endpoint/configure-connector) starts the first sync itself. Call this only when you need fresh data sooner.
A `202` means the sync was started, not that it finished. If a sync is already running, it continues and `run_id` is empty. Follow progress with [Get Connector Status](/api-reference/v2/endpoint/get-connector-status).
```bash cURL theme={null}
curl -X POST 'https://api.hydradb.com/connectors/{id}/sync' \
-H "Authorization: Bearer $HYDRA_DB_API_KEY" \
-H "API-Version: 2"
```
```json 202 theme={null}
{
"workflow_id": "connector-sync-{connector_id}",
"run_id": "{run_id}"
}
```
## Errors
* `404`: no connector with this id in your workspace.
* `409`: the connector is paused, or it has no active resources to sync. [Resume](/api-reference/v2/endpoint/resume-connector) it, or [configure](/api-reference/v2/endpoint/configure-connector) resources first.
* `429`: your plan's sync limit is reached for this period.
## Related Resources
* [Get Connector Status](/api-reference/v2/endpoint/get-connector-status): check that the sync succeeded
* [Update Connector](/api-reference/v2/endpoint/update-connector): change how often scheduled syncs run
## OpenAPI
````yaml api-reference/v2/openapi.json POST /connectors/{id}/sync
openapi: 3.1.0
info:
contact:
email: support@hydradb.com
name: HydraDB Support
description: >-
HydraDB Application API — knowledge ingestion, search, and memory
management.
license:
name: Proprietary
title: HydraDB Application API
version: 0.1.0
servers:
- description: Production server
url: https://api.hydradb.com
security: []
externalDocs:
description: ''
url: ''
paths:
/connectors/{id}/sync:
post:
tags:
- connectors
summary: Trigger a connector sync
description: >-
Start a sync now instead of waiting for the schedule. If a sync is
already running, it continues and `run_id` is empty. Returns `409` while
the connector is paused.
parameters:
- description: Connector ID
in: path
name: id
required: true
schema:
example: HydraDoc1234
type: string
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/handler.connectorSyncResponse'
description: Accepted
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/handler.ErrorResponse'
description: Not Found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/handler.ErrorResponse'
description: Conflict
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/handler.ErrorResponse'
description: Internal Server Error
'503':
content:
application/json:
schema:
$ref: '#/components/schemas/handler.ErrorResponse'
description: Service Unavailable
security:
- BearerAuth: []
components:
schemas:
handler.connectorSyncResponse:
properties:
run_id:
description: >-
Identifier of the run this request started. Empty when a sync was
already running, in which case that run continues.
type: string
workflow_id:
description: Identifier of the sync job for this connector.
type: string
type: object
handler.ErrorResponse:
properties:
data:
description: Always `null` on this error response.
detail:
$ref: '#/components/schemas/handler.ErrorDetail'
description: Structured error detail with code, message, and deprecation hints.
example:
deprecated: true
deprecated_field: tenant_id
error_code: VALIDATION_ERROR
message: Request validation failed
preferred_field: database
error:
$ref: '#/components/schemas/handler.apiError'
description: Error message, empty string on success.
example:
code: DATABASE_NOT_FOUND
message: Database not found
meta:
$ref: '#/components/schemas/handler.ErrorMeta'
example:
latency_ms: 12.3
request_id: 9d13aef4-02f4-4e73-8c62-4c2601d04f9d
success:
description: Whether the request succeeded.
example: false
type: boolean
type: object
handler.ErrorDetail:
properties:
deprecated:
description: Whether this response concerns a deprecated field or route.
example: true
type: boolean
deprecated_field:
description: The deprecated field name.
example: tenant_id
type: string
error_code:
description: Machine-readable error classification code.
example: VALIDATION_ERROR
type: string
message:
description: Human-readable description of the error.
example: Request validation failed
type: string
preferred_field:
description: The canonical replacement for the deprecated field.
example: database
type: string
success:
deprecated: true
description: >-
Deprecated: always `false`. Read the HTTP status, then `error.code`
and `error.message`.
example: false
type: boolean
x-deprecated: 'true'
type: object
handler.apiError:
properties:
code:
description: Machine-readable error code (e.g. `DATABASE_NOT_FOUND`).
example: DATABASE_NOT_FOUND
type: string
message:
description: Human-readable description of the error.
example: Database not found
type: string
type: object
handler.ErrorMeta:
properties:
api_version:
description: Version of the API that served the request, for example `2.0.1`.
type: string
latency_ms:
description: Server-side processing time in milliseconds.
example: 12.3
type: number
request_id:
description: Unique identifier for this request, useful for support and tracing.
example: 9d13aef4-02f4-4e73-8c62-4c2601d04f9d
type: string
type: object
securitySchemes:
BearerAuth:
bearerFormat: API key
description: 'API key sent as a Bearer token: "Bearer prefix.secret"'
scheme: bearer
type: http
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.