> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognee.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Sync Progress

> Report sync progress for a connected integration.

Returns latest (the most recent run's progress snapshot, null when there is none),
activeRuns (unfinished runs this process can confirm are executing) and
unknownActivityCount (unfinished runs owned by another process or an exited
worker). An unregistered provider, no active connection for the caller, and a
connection revoked or re-owned since it was read all return 404.

## Path Parameters
- **provider** (str): Key of a registered OAuth provider (see GET
  /api/v1/integrations/status).

## Query Parameters
- **account_id** (Optional[str]): Connection to use (from GET
  /api/v1/integrations/\{provider\}/connections); the newest one is used when omitted.
  An id that is not the caller's, or a blank one, returns 404 and never falls back to
  another connection.



## OpenAPI

````yaml /cognee_openapi_spec.json get /api/v1/integrations/{provider}/sync/progress
openapi: 3.1.0
info:
  title: Cognee API
  description: Cognee API with Bearer token and Cookie auth
  version: 1.0.0
servers:
  - url: https://{tenant}.aws.cognee.ai
    description: 'Cognee Cloud: your tenant pod, named in the platform.cognee.ai dashboard'
    variables:
      tenant:
        default: your-tenant
        description: Your tenant name, shown in the Cognee Cloud dashboard
  - url: http://localhost:8000
    description: 'Self-hosted: a locally running cognee server'
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: activity
    description: >-
      Activity endpoints for inspecting pipeline runs, traced spans, tenant
      users, agents, and dataset exports.
  - name: add
    description: Data ingestion endpoints for adding text, files, and structured data.
  - name: agent connections
    description: >-
      Endpoints for registering, unregistering, and inspecting agent connections
      to the instance.
  - name: agent management
    description: Endpoints for creating, listing, retrieving, and deleting agents.
  - name: auth
    description: >-
      Authentication endpoints for user registration, login, and token
      management.
  - name: checks
    description: >-
      Diagnostic endpoint for validating a Cognee Cloud API key supplied in the
      X-Api-Key header.
  - name: cognify
    description: >-
      Knowledge processing endpoints to transform raw data into knowledge
      graphs.
  - name: configuration
    description: >-
      Endpoints for storing, retrieving, and listing a user's saved
      configurations.
  - name: conflicts
    description: ''
  - name: datasets
    description: Dataset management endpoints for listing, creating, and deleting datasets.
  - name: delete
    description: Data deletion endpoints (deprecated — use datasets endpoints instead).
  - name: forget
    description: Endpoint for removing data from the knowledge graph.
  - name: health
    description: Liveness, readiness, and component health checks.
  - name: improve
    description: Endpoint for enriching and improving an existing knowledge graph.
  - name: integrations
    description: >-
      Endpoints for connecting, provisioning, and disconnecting OAuth providers
      and plugins.
  - name: llm
    description: >-
      LLM-backed endpoints for inferring graph schemas and generating custom
      extraction prompts.
  - name: memify
    description: >-
      Endpoint for running enrichment pipelines over existing graphs or supplied
      data.
  - name: ontologies
    description: >-
      Endpoints for uploading, listing, and deleting ontology files used during
      cognify.
  - name: permissions
    description: Permission management for multi-user access control.
  - name: recall
    description: >-
      Endpoints for querying the knowledge graph and reviewing past recall
      history.
  - name: remember
    description: >-
      Endpoints for ingesting data into the knowledge graph and storing session
      memory entries.
  - name: responses
    description: Response generation endpoints using the knowledge graph.
  - name: schema
    description: >-
      Schema inspection endpoints for a dataset's derived schema inventory and
      the caller-wide memory provenance graph.
  - name: search
    description: Search endpoints for querying the knowledge graph.
  - name: sessions
    description: >-
      Endpoints for listing sessions and reporting usage, cost, and token
      statistics.
  - name: settings
    description: Configuration endpoints for managing Cognee settings.
  - name: skills
    description: >-
      Skill management endpoints for ingesting, listing, retrieving, and
      deleting dataset skills, plus read-only retrieval of improvement
      proposals.
  - name: slack
    description: >-
      Endpoints for listing workspace channels, setting channel allowlists, and
      linking Slack accounts.
  - name: sync
    description: Endpoints for syncing local data to Cognee Cloud and checking sync status.
  - name: update
    description: Endpoint for updating existing data in a dataset.
  - name: users
    description: User management endpoints.
  - name: validate
    description: >-
      Diagnostic endpoint for checking consistency between a dataset's graph and
      vector stores.
  - name: visualize
    description: Graph visualization endpoints.
paths:
  /api/v1/integrations/{provider}/sync/progress:
    get:
      tags:
        - integrations
      summary: Sync Progress
      description: >-
        Report sync progress for a connected integration.


        Returns latest (the most recent run's progress snapshot, null when there
        is none),

        activeRuns (unfinished runs this process can confirm are executing) and

        unknownActivityCount (unfinished runs owned by another process or an
        exited

        worker). An unregistered provider, no active connection for the caller,
        and a

        connection revoked or re-owned since it was read all return 404.


        ## Path Parameters

        - **provider** (str): Key of a registered OAuth provider (see GET
          /api/v1/integrations/status).

        ## Query Parameters

        - **account_id** (Optional[str]): Connection to use (from GET
          /api/v1/integrations/\{provider\}/connections); the newest one is used when omitted.
          An id that is not the caller's, or a blank one, returns 404 and never falls back to
          another connection.
      operationId: sync_progress_api_v1_integrations__provider__sync_progress_get
      parameters:
        - name: provider
          in: path
          required: true
          schema:
            type: string
            title: Provider
        - name: account_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncProgressResult'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    SyncProgressResult:
      properties:
        latest:
          anyOf:
            - $ref: '#/components/schemas/SyncProgress'
            - type: 'null'
        activeRuns:
          items:
            $ref: '#/components/schemas/SyncProgress'
          type: array
          title: Activeruns
        unknownActivityCount:
          type: integer
          title: Unknownactivitycount
          default: 0
      type: object
      title: SyncProgressResult
      description: >-
        Latest invocation and all locally confirmed active invocations.


        Unknown activity counts unresolved durable runs owned by a different
        process or

        an exited worker. It is deliberately not reported as a live or failed
        job count.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SyncProgress:
      properties:
        runId:
          type: string
          format: uuid
          title: Runid
        provider:
          type: string
          title: Provider
        credentialId:
          type: string
          format: uuid
          title: Credentialid
        datasetId:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Datasetid
        state:
          type: string
          enum:
            - running
            - waiting
            - succeeded
            - partial
            - failed
            - cancelled
            - blocked
          title: State
          default: running
        phase:
          type: string
          enum:
            - queued
            - checking
            - downloading
            - discovering
            - processing
            - indexing
            - finalizing
          title: Phase
          default: checking
        startedAt:
          type: string
          format: date-time
          title: Startedat
        phaseStartedAt:
          type: string
          format: date-time
          title: Phasestartedat
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
        endedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Endedat
        completed:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Completed
        total:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Total
        unit:
          anyOf:
            - type: string
              enum:
                - items
                - files
                - bytes
                - documents
                - channels
                - repositories
                - scopes
            - type: 'null'
          title: Unit
        counts:
          additionalProperties:
            type: integer
          type: object
          title: Counts
        reason:
          anyOf:
            - type: string
              enum:
                - rate_limited
                - waiting_for_worker
                - waiting_for_lock
                - resource_limit
                - provider_error
                - processing_error
                - cancelled
                - connection_changed
                - incomplete
            - type: 'null'
          title: Reason
        elapsedSeconds:
          type: number
          title: Elapsedseconds
          default: 0
        phaseElapsedSeconds:
          type: number
          title: Phaseelapsedseconds
          default: 0
        phasePercent:
          anyOf:
            - type: number
            - type: 'null'
          title: Phasepercent
        phaseEtaSeconds:
          anyOf:
            - type: number
            - type: 'null'
          title: Phaseetaseconds
        executionActive:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Executionactive
      type: object
      required:
        - runId
        - provider
        - credentialId
        - startedAt
        - phaseStartedAt
        - updatedAt
      title: SyncProgress
      description: >-
        Last observation plus phase-local estimates; no source text or exception
        messages.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.