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

# Reserve Note GUID

> Reserve a note GUID for later use in note creation. This allows you to:
- Get a GUID before actually creating the note
- Use the reserved GUID when creating a note with POST /v1/notes (internal API)
- Reservation expires after 1 hour if not used

**Use case**: When you need to know the note GUID before the note content is ready,
such as setting up webhooks or references in advance.




## OpenAPI

````yaml /openapi.yaml post /v1/external/notes/guids
openapi: 3.1.0
info:
  title: Tiro API
  description: AI-powered note-taking and voice file processing API
  version: 1.0.0
  contact:
    name: Tiro Support
    email: support@tiro.ooo
    url: https://tiro.ooo
servers:
  - url: https://api.tiro.ooo
    description: Production server
security:
  - BearerAuth: []
tags:
  - name: Note
    description: Operations for managing notes and their paragraphs
  - name: Note Share Link
    description: Manage share links for notes
  - name: Note Summary
    description: Operations for retrieving note summaries
  - name: Note Document
    description: Template-based document generation from notes
  - name: Note Document Template
    description: Operations for managing note document templates
  - name: Folder
    description: Operations for retrieving folders
  - name: Voice File
    description: Operations for voice file processing
  - name: Word Memory
    description: >
      Manage word memories to improve voice transcription accuracy. Register
      important terms like company names, people's names, and product names so
      Tiro recognizes them precisely during recording. Personal word memories
      (User) and a workspace's shared word memories (Workspace) are managed
      separately. The legacy team word memory endpoints
      (`/v1/external/teams/me/word-memories`) are deprecated — removed on
      2026-06-30 — in favor of the workspace-explicit
      `/v1/external/workspaces/{workspaceGuid}/word-memories`.
  - name: Wiki
    description: |
      Access workspace wikis — unified knowledge graphs built from notes.
      Requires a workspace with wiki plan and activation enabled.
  - name: Organization
    description: >
      Endpoints for organization API keys. An organization key is issued by an

      organization admin, carries fixed scopes chosen at issuance, and can reach

      the notes in every workspace that belongs to the organization. Built for

      server-to-server integrations such as CRM sync — receive `note.ended`
      webhook

      events, generate documents for notes, and reconcile with the organization

      notes list.
  - name: Organization Management
    description: Operations for the authenticated user's organization.
paths:
  /v1/external/notes/guids:
    post:
      tags:
        - Note
      summary: Reserve Note GUID
      description: >
        Reserve a note GUID for later use in note creation. This allows you to:

        - Get a GUID before actually creating the note

        - Use the reserved GUID when creating a note with POST /v1/notes
        (internal API)

        - Reservation expires after 1 hour if not used


        **Use case**: When you need to know the note GUID before the note
        content is ready,

        such as setting up webhooks or references in advance.
      operationId: reserveNoteGuid
      requestBody:
        description: Optional parameters for the note reservation
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoteReservationRequest'
            example:
              title: Weekly Team Standup
      responses:
        '201':
          description: Note GUID successfully reserved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoteReservationResponse'
              example:
                guid: x6DjzdpXqkEcU
                title: Weekly Team Standup
                expiresAt: '2024-01-15T11:30:00Z'
                createdAt: '2024-01-15T10:30:00Z'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: 401001
                  errorType: unauthorized
                  message: API key authentication required
                  detail: null
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    NoteReservationRequest:
      type: object
      properties:
        title:
          type: string
          description: If provided, sets the title for the note to be created.
          example: Weekly Team Standup
          maxLength: 100
    NoteReservationResponse:
      type: object
      required:
        - guid
        - expiresAt
        - createdAt
      properties:
        guid:
          type: string
          description: Reserved note GUID that can be used for note creation
          example: x6DjzdpXqkEcU
        title:
          type: string
          nullable: true
          description: Title of the note if provided during reservation
          example: Weekly Team Standup
        expiresAt:
          type: string
          format: date-time
          description: >-
            ISO-8601 timestamp when the reservation expires (1 hour from
            creation)
          example: '2024-01-15T11:30:00Z'
        createdAt:
          type: string
          format: date-time
          description: ISO-8601 timestamp when the reservation was created
          example: '2024-01-15T10:30:00Z'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - errorType
            - message
          properties:
            code:
              type: integer
              description: >
                6-digit error code in `AAABBB` form: first 3 digits match the
                HTTP status,

                last 3 digits are a per-status serial (e.g. `404018`). Use only
                when you need

                to distinguish specific error cases within the same HTTP status
                — values may be

                added or renumbered across releases. For general client
                branching, prefer `errorType`.
              example: 404018
            errorType:
              type: string
              description: >
                Stable, coarse-grained error category. Recommended default for
                client-side

                branching: the value-to-status mapping is part of the API
                contract and will not

                change without a breaking-change notice. Typical use:
                  - `unauthorized` → trigger re-authentication
                  - `forbidden` → surface a permission error to the user
                  - `not_found` → treat as missing resource
                  - `too_many_requests` → back off and retry
                  - `internal_error` → retry with exponential backoff
              enum:
                - bad_request
                - unauthorized
                - forbidden
                - not_found
                - not_acceptable
                - conflict
                - payload_too_large
                - unprocessable_entity
                - too_many_requests
                - internal_error
              example: not_found
            message:
              type: string
              description: >-
                Human-readable error message. Not stable; do not use for
                branching.
              example: 'No team found for user #217'
            detail:
              type: string
              nullable: true
              description: Additional error details
              example: null
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key in format {id}.{secret}

````