Chronary Human Calendar Connections API

openapi: 3.2.0
info:
  title: Chronary Human Calendar Connections API
  version: 1.0.0
  description: 'Calendar-as-a-service API for AI agents.


    Manage calendars, events, and availability for AI and human agents.

    All endpoints require an API key passed as a Bearer token.


    **Authentication:** `Authorization: Bearer chr_sk_...` or `Authorization: Bearer chr_ak_...`


    **Rate limit:** 10 requests/second per API key. Exceeds return HTTP 429.


    **Quotas:** Monthly operation limits by plan — see Billing & plans and Rate limits.


    **Agent bootstrap:** Custom extensions prefixed `x-agent-*` describe the self-signup flow for AI agents. These are not part of any registered OpenAPI extension — they are a Chronary convention.'
  contact:
    name: Chronary Support
    email: support@chronary.ai
    url: https://docs.chronary.ai
servers:
- url: https://api.chronary.ai
  description: Production
security:
- BearerAuth: []
tags:
- name: Human Calendar Connections
paths:
  /v1/calendar-connections/oauth/{provider}/start:
    post:
      tags:
      - Human Calendar Connections
      security:
      - SessionAuth: []
      parameters:
      - schema:
          type: string
          enum:
          - google
          - microsoft
        required: true
        name: provider
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                capabilities:
                  type: array
                  items:
                    type: string
                    enum:
                    - availability
                    - publishing
                  minItems: 1
                  maxItems: 2
                  default:
                  - availability
                  description: Connection capabilities. "availability" reads free/busy to compute agent availability. "publishing" (writing confirmed Chronary events to the external calendar) is supported for Microsoft Outlook only — Google connections are availability-only and reject the "publishing" capability.
                setup_link_id:
                  type: string
      responses:
        '200':
          description: Provider authorization URL
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarConnectionOAuthStart'
        '400':
          description: Validation error — invalid request body or query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid console session — these endpoints require a console JWT, not an API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden — quota exceeded or operation not permitted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: startCalendarConnectionOAuth
      summary: Start calendar connection OAuth
      x-summary-source: derived
  /v1/calendar-connections/oauth/{provider}/callback:
    get:
      tags:
      - Human Calendar Connections
      security:
      - SessionAuth: []
      parameters:
      - schema:
          type: string
          enum:
          - google
          - microsoft
        required: true
        name: provider
        in: path
      - schema:
          type: string
        required: false
        name: code
        in: query
      - schema:
          type: string
        required: false
        name: state
        in: query
      - schema:
          type: string
        required: false
        name: error
        in: query
      responses:
        '302':
          description: Redirect to console
      operationId: completeCalendarConnectionOAuth
      summary: Complete calendar connection OAuth
      x-summary-source: derived
  /v1/calendar-connections:
    get:
      tags:
      - Human Calendar Connections
      security:
      - SessionAuth: []
      responses:
        '200':
          description: Calendar connections
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarConnectionList'
      operationId: listCalendarConnections
      summary: List calendar connections
      x-summary-source: derived
  /v1/calendar-connections/{id}:
    get:
      tags:
      - Human Calendar Connections
      security:
      - SessionAuth: []
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Calendar connection detail and safe sync health
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarConnectionDetail'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getCalendarConnection
      summary: Get calendar connection
      x-summary-source: derived
    patch:
      tags:
      - Human Calendar Connections
      security:
      - SessionAuth: []
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                capabilities:
                  type: array
                  items:
                    type: string
                    enum:
                    - availability
                    - publishing
                  minItems: 1
                  maxItems: 2
                  default:
                  - availability
                  description: Connection capabilities. "availability" reads free/busy to compute agent availability. "publishing" (writing confirmed Chronary events to the external calendar) is supported for Microsoft Outlook only — Google connections are availability-only and reject the "publishing" capability.
                selected_external_calendar_ids:
                  type: array
                  items:
                    type: string
                  maxItems: 50
      responses:
        '200':
          description: Connection updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarConnectionMutation'
        '400':
          description: Validation error — invalid request body or query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: updateCalendarConnection
      summary: Update calendar connection
      x-summary-source: derived
    delete:
      tags:
      - Human Calendar Connections
      security:
      - SessionAuth: []
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '204':
          description: Deleted
      operationId: deleteCalendarConnection
      summary: Delete calendar connection
      x-summary-source: derived
  /v1/calendar-connections/{id}/external-calendars:
    get:
      tags:
      - Human Calendar Connections
      security:
      - SessionAuth: []
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '200':
          description: External calendars and safe sync health
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalCalendarList'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: listExternalCalendars
      summary: List external calendars
      x-summary-source: derived
  /v1/calendar-connections/{id}/refresh:
    post:
      tags:
      - Human Calendar Connections
      security:
      - SessionAuth: []
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '202':
          description: Refresh completed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarConnectionRefresh'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Provider refresh failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: refreshCalendarConnection
      summary: Refresh calendar connection
      x-summary-source: derived
  /v1/calendar-connections/{id}/reauthorize:
    post:
      tags:
      - Human Calendar Connections
      security:
      - SessionAuth: []
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                capabilities:
                  type: array
                  items:
                    type: string
                    enum:
                    - availability
                    - publishing
                  minItems: 1
                  maxItems: 2
                  default:
                  - availability
                  description: Connection capabilities. "availability" reads free/busy to compute agent availability. "publishing" (writing confirmed Chronary events to the external calendar) is supported for Microsoft Outlook only — Google connections are availability-only and reject the "publishing" capability.
      responses:
        '200':
          description: Provider authorization URL
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarConnectionOAuthStart'
        '400':
          description: Validation error — invalid request body or query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: reauthorizeCalendarConnection
      summary: Reauthorize calendar connection
      x-summary-source: derived
  /v1/calendar-connections/{id}/pause:
    post:
      tags:
      - Human Calendar Connections
      security:
      - SessionAuth: []
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Connection paused
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarConnectionMutation'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: pauseCalendarConnection
      summary: Pause calendar connection
      x-summary-source: derived
  /v1/calendar-connections/{id}/resume:
    post:
      tags:
      - Human Calendar Connections
      security:
      - SessionAuth: []
      parameters:
      - schema:
          type: string
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Connection resumed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalendarConnectionMutation'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: resumeCalendarConnection
      summary: Resume calendar connection
      x-summary-source: derived
