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

# Trigger intel source sync

> Enqueues an immediate sync job for a custom intel source



## OpenAPI

````yaml https://app.cotool.ai/api/docs/openapi.json post /sources/{id}/sync
openapi: 3.1.0
info:
  title: Cotool API
  version: 1.0.0
  description: >-
    # Cotool API Documentation


    The Cotool API allows you to interact with the Cotool platform
    programmatically, enabling you to build powerful integrations and automate
    your workflows.


    ## Getting an API Key


    Follow these steps to generate your API key:


    1. **Log in** to the Cotool web interface

    2. **Navigate** to `/settings/api-keys`

    3. **Click** "Generate Key"

    4. **Copy and store** your API key securely ⚠️ *It won't be shown again*


    ## API Key Authentication


    For programmatic access and integrations, use your API key with the
    Authorization header:


    ```http

    Authorization: Bearer your_api_key_here

    ```


    ```bash

    curl -X GET "https://app.cotool.ai/api/endpoint" \
      -H "Authorization: Bearer your_api_key_here" \
      -H "Content-Type: application/json"
    ```
servers:
  - url: https://app.cotool.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /sources/{id}/sync:
    post:
      tags: []
      summary: Trigger intel source sync
      description: Enqueues an immediate sync job for a custom intel source
      parameters:
        - in: path
          name: id
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  source:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      displayName:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      kind:
                        type: string
                        enum:
                          - rss
                          - api
                      apiType:
                        type:
                          - string
                          - 'null'
                      isBuiltIn:
                        type: boolean
                      feedUrl:
                        type:
                          - string
                          - 'null'
                      serverUrl:
                        type:
                          - string
                          - 'null'
                      organizationId:
                        type:
                          - string
                          - 'null'
                      createdBy:
                        type:
                          - string
                          - 'null'
                      hasApiKey:
                        type: boolean
                      enabled:
                        type: boolean
                      sourceEnabled:
                        type: boolean
                      subscriptionEnabled:
                        type: boolean
                      scheduleCron:
                        type:
                          - string
                          - 'null'
                      maxEntries:
                        type: number
                      lastFetchedAt:
                        type:
                          - string
                          - 'null'
                      lastStatus:
                        type:
                          - string
                          - 'null'
                      lastError:
                        type:
                          - string
                          - 'null'
                      itemCountLast24h:
                        type: number
                      syncJob:
                        type:
                          - object
                          - 'null'
                        properties:
                          jobId:
                            type: string
                          status:
                            type: string
                            enum:
                              - pending
                              - retrying
                              - waiting
                              - in_progress
                              - succeeded
                              - failed
                              - canceled
                              - expired
                              - skipped
                          queuedAt:
                            type: string
                          startedAt:
                            type:
                              - string
                              - 'null'
                          finishedAt:
                            type:
                              - string
                              - 'null'
                          updatedAt:
                            type: string
                          attemptCount:
                            type: number
                          error:
                            type:
                              - string
                              - 'null'
                        required:
                          - jobId
                          - status
                          - queuedAt
                          - startedAt
                          - finishedAt
                          - updatedAt
                          - attemptCount
                          - error
                      createdAt:
                        type: string
                      updatedAt:
                        type: string
                    required:
                      - id
                      - name
                      - displayName
                      - description
                      - kind
                      - apiType
                      - isBuiltIn
                      - feedUrl
                      - serverUrl
                      - organizationId
                      - createdBy
                      - hasApiKey
                      - enabled
                      - sourceEnabled
                      - subscriptionEnabled
                      - scheduleCron
                      - maxEntries
                      - lastFetchedAt
                      - lastStatus
                      - lastError
                      - itemCountLast24h
                      - createdAt
                      - updatedAt
                  jobId:
                    type: string
                required:
                  - source
                  - jobId
        '400':
          description: Bad request — input validation failed or the request was malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized — missing or invalid API key / session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — the authenticated user lacks the required permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: shell
          label: cURL
          source: |-
            curl -X POST "https://app.cotool.ai/sources/:id/sync" \
              -H "Authorization: Bearer YOUR_API_KEY" \
              -H "Content-Type: application/json"
components:
  schemas:
    ValidationError:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
        issues:
          type: array
          description: >-
            Detailed validation issues, present when request or response schema
            validation fails
          items:
            type: object
            additionalProperties: true
      required:
        - error
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
      required:
        - error
    PermissionError:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
        missingPerms:
          type: array
          description: Permissions the authenticated user is missing for this operation
          items:
            type: string
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key authentication for programmatic access. Include your API key in
        the Authorization header as: `Bearer your_api_key_here`

````