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

# Create a commitment

> Creates a commitment (hold, deposit, or handoff) on a quote. Requires
the `commitments:write` scope. Only available in the Live environment.




## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/accounts/{id}/quotes/{quoteId}/commitment
openapi: 3.1.0
info:
  title: Kordless API
  version: 1.0.0
  description: |
    The Kordless API gives you programmatic access to the same verified Book,
    evaluator, and commitment mechanics that the workspace uses.

    ## Authentication

    All requests require a bearer token in the `Authorization` header:

    ```
    Authorization: Bearer sk_test_...
    ```

    Test keys use the `sk_test_` prefix; Live keys use `sk_live_`. The
    environment is encoded in the prefix — a Test key can never address Live
    data.

    ## Idempotency

    Write operations that create or mutate state require an `Idempotency-Key`
    header (up to 200 characters) so retries replay instead of duplicating.

    ## Rate limiting

    Requests are rate-limited per account and environment. The default limit is
    600 requests per minute. Responses include `ratelimit-limit`,
    `ratelimit-remaining`, and `ratelimit-reset` headers.

    ## Request IDs

    Every response includes an `x-request-id` header. Use this ID to find the
    request in the logs or when contacting support.
servers:
  - url: https://your-kordless-instance.com
    description: Replace with your Kordless instance base URL
security:
  - BearerAuth: []
tags:
  - name: Accounts
    description: List and retrieve account targets.
  - name: Quote spec
    description: Read the published Book specification.
  - name: Quote simulations
    description: Run non-persistent price simulations.
  - name: Quotes
    description: Produce formal, persisted quotes.
  - name: Commitments
    description: Create and confirm commitments on quotes.
  - name: Request logs
    description: Inspect API request history.
paths:
  /v1/accounts/{id}/quotes/{quoteId}/commitment:
    post:
      tags:
        - Commitments
      summary: Create a commitment
      description: |
        Creates a commitment (hold, deposit, or handoff) on a quote. Requires
        the `commitments:write` scope. Only available in the Live environment.
      operationId: createCommitment
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The account ID.
        - name: quoteId
          in: path
          required: true
          schema:
            type: string
          description: The quote ID.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                hold_hours:
                  type: number
                  description: Optional hold duration in hours.
                deposit_amount_cents:
                  type: integer
                  description: Optional deposit amount in cents.
                external_ref:
                  type: string
                  description: Optional external reference for the commitment.
      responses:
        '200':
          description: The commitment (already existed).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Commitment'
        '201':
          description: The commitment was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Commitment'
        '400':
          $ref: '#/components/responses/InvalidRequest'
components:
  schemas:
    Commitment:
      type: object
      properties:
        object:
          type: string
          enum:
            - commitment
        commitment_id:
          type: string
        created:
          type: boolean
          description: Whether a new commitment was created (false if it already existed).
        state:
          type: string
          description: The commitment's state.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request
                - authentication_error
                - permission_error
                - not_found
                - idempotency_error
                - rate_limit_error
                - api_error
            code:
              type: string
              description: A stable, machine-readable error code.
            message:
              type: string
              description: A human-readable explanation.
            param:
              type: string
              description: The request parameter that caused the error, when applicable.
            request_id:
              type: string
              description: The unique request identifier.
  responses:
    InvalidRequest:
      description: The request was invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass your API key as a bearer token. Test keys start with `sk_test_`;
        Live keys start with `sk_live_`.

````