Set account defaults

PATCH /v1/me/settings

Sets the account defaults every key of the account resolves against. Send only the fields you are changing; an omitted field keeps the value it has. Resolution order for every transcript request is the explicit parameter, then these settings, then the platform default, so a default never overrides a parameter the caller sent. Defaults live on the account, never on a key: two keys of one account answer the same request the same way. The response echoes the resolved settings.

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "transcripts": {
            "type": "object",
            "properties": {
              "quality": {
                "type": "string",
                "enum": [
                  "captions",
                  "premium"
                ],
                "description": "Default transcript quality for this account: captions or premium. As a default, premium reads only transcripts the account already owns. Owned transcripts remain readable after a plan downgrade; starting new ones requires an eligible plan."
              },
              "language": {
                "type": "string",
                "description": "Default comma-separated caption language priority list, tried in order (e.g. \"de,en\"), at most 5 codes. Use asr for the first automatic track and asr-<code> for a specific one."
              },
              "timestamps": {
                "type": "boolean",
                "description": "Default for the timestamps parameter. false makes paragraphs[] the default body shape instead of lines[]."
              }
            },
            "description": "Fields to change. An omitted field keeps the value the account already carries."
          }
        },
        "required": [
          "transcripts"
        ]
      }
    }
  }
}

Responses

{
  "description": "Settings updated",
  "headers": {
    "X-Request-Id": {
      "$ref": "#/components/headers/X-Request-Id"
    },
    "X-Arcmira-Version": {
      "$ref": "#/components/headers/X-Arcmira-Version"
    },
    "RateLimit-Limit": {
      "$ref": "#/components/headers/RateLimit-Limit"
    },
    "RateLimit-Remaining": {
      "$ref": "#/components/headers/RateLimit-Remaining"
    },
    "RateLimit-Reset": {
      "$ref": "#/components/headers/RateLimit-Reset"
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/MeSettingsResponse"
      }
    }
  }
}

{
  "$ref": "#/components/responses/InvalidRequest"
}

{
  "$ref": "#/components/responses/AuthenticationError"
}

{
  "$ref": "#/components/responses/PermissionError"
}

{
  "$ref": "#/components/responses/NotFound"
}

{
  "$ref": "#/components/responses/RateLimited"
}

{
  "$ref": "#/components/responses/ServerError"
}

Operation definition

{
  "tags": [
    "Meta"
  ],
  "operationId": "update_my_settings",
  "summary": "Set account defaults",
  "description": "Sets the account defaults every key of the account resolves against. Send only the fields you are changing; an omitted field keeps the value it has. Resolution order for every transcript request is the explicit parameter, then these settings, then the platform default, so a default never overrides a parameter the caller sent. Defaults live on the account, never on a key: two keys of one account answer the same request the same way. The response echoes the resolved settings.",
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "transcripts": {
              "type": "object",
              "properties": {
                "quality": {
                  "type": "string",
                  "enum": [
                    "captions",
                    "premium"
                  ],
                  "description": "Default transcript quality for this account: captions or premium. As a default, premium reads only transcripts the account already owns. Owned transcripts remain readable after a plan downgrade; starting new ones requires an eligible plan."
                },
                "language": {
                  "type": "string",
                  "description": "Default comma-separated caption language priority list, tried in order (e.g. \"de,en\"), at most 5 codes. Use asr for the first automatic track and asr-<code> for a specific one."
                },
                "timestamps": {
                  "type": "boolean",
                  "description": "Default for the timestamps parameter. false makes paragraphs[] the default body shape instead of lines[]."
                }
              },
              "description": "Fields to change. An omitted field keeps the value the account already carries."
            }
          },
          "required": [
            "transcripts"
          ]
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Settings updated",
      "headers": {
        "X-Request-Id": {
          "$ref": "#/components/headers/X-Request-Id"
        },
        "X-Arcmira-Version": {
          "$ref": "#/components/headers/X-Arcmira-Version"
        },
        "RateLimit-Limit": {
          "$ref": "#/components/headers/RateLimit-Limit"
        },
        "RateLimit-Remaining": {
          "$ref": "#/components/headers/RateLimit-Remaining"
        },
        "RateLimit-Reset": {
          "$ref": "#/components/headers/RateLimit-Reset"
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MeSettingsResponse"
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/InvalidRequest"
    },
    "401": {
      "$ref": "#/components/responses/AuthenticationError"
    },
    "403": {
      "$ref": "#/components/responses/PermissionError"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/ServerError"
    }
  }
}