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

# Create an Agent Source

> Bind a Git Project as the authoring home of one Agent definition lineage. The logical name is immutable, and the referenced Project supplies the governed Connection that every later sync reads through. An optional `root` — also immutable — scopes the source to one project-relative subtree read as a D19 agent directory; omit it to read the repository root. Accepts an Idempotency-Key.

Checkfu support posture: alpha; hosted. Required evidence journey: agent-definition. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.



## OpenAPI

````yaml /openapi.json post /v1/agent-sources
openapi: 3.1.0
info:
  title: Checkfu API
  version: '2026-08-29'
  description: >-
    Authentication is declared per operation: API-key, runtime, or connector
    bearer; Automation signature; or credential-free pairing redemption. Every
    general Checkfu REST request requires the dated `Checkfu-Version` header
    (one of: 2026-08-29); the three MCP JSON-RPC transports use
    `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth
    callback carries neither Checkfu header. API keys resolve one Workspace
    without a request selector; authenticated responses identify it with
    `Checkfu-Workspace-Id`.
servers:
  - url: https://api.checkfu.com
security:
  - bearerAuth: []
tags:
  - name: organizations
  - name: sourceRepositories
  - name: tenants
  - name: workspaces
  - name: principals
  - name: principalGroups
  - name: principalAccessCredentials
  - name: apiKeys
  - name: agents
  - name: harnesses
  - name: harnessRuntime
  - name: computerProfiles
  - name: permissionAssignments
  - name: actionPolicies
  - name: files
  - name: memoryStores
  - name: dreams
  - name: modelCredentials
  - name: modelRoutingProfiles
  - name: blueprintInstallations
  - name: toolSources
  - name: skills
  - name: skillSources
  - name: agentSources
  - name: skillProposals
  - name: instructionProposals
  - name: catalog
  - name: concepts
  - name: support
  - name: connections
  - name: connectionVaults
  - name: connectionAssignments
  - name: connectedRuntimes
  - name: projects
  - name: collaboration
  - name: automationGraphs
  - name: automations
  - name: actionApprovals
  - name: standingApprovals
  - name: usage
  - name: models
  - name: outcomes
  - name: budgets
  - name: billing
  - name: sessions
  - name: audit
  - name: sessionExports
  - name: runs
  - name: runnerPools
  - name: transcripts
  - name: sessionWatches
  - name: sessionHandoffs
  - name: sessionCapsules
  - name: sessionTrajectories
  - name: webhookEndpoints
  - name: integrationGateway
  - name: agentDeployments
  - name: workEnvironments
  - name: computers
  - name: computerScreens
  - name: computerBrowserObservations
  - name: computerBrowserActions
  - name: environments
  - name: vaults
  - name: apiMcp
  - name: a2a
paths:
  /v1/agent-sources:
    post:
      tags:
        - agentSources
      summary: Create an Agent Source
      description: >-
        Bind a Git Project as the authoring home of one Agent definition
        lineage. The logical name is immutable, and the referenced Project
        supplies the governed Connection that every later sync reads through. An
        optional `root` — also immutable — scopes the source to one
        project-relative subtree read as a D19 agent directory; omit it to read
        the repository root. Accepts an Idempotency-Key.


        Checkfu support posture: alpha; hosted. Required evidence journey:
        agent-definition. Deployment-specific readiness and the latest proven
        release are available from GET /v1/support/capabilities.
      operationId: agentSources.createAgentSource
      parameters:
        - name: checkfu-version
          in: header
          schema:
            type: string
            enum:
              - '2026-08-29'
          required: true
        - name: idempotency-key
          in: header
          schema:
            type: string
            allOf:
              - maxLength: 255
          required: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  allOf:
                    - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$
                project_id:
                  $ref: '#/components/schemas/ProjectId'
                description:
                  anyOf:
                    - type: string
                      allOf:
                        - maxLength: 16384
                    - type: 'null'
                root:
                  anyOf:
                    - type: string
                      allOf:
                        - minLength: 1
                        - maxLength: 1024
                        - maxLength: 914
                    - type: 'null'
              required:
                - name
                - project_id
              additionalProperties: false
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    $ref: '#/components/schemas/AgentSourceId'
                  workspace_id:
                    $ref: '#/components/schemas/WorkspaceId'
                  name:
                    type: string
                    allOf:
                      - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$
                  project_id:
                    $ref: '#/components/schemas/ProjectId'
                  description:
                    anyOf:
                      - type: string
                        allOf:
                          - maxLength: 16384
                      - type: 'null'
                  root:
                    anyOf:
                      - $ref: '#/components/schemas/ProjectPath'
                      - type: 'null'
                  status:
                    $ref: '#/components/schemas/Union_153'
                  last_sync:
                    $ref: '#/components/schemas/Union_154'
                  last_sync_error_code:
                    anyOf:
                      - type: string
                        allOf:
                          - minLength: 1
                          - maxLength: 8192
                      - type: 'null'
                  version:
                    type: integer
                    allOf:
                      - exclusiveMinimum: 0
                  created_at:
                    type: string
                  updated_at:
                    type: string
                required:
                  - id
                  - workspace_id
                  - name
                  - project_id
                  - description
                  - root
                  - status
                  - last_sync
                  - last_sync_error_code
                  - version
                  - created_at
                  - updated_at
                additionalProperties: false
          headers:
            checkfu-workspace-id:
              description: The Workspace resolved from the authenticated bearer credential.
              required: true
              schema:
                $ref: '#/components/schemas/WorkspaceId'
        '400':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - validation.malformed
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#validation-malformed
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    required:
                      - type
                      - message
                      - more
                    additionalProperties: false
                additionalProperties: false
        '401':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - auth.invalid_key
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#auth-invalid-key
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '403':
          description: >-
            The organization, tenant, or workspace backing this key is
            administratively disabled. | Deployment governance or retention
            policy denied the request.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - auth.disabled_tenancy
                          message:
                            type: string
                          more:
                            type: string
                            enum:
                              - >-
                                https://docs.checkfu.com/reference/errors#auth-disabled-tenancy
                            description: >-
                              Stable public documentation and remedy for this
                              error type.
                        required:
                          - type
                          - message
                          - more
                        additionalProperties: false
                    additionalProperties: false
                  - $ref: '#/components/schemas/PolicyDeniedError'
        '404':
          description: >-
            The requested resource does not exist in the resolved deployment
            boundary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationNotFoundError'
        '409':
          description: >-
            The request conflicts with the resource's current state. | An
            idempotent mutation conflicts with a completed or in-progress
            request for the same key.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ValidationConflictError'
                  - $ref: '#/components/schemas/IdempotencyConflictError'
        '429':
          description: Typed Checkfu wire error
          headers:
            retry-after:
              description: >-
                Delay in seconds for rate limits or deployment quotas with a
                known release or UTC reset boundary
              required: false
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - budget.exceeded
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#budget-exceeded
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '500':
          description: >-
            An unexpected internal failure occurred; the message contains an
            opaque incident reference.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeInternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    ProjectId:
      type: string
      allOf:
        - pattern: ^prj_[0-9a-f]{32}$
    AgentSourceId:
      type: string
      allOf:
        - pattern: ^agsrc_[0-9a-f]{32}$
    WorkspaceId:
      type: string
      allOf:
        - pattern: ^wrkspc_[0-9a-f]{32}$
    ProjectPath:
      type: string
      allOf:
        - minLength: 1
        - maxLength: 1024
    Union_153:
      type: string
      enum:
        - pending
        - healthy
        - sync_failed
    Union_154:
      anyOf:
        - type: object
          properties:
            project_revision:
              type: integer
              allOf:
                - exclusiveMinimum: 0
            commit_sha:
              type: string
              allOf:
                - pattern: ^(?:[0-9a-f]{40}|[0-9a-f]{64})$
            author_login:
              anyOf:
                - type: string
                - type: 'null'
            synced_at:
              type: string
            draft:
              anyOf:
                - type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - created
                        - updated
                        - unchanged
                        - adopted
                    agent_id:
                      $ref: '#/components/schemas/AgentId'
                    draft_revision:
                      type: integer
                      allOf:
                        - exclusiveMinimum: 0
                    agent_version:
                      anyOf:
                        - type: integer
                          allOf:
                            - exclusiveMinimum: 0
                        - type: 'null'
                  required:
                    - action
                    - agent_id
                    - draft_revision
                    - agent_version
                  additionalProperties: false
                - type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - invalid
                    reason:
                      type: string
                      allOf:
                        - maxLength: 512
                  required:
                    - action
                    - reason
                  additionalProperties: false
                - type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - missing
                  required:
                    - action
                  additionalProperties: false
            publication:
              anyOf:
                - type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - published
                    version:
                      type: integer
                      allOf:
                        - exclusiveMinimum: 0
                    attributed_to:
                      $ref: '#/components/schemas/PrincipalId'
                  required:
                    - action
                    - version
                    - attributed_to
                  additionalProperties: false
                - type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - withheld
                    reason:
                      type: string
                      enum:
                        - service_principal
                        - unlinked_identity
                  required:
                    - action
                    - reason
                  additionalProperties: false
                - type: object
                  properties:
                    action:
                      type: string
                      enum:
                        - not_attempted
                    reason:
                      type: string
                      enum:
                        - invalid_tree
                        - missing_tree
                        - adopted_unchanged
                        - no_draft_change
                        - author_unavailable
                  required:
                    - action
                    - reason
                  additionalProperties: false
          required:
            - project_revision
            - commit_sha
            - author_login
            - synced_at
            - draft
            - publication
          additionalProperties: false
        - type: 'null'
    PolicyDeniedError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - policy.denied
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#policy-denied
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: Deployment governance or retention policy denied the request.
    ValidationNotFoundError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.not_found
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-not-found
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        The requested resource does not exist in the resolved deployment
        boundary.
    ValidationConflictError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.conflict
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-conflict
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: The request conflicts with the resource's current state.
    IdempotencyConflictError:
      anyOf:
        - $ref: '#/components/schemas/ValidationIdempotencyConflictError'
        - $ref: '#/components/schemas/ValidationIdempotencyInProgressError'
      description: >-
        An idempotent mutation conflicts with a completed or in-progress request
        for the same key.
    RuntimeInternalError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - runtime.internal
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#runtime-internal
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        An unexpected internal failure occurred; the message contains an opaque
        incident reference.
    AgentId:
      type: string
      allOf:
        - pattern: ^agent_[0-9a-f]{32}$
    PrincipalId:
      type: string
      allOf:
        - pattern: ^prin_[0-9a-f]{32}$
    ValidationIdempotencyConflictError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.idempotency_conflict
            message:
              type: string
            more:
              type: string
              enum:
                - >-
                  https://docs.checkfu.com/reference/errors#validation-idempotency-conflict
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: The Idempotency-Key is already bound to a different request.
    ValidationIdempotencyInProgressError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.idempotency_in_progress
            message:
              type: string
            more:
              type: string
              enum:
                - >-
                  https://docs.checkfu.com/reference/errors#validation-idempotency-in-progress
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        An identical idempotent request is still in progress and may be retried
        later.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````