components:
  schemas:
    CalendarConnectionDetail:
      type: object
      properties:
        id:
          type: string
        provider:
          type: string
          enum:
          - google
          - microsoft
        account_label:
          type:
          - string
          - 'null'
        capabilities:
          type: array
          items:
            type: string
            enum:
            - availability
            - publishing
          minItems: 1
          maxItems: 2
          default:
          - availability
          description: Connection capabilities. "availability" reads free/busy to compute agent availability. "publishing" (writing confirmed Chronary events to the external calendar) is supported for Microsoft Outlook only — Google connections are availability-only and reject the "publishing" capability.
        status:
          type: string
          enum:
          - active
          - paused
          - reauthorization_required
          - disconnected
        reauthorization_reason:
          type:
          - string
          - 'null'
        calendars:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              access_role:
                type:
                - string
                - 'null'
              primary:
                type: boolean
              timezone:
                type:
                - string
                - 'null'
              availability_readable:
                type: boolean
              writable:
                type: boolean
              selected:
                type: boolean
              availability_source_active:
                type: boolean
              sync:
                type: object
                properties:
                  status:
                    type:
                    - string
                    - 'null'
                    enum:
                    - pending
                    - syncing
                    - current
                    - stale
                    - partial
                    - unavailable
                    - null
                  last_attempted_at:
                    type:
                    - string
                    - 'null'
                    format: date-time
                  last_successful_sync_at:
                    type:
                    - string
                    - 'null'
                    format: date-time
                  last_error_category:
                    type:
                    - string
                    - 'null'
                required:
                - status
                - last_attempted_at
                - last_successful_sync_at
                - last_error_category
            required:
            - id
            - name
            - access_role
            - primary
            - timezone
            - availability_readable
            - writable
            - selected
            - availability_source_active
            - sync
      required:
      - id
      - provider
      - account_label
      - status
      - reauthorization_reason
      - calendars
    CalendarConnectionMutation:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
          enum:
          - active
          - paused
          - reauthorization_required
          - disconnected
      required:
      - id
      - status
    ExternalCalendar:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        access_role:
          type:
          - string
          - 'null'
        primary:
          type: boolean
        timezone:
          type:
          - string
          - 'null'
        availability_readable:
          type: boolean
        writable:
          type: boolean
        selected:
          type: boolean
        availability_source_active:
          type: boolean
        sync:
          type: object
          properties:
            status:
              type:
              - string
              - 'null'
              enum:
              - pending
              - syncing
              - current
              - stale
              - partial
              - unavailable
              - null
            last_attempted_at:
              type:
              - string
              - 'null'
              format: date-time
            last_successful_sync_at:
              type:
              - string
              - 'null'
              format: date-time
            last_error_category:
              type:
              - string
              - 'null'
          required:
          - status
          - last_attempted_at
          - last_successful_sync_at
          - last_error_category
      required:
      - id
      - name
      - access_role
      - primary
      - timezone
      - availability_readable
      - writable
      - selected
      - availability_source_active
      - sync
    CalendarConnectionOAuthStart:
      type: object
      properties:
        authorization_url:
          type: string
          format: uri
      required:
      - authorization_url
    CalendarConnectionSummary:
      type: object
      properties:
        id:
          type: string
        provider:
          type: string
          enum:
          - google
          - microsoft
        account_label:
          type:
          - string
          - 'null'
        capabilities:
          type: array
          items:
            type: string
            enum:
            - availability
            - publishing
          minItems: 1
          maxItems: 2
          default:
          - availability
          description: Connection capabilities. "availability" reads free/busy to compute agent availability. "publishing" (writing confirmed Chronary events to the external calendar) is supported for Microsoft Outlook only — Google connections are availability-only and reject the "publishing" capability.
        status:
          type: string
          enum:
          - active
          - paused
          - reauthorization_required
          - disconnected
        reauthorization_reason:
          type:
          - string
          - 'null'
        selected_calendar_count:
          type: integer
          minimum: 0
        last_authenticated_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
      required:
      - id
      - provider
      - account_label
      - status
      - reauthorization_reason
      - selected_calendar_count
      - last_authenticated_at
      - created_at
    CalendarConnectionRefresh:
      type: object
      properties:
        status:
          type: string
          enum:
          - current
          - partial
        synced_calendars:
          type: integer
          minimum: 0
      required:
      - status
      - synced_calendars
    CalendarConnectionList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CalendarConnectionSummary'
      required:
      - data
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              example: invalid_request
            message:
              type: string
              example: The field "name" is required.
            request_id:
              type: string
              example: req_01H9X4M2P5R8T6V0
            required_plan:
              type: string
              example: pro
              description: 'plan_required: the plan that unlocks the feature'
            feature:
              type: string
              description: 'plan_required: the gated feature'
            metric:
              type: string
              description: 'quota_exceeded and count caps: the metric at its limit (a PLAN_LIMITS key, accepted by POST /v1/billing/upgrade-requests)'
            limit:
              type: integer
              description: 'quota_exceeded and count caps: the plan''s limit for `metric`'
            upgrade_url:
              type: string
              description: Where a human upgrades the plan
            docs_url:
              type: string
            contact_url:
              type: string
              description: 'Contract-managed plans: where to contact sales'
            retry_after:
              type: integer
              description: Seconds until the request may be retried
          required:
          - type
          - message
          - request_id
      required:
      - error
    ExternalCalendarList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ExternalCalendar'
      required:
      - data
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'API key with `chr_sk_*` for org-level access or `chr_ak_*` for agent-scoped access. Pass in the Authorization header: `Authorization: Bearer chr_sk_...`'
    SessionAuth:
      type: apiKey
      in: cookie
      name: chronary_session
      description: Console session JWT (HS256), issued by sign-in and sent as the `chronary_session` cookie (a Bearer JWT is also accepted). This is NOT a chr_sk_*/chr_ak_* API key — API keys are rejected with 401 on these endpoints.
x-agent-self-signup:
  url: https://api.chronary.ai/v1/agent/sign-up
  verify_url: https://api.chronary.ai/v1/agent/verify
  restricted_key_returned: true
  human_in_the_loop: otp_email
  rate_limit: 5 requests per 60s per client IP
x-agent-bootstrap-script:
  npx: npx @chronary/agent-init@latest
  shell: https://chronary.ai/agent-init.sh
  description: One-liner that performs sign-up, prompts for OTP, verifies, and creates a smoke calendar. Accepts CHRONARY_EMAIL and CHRONARY_OTP env vars for non-interactive flows.
x-llms-txt: https://docs.chronary.ai/llms.txt
x-llms-full-txt: https://docs.chronary.ai/llms-full.txt
x-mcp-server-card: https://chronary.ai/.well-known/mcp/server-card.json
x-api-catalog: https://chronary.ai/.well-known/api-catalog