---
updatedAt: 2026-07-06T09:03:13.000Z
agentTools:
  projectIndex: https://docs.callr.com/llms.txt
---

# Update recordings

Update recordings in bulk. You may update the `read` status of your recordings by
specifying the `sid` of the recording(s) you want to update. To update all of your
recordings, do not specify any `sid`.

**Warning: if you don't specify any `sid`, ALL your recordings are updated.**


# OpenAPI definition

```json
{
  "openapi": "3.1.1",
  "info": {
    "title": "Callr REST API v2.0",
    "summary": "The voice API your business runs on - Voice, SMS, and AI on Callr's own carrier network",
    "description": "The Callr REST API gives you programmatic control over the only API-first voice\nplatform that owns its carrier network. Build voice and SMS into your product -\nwithout becoming a telco - across 220+ countries.\n\nWith the Callr REST API, you can:\n- Make, receive, and control phone calls and SMS with standard HTTP requests\n- Search, buy, and manage phone numbers worldwide\n- Automate call flows with Callr Actions - a declarative, YAML-based framework\n  inspired by GitHub Actions: IVRs, routing, AI Voice Agents, and more\n- Record and transcribe calls, and turn every conversation into structured data:\n  transcripts, AI summaries, sentiment, and intent - defined in your prompts, not ours\n- Bring your own AI model - GPT, Claude, Mistral, Llama, or your in-house stack\n- Receive real-time webhooks for calls, SMS, numbers, billing, and more\n- Push conversation data into your CRM, BI, or analytics stack\n\nEverything runs serverless on carrier-grade infrastructure - owned, not resold -\nhandling millions of calls a day, with your choice of EU or US jurisdiction for\ndata sovereignty.",
    "version": "2.1.3-rc.2",
    "contact": {
      "name": "Callr Support",
      "email": "support@callr.com"
    },
    "license": {
      "name": "Proprietary",
      "url": "https://www.callr.com/terms/"
    }
  },
  "servers": [
    {
      "url": "https://api.callr.com/v2.0",
      "description": "Production"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    },
    {
      "BasicAuth": []
    }
  ],
  "tags": [
    {
      "name": "Recordings",
      "description": "Manage call recordings"
    }
  ],
  "externalDocs": {
    "description": "Callr Docs",
    "url": "https://docs.callr.com/"
  },
  "paths": {
    "/recordings": {
      "patch": {
        "tags": [
          "Recordings"
        ],
        "summary": "Update recordings",
        "description": "Update recordings in bulk. You may update the `read` status of your recordings by\nspecifying the `sid` of the recording(s) you want to update. To update all of your\nrecordings, do not specify any `sid`.\n\n**Warning: if you don't specify any `sid`, ALL your recordings are updated.**\n",
        "operationId": "RecordingsUpdateBulk",
        "parameters": [
          {
            "in": "query",
            "name": "sid",
            "description": "SIDs of the recordings to update (up to 100). If omitted, all recordings are updated.",
            "schema": {
              "type": "array",
              "maxItems": 100,
              "items": {
                "$ref": "#/components/schemas/SID"
              }
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RecordingUpdate"
              },
              "examples": {
                "Example": {
                  "value": {
                    "read": true
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Updating recordings (Task ID in response)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TaskID"
                },
                "examples": {
                  "Example": {
                    "value": "a03317926755435980GH47RdeJZMTv96"
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/401Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/403Forbidden"
          },
          "405": {
            "$ref": "#/components/responses/405MethodNotAllowed"
          },
          "429": {
            "$ref": "#/components/responses/429TooManyRequests"
          },
          "500": {
            "$ref": "#/components/responses/500InternalServerError"
          }
        }
      }
    }
  },
  "webhooks": {
    "v2.billing.credit.topup": {
      "post": {
        "operationId": "billingCreditTopupWebhook",
        "summary": "Prepaid account credited",
        "description": "Your prepaid account has been credited",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.billing.credit.topup"
                      }
                    }
                  },
                  {
                    "$ref": "#/components/schemas/WebhookPayloadCredit"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.billing.credit.warning": {
      "post": {
        "operationId": "billingCreditWarningWebhook",
        "summary": "Prepaid credit warning reached",
        "description": "Your prepaid account has reached the warning threshold. Please top up your account to avoid service interruption.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.billing.credit.warning"
                      }
                    }
                  },
                  {
                    "$ref": "#/components/schemas/WebhookPayloadCredit"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.billing.credit.shutdown": {
      "post": {
        "operationId": "billingCreditShutdownWebhook",
        "summary": "Prepaid credit shutdown reached",
        "description": "Your prepaid account has reached the shutdown threshold. Your account is currently disabled. Please top up your account to re-enable it.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.billing.credit.shutdown"
                      }
                    }
                  },
                  {
                    "$ref": "#/components/schemas/WebhookPayloadCredit"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.call.inbound.started": {
      "post": {
        "operationId": "callInboundStartedWebhook",
        "summary": "Inbound call started",
        "description": "An inbound call has started. An inbound call is a call to a Callr hosted phone number.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.call.inbound.started"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "payload"
                    ],
                    "properties": {
                      "payload": {
                        "$ref": "#/components/schemas/CDR"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.call.inbound.ended": {
      "post": {
        "operationId": "callInboundEndedWebhook",
        "summary": "Inbound call ended",
        "description": "An inbound call has hung up\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.call.inbound.ended"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "payload"
                    ],
                    "properties": {
                      "payload": {
                        "$ref": "#/components/schemas/CDR"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.call.outbound.started": {
      "post": {
        "operationId": "callOutboundStartedWebhook",
        "summary": "Outbound call started",
        "description": "An outbound call has started. An outbound call is a call initiated from the Callr platform to an external phone number.\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.call.outbound.started"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "readOnly": true,
                    "required": [
                      "payload"
                    ],
                    "properties": {
                      "payload": {
                        "$ref": "#/components/schemas/CDR"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.call.outbound.ended": {
      "post": {
        "operationId": "callOutboundEndedWebhook",
        "summary": "Outbound call ended",
        "description": "An outbound call has hung up\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.call.outbound.ended"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "payload"
                    ],
                    "properties": {
                      "payload": {
                        "$ref": "#/components/schemas/CDR"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.number.assigned": {
      "post": {
        "operationId": "numberAssignedWebhook",
        "summary": "Phone number assigned",
        "description": "A phone number was assigned to your account\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.number.assigned"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "payload"
                    ],
                    "properties": {
                      "payload": {
                        "$ref": "#/components/schemas/NumberAssigned"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.number.unassigned": {
      "post": {
        "operationId": "numberUnassignedWebhook",
        "summary": "Phone number unassigned",
        "description": "A phone number was unassigned from your account\n",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.number.unassigned"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "payload"
                    ],
                    "properties": {
                      "payload": {
                        "$ref": "#/components/schemas/NumberAssigned"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.task.updated": {
      "post": {
        "operationId": "taskStatusWebhook",
        "summary": "Task status updated",
        "description": "The status of a task has changed (`running`, `done` or `canceled`).",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.task.updated"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "payload"
                    ],
                    "properties": {
                      "payload": {
                        "$ref": "#/components/schemas/Task"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.audio-file.updated": {
      "post": {
        "operationId": "audioFileStatusWebhook",
        "summary": "Audio File status updated",
        "description": "The status of an audio file has changed, for example when its processing is finished (`ready` or `error`).",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.audio-file.updated"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "payload"
                    ],
                    "properties": {
                      "payload": {
                        "$ref": "#/components/schemas/AudioFile"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.recording.updated": {
      "post": {
        "operationId": "recordingStatusWebhook",
        "summary": "Recording status updated",
        "description": "The status of a recording has changed, for example when it is `ready` and its transcription is available.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.recording.updated"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "payload"
                    ],
                    "properties": {
                      "payload": {
                        "$ref": "#/components/schemas/Recording"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.sms.inbound.received": {
      "post": {
        "operationId": "smsInboundReceivedWebhook",
        "summary": "Inbound SMS received",
        "description": "An SMS has been received on one of your phone numbers.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.sms.inbound.received"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "payload"
                    ],
                    "properties": {
                      "payload": {
                        "$ref": "#/components/schemas/SMS"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    },
    "v2.sms.outbound.updated": {
      "post": {
        "operationId": "smsOutboundStatusWebhook",
        "summary": "Outbound SMS status updated",
        "description": "The status of an SMS you sent has changed, for example when it is `delivered`.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "unevaluatedProperties": false,
                "allOf": [
                  {
                    "$ref": "#/components/schemas/WebhookPayloadBase"
                  },
                  {
                    "type": "object",
                    "required": [
                      "type"
                    ],
                    "properties": {
                      "type": {
                        "type": "string",
                        "const": "v2.sms.outbound.updated"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "payload"
                    ],
                    "properties": {
                      "payload": {
                        "$ref": "#/components/schemas/SMS"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "2XX": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Send your Account SID as the username, and your API Key as the password. This method allows you to authenticate with your main account but also your sub accounts. To authenticate with a sub account, use the sub account's SID as the username, and your API Key as the password. Use it to act on behalf of a sub account.\n"
      },
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key",
        "description": "**Recommended.** Send your API Key as the value of the x-api-key header. With this method, you can only authenticate with your main account.\n"
      }
    },
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "required": [
          "code",
          "message"
        ],
        "additionalProperties": false,
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code (short string identifier)"
          },
          "message": {
            "type": "string",
            "description": "Description of the error in english"
          }
        }
      },
      "SID": {
        "description": "Short ID",
        "type": "string",
        "examples": [
          "callrsid",
          "deadbeef",
          "azerty00"
        ],
        "pattern": "^[a-z0-9]{8}$",
        "maxLength": 8,
        "minLength": 8
      },
      "PhoneNumber": {
        "description": "A phone number in ITU-T E.164 format https://en.wikipedia.org/wiki/E.164, prefixed by \"+\"\n",
        "type": "string",
        "examples": [
          "+33199001234",
          "+33639984242",
          "+15551230000"
        ],
        "pattern": "^\\+[1-9][0-9]{5,32}$"
      },
      "NumberClass": {
        "description": "Number class. \"gold\" is for premium (rare) numbers, \"classic\" is for regular numbers.",
        "type": "string",
        "enum": [
          "gold",
          "classic"
        ],
        "examples": [
          "classic"
        ]
      },
      "NumberType": {
        "description": "Type of number",
        "type": "string",
        "enum": [
          "geographic",
          "mobile",
          "non-geographic",
          "personal",
          "platform",
          "sharedrevenue",
          "sms-only",
          "special",
          "tollfree",
          "verified"
        ],
        "examples": [
          "geographic",
          "non-geographic"
        ]
      },
      "Datetime": {
        "description": "RFC 3339, section 5.6",
        "type": "string",
        "format": "date-time",
        "examples": [
          "2024-04-24T17:42:28Z",
          "2024-04-24T17:42:28.000Z",
          "2024-04-24T17:42:28.12345678+00:00"
        ]
      },
      "CountryCode": {
        "description": "ISO 3166-1 alpha-2 country code",
        "type": "string",
        "pattern": "^[A-Z]{2}$",
        "examples": [
          "FR",
          "US"
        ]
      },
      "NumberAssigned": {
        "type": "object",
        "required": [
          "e164",
          "class",
          "type",
          "assigned",
          "country"
        ],
        "properties": {
          "e164": {
            "$ref": "#/components/schemas/PhoneNumber"
          },
          "class": {
            "$ref": "#/components/schemas/NumberClass"
          },
          "type": {
            "$ref": "#/components/schemas/NumberType"
          },
          "assigned": {
            "$ref": "#/components/schemas/Datetime"
          },
          "country": {
            "$ref": "#/components/schemas/CountryCode"
          }
        }
      },
      "AudioFileStatus": {
        "type": "string",
        "description": "Audio file status",
        "enum": [
          "ready",
          "processing",
          "pending-content",
          "pending-conversion",
          "error"
        ],
        "x-enumNames": [
          "AudioFileStatusReady",
          "AudioFileStatusProcessing",
          "AudioFileStatusPendingContent",
          "AudioFileStatusPendingConversion",
          "AudioFileStatusError"
        ],
        "examples": [
          "ready",
          "error"
        ]
      },
      "AudioFileSource": {
        "type": "string",
        "description": "Audio file source",
        "enum": [
          "phone-record",
          "system",
          "file-upload"
        ],
        "examples": [
          "system",
          "file-upload"
        ]
      },
      "AudioFileName": {
        "type": "string",
        "description": "Audio file name",
        "minLength": 1,
        "maxLength": 64,
        "examples": [
          "My Audio File",
          "Welcome",
          "PleaseWait"
        ]
      },
      "MediaURL": {
        "type": "string",
        "format": "uri",
        "description": "A URL to media hosted by Callr. Unlike user-submitted endpoints, this value is generated by the API and its host varies by environment (it may not resolve to a public domain, e.g. in local development).\n",
        "examples": [
          "https://media.callr.com/library/1214981-F54777F6.mp3"
        ]
      },
      "AudioFile": {
        "description": "Audio file",
        "type": "object",
        "required": [
          "sid",
          "name",
          "duration",
          "source",
          "readonly",
          "status",
          "created",
          "updated"
        ],
        "additionalProperties": false,
        "properties": {
          "sid": {
            "$ref": "#/components/schemas/SID"
          },
          "name": {
            "$ref": "#/components/schemas/AudioFileName"
          },
          "duration": {
            "type": "integer",
            "description": "Duration in seconds",
            "examples": [
              42,
              8
            ]
          },
          "source": {
            "$ref": "#/components/schemas/AudioFileSource"
          },
          "url": {
            "$ref": "#/components/schemas/MediaURL"
          },
          "readonly": {
            "type": "boolean",
            "description": "System provided files cannot be modified",
            "examples": [
              true,
              false
            ]
          },
          "status": {
            "$ref": "#/components/schemas/AudioFileStatus"
          },
          "created": {
            "$ref": "#/components/schemas/Datetime"
          },
          "updated": {
            "$ref": "#/components/schemas/Datetime"
          }
        }
      },
      "Amount": {
        "description": "Amount in cents of the currency, as a decimal string (2 to 6 decimals). Example: \"550.00\" = 5.50 EUR.\n",
        "type": "string",
        "examples": [
          "5.50",
          "1.00",
          "432.44",
          "0.0001"
        ],
        "pattern": "^[0-9]+(\\.[0-9]{2,6})?$",
        "minLength": 1
      },
      "CurrencyCode": {
        "type": "string",
        "description": "Currency code",
        "pattern": "^[A-Z]{3}$",
        "examples": [
          "EUR",
          "USD"
        ],
        "enum": [
          "EUR",
          "USD"
        ]
      },
      "CallID": {
        "description": "Call ID",
        "format": "int64",
        "type": "integer",
        "minimum": 1,
        "examples": [
          240711945874,
          210548952067
        ]
      },
      "Direction": {
        "type": "string",
        "description": "The direction. Inbound is a call or an SMS received by the Callr platform. Outbound is a call or an SMS initiated by the Callr platform.\n",
        "enum": [
          "inbound",
          "outbound"
        ],
        "examples": [
          "inbound",
          "outbound"
        ]
      },
      "TaskID": {
        "description": "Task ID",
        "type": "string",
        "examples": [
          "sampleTaskID1234567890abcdef0000"
        ],
        "pattern": "^[a-zA-Z0-9]{32,256}$",
        "maxLength": 256,
        "minLength": 32
      },
      "PaymentType": {
        "description": "Either prepaid or postpaid",
        "type": "string",
        "enum": [
          "postpaid",
          "prepaid"
        ],
        "examples": [
          "prepaid",
          "postpaid"
        ]
      },
      "RecordingType": {
        "type": "string",
        "description": "Recording type",
        "enum": [
          "call",
          "recording",
          "voicemail"
        ],
        "examples": [
          "call",
          "recording",
          "voicemail"
        ]
      },
      "CallerID": {
        "description": "Caller ID",
        "type": "object",
        "required": [
          "restricted"
        ],
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string",
            "description": "Caller ID Name"
          },
          "number": {
            "$ref": "#/components/schemas/PhoneNumber",
            "description": "Caller ID Number"
          },
          "restricted": {
            "type": "boolean",
            "description": "Whether the Caller ID is restricted"
          }
        }
      },
      "Language": {
        "type": "string",
        "description": "BCP 47 language tag",
        "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$",
        "examples": [
          "en-US",
          "es-ES",
          "fr-FR"
        ]
      },
      "RecordingOptions": {
        "description": "Recording options",
        "type": "object",
        "required": [
          "ner",
          "pii",
          "feeds",
          "language",
          "sentiment",
          "transcription"
        ],
        "additionalProperties": false,
        "properties": {
          "ner": {
            "type": "boolean",
            "description": "Whether to enable named entity recognition",
            "examples": [
              true
            ]
          },
          "pii": {
            "type": "boolean",
            "description": "Whether to enable personally identifiable information detection",
            "examples": [
              true
            ]
          },
          "feeds": {
            "type": "string",
            "description": "Feed to enable",
            "enum": [
              "leg_a",
              "leg_b",
              "all"
            ],
            "examples": [
              "all"
            ]
          },
          "language": {
            "$ref": "#/components/schemas/Language",
            "description": "Language to use for transcription"
          },
          "sentiment": {
            "type": "boolean",
            "description": "Whether to enable sentiment analysis",
            "examples": [
              true
            ]
          },
          "transcription": {
            "type": "boolean",
            "description": "Whether to enable transcription",
            "examples": [
              true
            ]
          }
        }
      },
      "RecordingTextAnalysisEntity": {
        "type": "object",
        "required": [
          "text",
          "offset",
          "category",
          "confidence"
        ],
        "additionalProperties": false,
        "properties": {
          "text": {
            "type": "string"
          },
          "offset": {
            "type": "integer"
          },
          "category": {
            "type": "string"
          },
          "confidence": {
            "type": "number",
            "format": "double"
          }
        }
      },
      "RecordingTranscriptionWord": {
        "type": "object",
        "required": [
          "word",
          "offset",
          "duration"
        ],
        "additionalProperties": false,
        "properties": {
          "word": {
            "type": "string",
            "description": "Word recognized in the audio",
            "examples": [
              "hello",
              "world"
            ]
          },
          "offset": {
            "type": "number",
            "format": "double",
            "description": "Start time of the word in seconds",
            "examples": [
              0,
              0.42
            ]
          },
          "duration": {
            "type": "number",
            "format": "double",
            "description": "Duration of the word in seconds",
            "examples": [
              0,
              0.42
            ]
          }
        }
      },
      "RecordingTranscriptionPhrase": {
        "type": "object",
        "required": [
          "offset",
          "display",
          "confidence",
          "words"
        ],
        "additionalProperties": false,
        "properties": {
          "offset": {
            "type": "number",
            "format": "double",
            "description": "Start time of the phrase in seconds",
            "minimum": 0,
            "examples": [
              0,
              10.42
            ]
          },
          "display": {
            "type": "string",
            "description": "Display representation of the transcribed text",
            "examples": [
              "Hello, world!",
              "Goodbye, world!"
            ]
          },
          "confidence": {
            "type": "number",
            "format": "double",
            "description": "Confidence score for the transcript",
            "minimum": 0,
            "maximum": 1,
            "examples": [
              0.98,
              0.8
            ]
          },
          "words": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RecordingTranscriptionWord"
            }
          }
        }
      },
      "RecordingTranscriptionFeedData": {
        "type": "object",
        "required": [
          "display",
          "language",
          "lexical",
          "phrases"
        ],
        "additionalProperties": false,
        "properties": {
          "display": {
            "type": "string",
            "description": "The display form of the recognized text. Added punctuation and capitalization are included.\n",
            "examples": [
              "Hello, world!",
              "Goodbye, world!"
            ]
          },
          "language": {
            "$ref": "#/components/schemas/Language"
          },
          "lexical": {
            "type": "string",
            "description": "Lexical representation of the transcribed text",
            "examples": [
              "hello world",
              "goodbye world"
            ]
          },
          "phrases": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RecordingTranscriptionPhrase"
            }
          }
        }
      },
      "RecordingTranscriptionSentiment": {
        "type": "object",
        "required": [
          "sentiment",
          "confidenceScores"
        ],
        "properties": {
          "sentiment": {
            "type": "string",
            "description": "Sentiment analysis",
            "examples": [
              "neutral",
              "negative",
              "positive"
            ]
          },
          "confidenceScores": {
            "type": "object",
            "description": "Confidence scores for each sentiment",
            "required": [
              "neutral",
              "negative",
              "positive"
            ],
            "additionalProperties": false,
            "properties": {
              "neutral": {
                "type": "number",
                "format": "double",
                "minimum": 0,
                "maximum": 1,
                "description": "Confidence score for neutral sentiment",
                "examples": [
                  0.98,
                  0.77
                ]
              },
              "negative": {
                "type": "number",
                "format": "double",
                "minimum": 0,
                "maximum": 1,
                "description": "Confidence score for negative sentiment",
                "examples": [
                  0.98,
                  0.77
                ]
              },
              "positive": {
                "type": "number",
                "format": "double",
                "minimum": 0,
                "maximum": 1,
                "description": "Confidence score for positive sentiment",
                "examples": [
                  0.98,
                  0.77
                ]
              }
            }
          }
        }
      },
      "RecordingTranscriptionFeed": {
        "type": "object",
        "required": [
          "data",
          "feed",
          "sentiment"
        ],
        "additionalProperties": false,
        "properties": {
          "ner": {
            "type": "array",
            "description": "Named Entity Recognized (NER)",
            "items": {
              "$ref": "#/components/schemas/RecordingTextAnalysisEntity"
            }
          },
          "pii": {
            "type": "array",
            "description": "Personally Identifiable Information (PII)",
            "items": {
              "$ref": "#/components/schemas/RecordingTextAnalysisEntity"
            }
          },
          "data": {
            "$ref": "#/components/schemas/RecordingTranscriptionFeedData"
          },
          "feed": {
            "type": "string",
            "description": "Feed name",
            "examples": [
              "leg_a",
              "leg_b"
            ]
          },
          "sentiment": {
            "$ref": "#/components/schemas/RecordingTranscriptionSentiment"
          }
        }
      },
      "RecordingTranscription": {
        "type": "object",
        "description": "The transcription of the recording.\n",
        "required": [
          "feeds"
        ],
        "additionalProperties": false,
        "properties": {
          "feeds": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RecordingTranscriptionFeed"
            }
          },
          "version": {
            "type": "string",
            "description": "The version of the transcription. This is used to determine the format of the transcription. It is not used for versioning the transcription itself.\n",
            "examples": [
              "2.0",
              "1.0"
            ]
          }
        }
      },
      "Recording": {
        "description": "Recording",
        "type": "object",
        "required": [
          "sid",
          "type",
          "callid",
          "scenario",
          "created",
          "caller",
          "callee",
          "duration",
          "read",
          "status",
          "size"
        ],
        "additionalProperties": false,
        "properties": {
          "sid": {
            "$ref": "#/components/schemas/SID"
          },
          "type": {
            "$ref": "#/components/schemas/RecordingType"
          },
          "callee": {
            "description": "Called number (E.164). Empty when the recording is not tied to one of your phone numbers, for example a recording started on an outbound call or an offline branch.\n",
            "type": "string",
            "pattern": "^(\\+[1-9][0-9]{5,32})?$",
            "x-go-type": "PhoneNumber",
            "examples": [
              "+33199001234"
            ]
          },
          "scenario": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "sid": {
                "$ref": "#/components/schemas/SID"
              },
              "name": {
                "type": "string",
                "description": "Scenario name",
                "examples": [
                  "My Call Flow",
                  "AI Voicemail"
                ]
              }
            }
          },
          "callid": {
            "description": "Call ID of the recorded call. `0` when the recording was started before any call (offline branch).",
            "type": "integer",
            "format": "int64",
            "minimum": 0,
            "x-go-type": "CallID",
            "examples": [
              240711945874
            ]
          },
          "created": {
            "$ref": "#/components/schemas/Datetime"
          },
          "readAt": {
            "$ref": "#/components/schemas/Datetime"
          },
          "duration": {
            "type": "integer",
            "description": "Call duration in seconds",
            "minimum": 0,
            "examples": [
              5
            ]
          },
          "caller": {
            "$ref": "#/components/schemas/CallerID",
            "description": "Caller"
          },
          "read": {
            "type": "boolean",
            "description": "Read status",
            "examples": [
              true
            ]
          },
          "status": {
            "type": "string",
            "description": "Recording status",
            "enum": [
              "ready",
              "processing",
              "pending",
              "error",
              "recording"
            ],
            "examples": [
              "ready",
              "error"
            ]
          },
          "url": {
            "$ref": "#/components/schemas/MediaURL",
            "description": "Recording URL, available when status is ready"
          },
          "size": {
            "type": "integer",
            "description": "Storage used in bytes",
            "minimum": 0,
            "examples": [
              123456
            ]
          },
          "options": {
            "$ref": "#/components/schemas/RecordingOptions"
          },
          "transcription": {
            "$ref": "#/components/schemas/RecordingTranscription"
          }
        }
      },
      "RecordingUpdate": {
        "description": "Recording update object",
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "read": {
            "type": "boolean",
            "description": "Read status",
            "examples": [
              true
            ]
          }
        }
      },
      "SMSSender": {
        "description": "The SMS sender. If empty, a value will be automatically set depending on the destination. Otherwise, the sender must be either a dedicated shortcode, or an alphanumeric sender (with at least one character - 11 chars maximum). Custom SMS senders must be approved by our team and downstream carriers. You can request a custom sender on https://app.callr.com.\n",
        "type": "string",
        "examples": [
          "SMS",
          "MyCompany",
          "+15551230000",
          "+33639984242"
        ],
        "oneOf": [
          {
            "type": "string",
            "pattern": "^[ a-zA-Z0-9_-]*$",
            "maxLength": 11,
            "minLength": 0
          },
          {
            "$ref": "#/components/schemas/PhoneNumber"
          }
        ]
      },
      "SMSTrafficType": {
        "description": "Traffic type of an SMS message. Carriers require this to be set to either `marketing` or `alerting`.\n",
        "type": "string",
        "enum": [
          "marketing",
          "alerting"
        ],
        "examples": [
          "marketing"
        ]
      },
      "SMSStatus": {
        "description": "The status of the SMS.\n\n`created` = The SMS has been created.\n`error` = The SMS has an error.\n`expired` = The SMS has expired.\n`failed` = The SMS has failed.\n`pending` = The SMS is waiting to be sent on our side.\n`delivered` = The SMS has been delivered to the recipient.\n`remote-queued` = The SMS is queued on the remote side.\n`sent` = The SMS has been sent.\n",
        "type": "string",
        "enum": [
          "created",
          "error",
          "expired",
          "failed",
          "pending",
          "delivered",
          "remote-queued",
          "sent"
        ],
        "examples": [
          "sent",
          "delivered"
        ]
      },
      "SMSBody": {
        "description": "SMS body",
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "text": {
            "description": "The message. Long messages are split into parts of 153 characters (GSM 03.38) or 67 characters (Unicode), up to 3200 characters.\n",
            "type": "string",
            "examples": [
              "Hello world!",
              "Bonjour !"
            ],
            "maxLength": 3200,
            "minLength": 1
          }
        },
        "required": [
          "text"
        ]
      },
      "SMSEncoding": {
        "description": "By default, we automatically detect the encoding based on the characters used in the message. If you want to force the encoding, you can use this field. The SMS body will be processed according to the encoding specified. Depending on the encoding, messages may be split into parts of 153 (GSM 03.38) or 67 (UNICODE) characters. Please note that some countries only support GSM encoding.\n",
        "type": "string",
        "enum": [
          "gsm",
          "unicode"
        ],
        "examples": [
          "gsm"
        ]
      },
      "SMSStatusHistory": {
        "description": "The status history of the message",
        "type": "object",
        "required": [
          "before",
          "after",
          "at"
        ],
        "additionalProperties": false,
        "properties": {
          "after": {
            "$ref": "#/components/schemas/SMSStatus"
          },
          "before": {
            "$ref": "#/components/schemas/SMSStatus"
          },
          "at": {
            "$ref": "#/components/schemas/Datetime"
          }
        }
      },
      "SMS": {
        "description": "SMS",
        "type": "object",
        "readOnly": true,
        "required": [
          "direction",
          "sid",
          "from",
          "to",
          "body",
          "trafficType",
          "status",
          "created",
          "updated",
          "parts",
          "encoding",
          "cost",
          "paymentType"
        ],
        "additionalProperties": false,
        "properties": {
          "direction": {
            "$ref": "#/components/schemas/Direction"
          },
          "sid": {
            "$ref": "#/components/schemas/SID"
          },
          "from": {
            "$ref": "#/components/schemas/SMSSender"
          },
          "to": {
            "$ref": "#/components/schemas/PhoneNumber"
          },
          "body": {
            "$ref": "#/components/schemas/SMSBody"
          },
          "trafficType": {
            "$ref": "#/components/schemas/SMSTrafficType"
          },
          "status": {
            "$ref": "#/components/schemas/SMSStatus"
          },
          "error": {
            "type": "string",
            "description": "An error message, when applicable"
          },
          "created": {
            "$ref": "#/components/schemas/Datetime"
          },
          "delivered": {
            "$ref": "#/components/schemas/Datetime"
          },
          "updated": {
            "$ref": "#/components/schemas/Datetime"
          },
          "sent": {
            "$ref": "#/components/schemas/Datetime"
          },
          "parts": {
            "description": "The parts of the message",
            "type": "integer",
            "examples": [
              10
            ],
            "minimum": 1,
            "maximum": 20
          },
          "network": {
            "description": "ITU-T E.212 MCC MNC network",
            "type": "string",
            "examples": [
              "20801",
              "310005"
            ]
          },
          "encoding": {
            "$ref": "#/components/schemas/SMSEncoding"
          },
          "cost": {
            "$ref": "#/components/schemas/Amount"
          },
          "paymentType": {
            "$ref": "#/components/schemas/PaymentType"
          },
          "statusHistory": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SMSStatusHistory"
            }
          }
        }
      },
      "TaskStatus": {
        "type": "string",
        "enum": [
          "pending",
          "running",
          "canceled",
          "done"
        ],
        "x-enumNames": [
          "TaskStatusPending",
          "TaskStatusRunning",
          "TaskStatusCanceled",
          "TaskStatusDone"
        ],
        "examples": [
          "pending",
          "running",
          "canceled",
          "done"
        ]
      },
      "Task": {
        "description": "Task",
        "type": "object",
        "required": [
          "id",
          "status",
          "percent"
        ],
        "additionalProperties": false,
        "properties": {
          "id": {
            "$ref": "#/components/schemas/TaskID"
          },
          "status": {
            "$ref": "#/components/schemas/TaskStatus"
          },
          "percent": {
            "description": "Progress of the task, from 0 to 100",
            "type": "number",
            "minimum": 0,
            "maximum": 100,
            "examples": [
              42,
              0.1
            ]
          },
          "ended": {
            "$ref": "#/components/schemas/Datetime"
          },
          "result": {
            "description": "The result of a `done` task, depending on the task. Calls export: `{\"filename\": \"...\", \"url\": \"...\"}`, the CSV file to download. Bulk update or delete of recordings: `{\"action\": \"read\" | \"unread\" | \"delete\", \"success\": <number of recordings>, \"errors\": [{\"sid\", \"code\", \"message\"}]}`.\n",
            "x-go-type": "json.RawMessage"
          },
          "error": {
            "description": "The error, when the task failed",
            "type": "string"
          }
        }
      },
      "WebhookType": {
        "description": "- `v2.billing.credit.topup` = Your account has been credited with a new amount.\n- `v2.billing.credit.warning` = Your prepaid balance has reached its warning level.\n- `v2.billing.credit.shutdown` = Your prepaid balance has reached its shutdown level. Your account is suspended.\n- `v2.call.inbound.started` = An inbound call just started.\n- `v2.call.inbound.ended` = An inbound call just hung up.\n- `v2.call.outbound.started` = An outbound call just started.\n- `v2.call.outbound.ended` = An outbound call just hung up.\n- `v2.number.assigned` = A phone number was assigned to your account.\n- `v2.number.unassigned` = A phone number was unassigned from your account.\n- `v2.task.updated` = A task has been updated.\n- `v2.audio-file.updated` = An audio file has been updated.\n- `v2.recording.updated` = A recording has been updated.\n- `v2.sms.inbound.received` = An inbound SMS has been received.\n- `v2.sms.outbound.updated` = An outbound SMS has an updated status.",
        "type": "string",
        "enum": [
          "v2.billing.credit.topup",
          "v2.billing.credit.warning",
          "v2.billing.credit.shutdown",
          "v2.call.inbound.started",
          "v2.call.inbound.ended",
          "v2.call.outbound.started",
          "v2.call.outbound.ended",
          "v2.number.assigned",
          "v2.number.unassigned",
          "v2.task.updated",
          "v2.audio-file.updated",
          "v2.recording.updated",
          "v2.sms.inbound.received",
          "v2.sms.outbound.updated"
        ]
      },
      "WebhookPayloadBase": {
        "type": "object",
        "readOnly": true,
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the event. Use this for idempotency checks.",
            "examples": [
              "a03317440280451052hUD7yPiwWrzgGB",
              "5f4dcc3b5aa765d61d8327deb882cf99"
            ]
          },
          "at": {
            "$ref": "#/components/schemas/Datetime",
            "description": "Timestamp of the event"
          },
          "sid": {
            "$ref": "#/components/schemas/SID",
            "description": "Unique identifier for the webhook"
          },
          "type": {
            "$ref": "#/components/schemas/WebhookType"
          },
          "try": {
            "type": "integer",
            "description": "Number of attempts made to deliver the webhook",
            "minimum": 0,
            "maximum": 10,
            "examples": [
              0
            ]
          }
        },
        "required": [
          "id",
          "at",
          "sid",
          "type",
          "try"
        ]
      },
      "WebhookPayloadCredit": {
        "type": "object",
        "readOnly": true,
        "required": [
          "payload"
        ],
        "properties": {
          "payload": {
            "description": "Payload of the webhook",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "balance",
              "currency",
              "amount",
              "shutdown",
              "warning"
            ],
            "properties": {
              "balance": {
                "$ref": "#/components/schemas/Amount"
              },
              "currency": {
                "$ref": "#/components/schemas/CurrencyCode"
              },
              "amount": {
                "$ref": "#/components/schemas/Amount",
                "description": "Last amount that triggered the webhook"
              },
              "shutdown": {
                "$ref": "#/components/schemas/Amount"
              },
              "warning": {
                "$ref": "#/components/schemas/Amount"
              }
            }
          }
        }
      },
      "CDR": {
        "type": "object",
        "required": [
          "direction",
          "callid",
          "callerName",
          "callerNumber",
          "callerRestricted",
          "callee",
          "started",
          "billingDestinationLabel",
          "billingPaymentType",
          "scenarioSid",
          "scenarioName",
          "scenarioTypeName",
          "scenarioTypeVersion"
        ],
        "additionalProperties": false,
        "properties": {
          "direction": {
            "$ref": "#/components/schemas/Direction"
          },
          "callid": {
            "$ref": "#/components/schemas/CallID"
          },
          "bridged": {
            "$ref": "#/components/schemas/CallID",
            "description": "If the call leg was bridged to another leg, its Call ID will be set here.\n"
          },
          "callerName": {
            "type": "string",
            "description": "Caller ID Name",
            "examples": [
              "John Doe",
              "Sarah Pelle",
              "Sarah Croche",
              ""
            ]
          },
          "callerNumber": {
            "description": "Caller ID number (E.164). Empty when the caller ID is hidden (`callerRestricted` is true) or was not provided.\n",
            "type": "string",
            "pattern": "^(\\+[1-9][0-9]{5,32})?$",
            "examples": [
              "+33639984242",
              ""
            ]
          },
          "callerRestricted": {
            "type": "boolean",
            "description": "Whether the Caller ID is restricted",
            "examples": [
              false,
              true
            ]
          },
          "callee": {
            "description": "Called number (E.164): your phone number for an inbound call, the dialed number for an outbound call. Empty when the call is not on one of your phone numbers.\n",
            "type": "string",
            "pattern": "^(\\+[1-9][0-9]{5,32})?$",
            "examples": [
              "+33199001234"
            ]
          },
          "started": {
            "$ref": "#/components/schemas/Datetime"
          },
          "answered": {
            "$ref": "#/components/schemas/Datetime"
          },
          "ended": {
            "$ref": "#/components/schemas/Datetime"
          },
          "status": {
            "description": "Outcome of the call, present once the call has ended: `answered` (the call was answered), `canceled` (hung up before being answered, SIP 487), `unallocated` (number not in service, SIP 404), `busy` (SIP 486), `failed` (any other reason).\n",
            "type": "string",
            "enum": [
              "dialing",
              "ringing",
              "answered",
              "failed",
              "busy",
              "unallocated",
              "canceled"
            ],
            "examples": [
              "answered",
              "busy"
            ]
          },
          "hangupSource": {
            "description": "Who hung up the call (`system` = the Callr platform). Present once the call has ended.",
            "type": "string",
            "enum": [
              "caller",
              "callee",
              "system"
            ]
          },
          "hangupCause": {
            "description": "Q.850 cause code",
            "type": "integer",
            "minimum": 0,
            "maximum": 127,
            "examples": [
              16,
              17
            ]
          },
          "hangupTech": {
            "type": "string",
            "description": "Technology specific hangup cause",
            "examples": [
              "sip:200",
              "sip:486"
            ]
          },
          "durationTotal": {
            "description": "Total duration of the call, ringing included, in seconds. Present once the call has ended.",
            "type": "integer",
            "minimum": 0,
            "examples": [
              42
            ]
          },
          "durationAnswered": {
            "description": "Duration of the call after it was answered, in seconds. Present once the call has ended.",
            "type": "integer",
            "minimum": 0,
            "examples": [
              40
            ]
          },
          "durationBilled": {
            "description": "Billed duration, in seconds, after applying the minimum billed duration and the billing step. Present once the call has ended.\n",
            "type": "integer",
            "minimum": 0,
            "examples": [
              60
            ]
          },
          "billingDestinationLabel": {
            "type": "string",
            "examples": [
              "France - Geographic",
              "France - Mobile"
            ]
          },
          "billingDestinationID": {
            "type": "integer",
            "minimum": 0
          },
          "billingDebit": {
            "$ref": "#/components/schemas/Amount",
            "description": "Amount debited for the call, in cents. Present once the call has ended."
          },
          "billingCredit": {
            "$ref": "#/components/schemas/Amount",
            "description": "Amount credited for the call, in cents. Present once the call has ended."
          },
          "billingPaymentType": {
            "$ref": "#/components/schemas/PaymentType"
          },
          "scenarioSid": {
            "$ref": "#/components/schemas/SID"
          },
          "scenarioName": {
            "type": "string",
            "examples": [
              "My Call Flow",
              "AI Voicemail",
              "Call Forwarding"
            ]
          },
          "scenarioTypeName": {
            "type": "string",
            "examples": [
              "Actions"
            ]
          },
          "scenarioTypeVersion": {
            "type": "string",
            "examples": [
              "1.0"
            ]
          }
        }
      }
    },
    "responses": {
      "400BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "ValueError": {
                "value": {
                  "code": "value_error",
                  "message": "Invalid value: to"
                }
              }
            }
          }
        }
      },
      "401Unauthorized": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "AuthError": {
                "value": {
                  "code": "auth_error",
                  "message": "Authentication failed"
                }
              }
            }
          }
        }
      },
      "403Forbidden": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "Forbidden": {
                "value": {
                  "code": "forbidden",
                  "message": "This feature is not allowed for your account"
                }
              }
            }
          }
        }
      },
      "405MethodNotAllowed": {
        "description": "Method Not Allowed",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "MethodNotAllowed": {
                "value": {
                  "code": "http_error",
                  "message": "Method Not Allowed"
                }
              }
            }
          }
        }
      },
      "429TooManyRequests": {
        "description": "Too Many Requests (rate limit exceeded)",
        "headers": {
          "Retry-After": {
            "description": "Number of seconds to wait before retrying",
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          }
        },
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "RateLimit": {
                "value": {
                  "code": "http_error",
                  "message": "Rate limit exceeded (11/10)"
                }
              }
            }
          }
        }
      },
      "500InternalServerError": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "InternalError": {
                "value": {
                  "code": "internal_error",
                  "message": "Internal Server Error"
                }
              }
            }
          }
        }
      }
    }
  }
}
```