diff --git a/src/libs/Speechify/Generated/Speechify.AgentClient.ListTTSModels.g.cs b/src/libs/Speechify/Generated/Speechify.AgentClient.ListTTSModels.g.cs index 4b33ff9..bfaae85 100644 --- a/src/libs/Speechify/Generated/Speechify.AgentClient.ListTTSModels.g.cs +++ b/src/libs/Speechify/Generated/Speechify.AgentClient.ListTTSModels.g.cs @@ -54,14 +54,12 @@ partial void ProcessListTTSModelsResponseContent( /// - `english_only` - the model has no multilingual deployment, so an
/// agent that declares `additional_languages` (or whose `language` is
/// not English) cannot select it.
- /// - `requires_voice_curation` - a voice must be registered for the
- /// model before it can be selected with that voice. The voice's
- /// `models` array on GET /v1/agents/voices is the per-voice answer,
- /// and it changes as voices are curated, with no release here. It is
- /// false for a model offered across the catalog, which every Speechify
- /// voice can then select.
- /// Drive a model picker from this and the voice catalog together and it
- /// can only offer combinations POST/PATCH /v1/agents will accept.
+ /// - `requires_voice_curation` - deprecated and always false. No model
+ /// asks a voice for a registration: every training conditions on the
+ /// voice's own prompt audio, so every model is selectable on every
+ /// voice we speak ourselves, cloned voices included.
+ /// Drive a model picker from this and the agent's languages and it can
+ /// only offer combinations POST/PATCH /v1/agents will accept.
/// Returns the full set in one response: bounded by the platform's
/// curated model catalog, so it is intentionally not paginated. /// @@ -95,14 +93,12 @@ partial void ProcessListTTSModelsResponseContent( /// - `english_only` - the model has no multilingual deployment, so an
/// agent that declares `additional_languages` (or whose `language` is
/// not English) cannot select it.
- /// - `requires_voice_curation` - a voice must be registered for the
- /// model before it can be selected with that voice. The voice's
- /// `models` array on GET /v1/agents/voices is the per-voice answer,
- /// and it changes as voices are curated, with no release here. It is
- /// false for a model offered across the catalog, which every Speechify
- /// voice can then select.
- /// Drive a model picker from this and the voice catalog together and it
- /// can only offer combinations POST/PATCH /v1/agents will accept.
+ /// - `requires_voice_curation` - deprecated and always false. No model
+ /// asks a voice for a registration: every training conditions on the
+ /// voice's own prompt audio, so every model is selectable on every
+ /// voice we speak ourselves, cloned voices included.
+ /// Drive a model picker from this and the agent's languages and it can
+ /// only offer combinations POST/PATCH /v1/agents will accept.
/// Returns the full set in one response: bounded by the platform's
/// curated model catalog, so it is intentionally not paginated. /// diff --git a/src/libs/Speechify/Generated/Speechify.IAgentClient.ListTTSModels.g.cs b/src/libs/Speechify/Generated/Speechify.IAgentClient.ListTTSModels.g.cs index 1d00b62..bbb6d50 100644 --- a/src/libs/Speechify/Generated/Speechify.IAgentClient.ListTTSModels.g.cs +++ b/src/libs/Speechify/Generated/Speechify.IAgentClient.ListTTSModels.g.cs @@ -17,14 +17,12 @@ public partial interface IAgentClient /// - `english_only` - the model has no multilingual deployment, so an
/// agent that declares `additional_languages` (or whose `language` is
/// not English) cannot select it.
- /// - `requires_voice_curation` - a voice must be registered for the
- /// model before it can be selected with that voice. The voice's
- /// `models` array on GET /v1/agents/voices is the per-voice answer,
- /// and it changes as voices are curated, with no release here. It is
- /// false for a model offered across the catalog, which every Speechify
- /// voice can then select.
- /// Drive a model picker from this and the voice catalog together and it
- /// can only offer combinations POST/PATCH /v1/agents will accept.
+ /// - `requires_voice_curation` - deprecated and always false. No model
+ /// asks a voice for a registration: every training conditions on the
+ /// voice's own prompt audio, so every model is selectable on every
+ /// voice we speak ourselves, cloned voices included.
+ /// Drive a model picker from this and the agent's languages and it can
+ /// only offer combinations POST/PATCH /v1/agents will accept.
/// Returns the full set in one response: bounded by the platform's
/// curated model catalog, so it is intentionally not paginated. /// @@ -49,14 +47,12 @@ public partial interface IAgentClient /// - `english_only` - the model has no multilingual deployment, so an
/// agent that declares `additional_languages` (or whose `language` is
/// not English) cannot select it.
- /// - `requires_voice_curation` - a voice must be registered for the
- /// model before it can be selected with that voice. The voice's
- /// `models` array on GET /v1/agents/voices is the per-voice answer,
- /// and it changes as voices are curated, with no release here. It is
- /// false for a model offered across the catalog, which every Speechify
- /// voice can then select.
- /// Drive a model picker from this and the voice catalog together and it
- /// can only offer combinations POST/PATCH /v1/agents will accept.
+ /// - `requires_voice_curation` - deprecated and always false. No model
+ /// asks a voice for a registration: every training conditions on the
+ /// voice's own prompt audio, so every model is selectable on every
+ /// voice we speak ourselves, cloned voices included.
+ /// Drive a model picker from this and the agent's languages and it can
+ /// only offer combinations POST/PATCH /v1/agents will accept.
/// Returns the full set in one response: bounded by the platform's
/// curated model catalog, so it is intentionally not paginated. /// diff --git a/src/libs/Speechify/Generated/Speechify.ITriggersClient.Fire.g.cs b/src/libs/Speechify/Generated/Speechify.ITriggersClient.Fire.g.cs index adea28b..da858b7 100644 --- a/src/libs/Speechify/Generated/Speechify.ITriggersClient.Fire.g.cs +++ b/src/libs/Speechify/Generated/Speechify.ITriggersClient.Fire.g.cs @@ -10,10 +10,24 @@ public partial interface ITriggersClient /// one-time fire token as `Authorization: Bearer <secret>`. The JSON body
/// becomes the started run's payload variable. Supply an `Idempotency-Key`
/// (or `Speechify-Delivery-Id`) header to make a redelivery replay the
- /// original run instead of starting a second one. + /// original run instead of starting a second one.
+ /// **Reacting to something that happened, for one person.** Set the
+ /// trigger's `webhook.user_identity_source` to `fire` and send
+ /// `Speechify-User-Identity` on each POST. The run then acts for that
+ /// person - their memory, and every tool call told who it is for - so one
+ /// trigger serves every person your connector watches and you hold no
+ /// trigger id per person. Use the plain form (`user_identity_source:
+ /// trigger`) when the work is the same whoever it is for: a nightly
+ /// reconciliation, an alert fan-out, a build that finished.
+ /// **Rate.** A trigger admits 60 fires a minute, and 12 a minute for any
+ /// one person; past either the endpoint answers `429` with `Retry-After`.
+ /// A fire starts a durable run against your credit balance, so a burst is
+ /// deferred rather than fanned out. Retry the refused delivery under the
+ /// same delivery id and it runs exactly once. /// /// /// + /// /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. /// The token to cancel the operation with @@ -23,6 +37,7 @@ public partial interface ITriggersClient object request, string? speechifyVersion = default, + string? speechifyUserIdentity = default, global::Speechify.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// @@ -31,10 +46,24 @@ public partial interface ITriggersClient /// one-time fire token as `Authorization: Bearer <secret>`. The JSON body
/// becomes the started run's payload variable. Supply an `Idempotency-Key`
/// (or `Speechify-Delivery-Id`) header to make a redelivery replay the
- /// original run instead of starting a second one. + /// original run instead of starting a second one.
+ /// **Reacting to something that happened, for one person.** Set the
+ /// trigger's `webhook.user_identity_source` to `fire` and send
+ /// `Speechify-User-Identity` on each POST. The run then acts for that
+ /// person - their memory, and every tool call told who it is for - so one
+ /// trigger serves every person your connector watches and you hold no
+ /// trigger id per person. Use the plain form (`user_identity_source:
+ /// trigger`) when the work is the same whoever it is for: a nightly
+ /// reconciliation, an alert fan-out, a build that finished.
+ /// **Rate.** A trigger admits 60 fires a minute, and 12 a minute for any
+ /// one person; past either the endpoint answers `429` with `Retry-After`.
+ /// A fire starts a durable run against your credit balance, so a burst is
+ /// deferred rather than fanned out. Retry the refused delivery under the
+ /// same delivery id and it runs exactly once. /// /// /// + /// /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. /// The token to cancel the operation with @@ -44,6 +73,7 @@ public partial interface ITriggersClient object request, string? speechifyVersion = default, + string? speechifyUserIdentity = default, global::Speechify.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); /// @@ -52,16 +82,31 @@ public partial interface ITriggersClient /// one-time fire token as `Authorization: Bearer <secret>`. The JSON body
/// becomes the started run's payload variable. Supply an `Idempotency-Key`
/// (or `Speechify-Delivery-Id`) header to make a redelivery replay the
- /// original run instead of starting a second one. + /// original run instead of starting a second one.
+ /// **Reacting to something that happened, for one person.** Set the
+ /// trigger's `webhook.user_identity_source` to `fire` and send
+ /// `Speechify-User-Identity` on each POST. The run then acts for that
+ /// person - their memory, and every tool call told who it is for - so one
+ /// trigger serves every person your connector watches and you hold no
+ /// trigger id per person. Use the plain form (`user_identity_source:
+ /// trigger`) when the work is the same whoever it is for: a nightly
+ /// reconciliation, an alert fan-out, a build that finished.
+ /// **Rate.** A trigger admits 60 fires a minute, and 12 a minute for any
+ /// one person; past either the endpoint answers `429` with `Retry-After`.
+ /// A fire starts a durable run against your credit balance, so a burst is
+ /// deferred rather than fanned out. Retry the refused delivery under the
+ /// same delivery id and it runs exactly once. /// /// /// + /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. /// The token to cancel the operation with /// global::System.Threading.Tasks.Task FireAsync( string triggerId, string? speechifyVersion = default, + string? speechifyUserIdentity = default, global::Speechify.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default); } diff --git a/src/libs/Speechify/Generated/Speechify.JsonConverters.TriggerWebhookConfigUserIdentitySource.g.cs b/src/libs/Speechify/Generated/Speechify.JsonConverters.TriggerWebhookConfigUserIdentitySource.g.cs new file mode 100644 index 0000000..95bf034 --- /dev/null +++ b/src/libs/Speechify/Generated/Speechify.JsonConverters.TriggerWebhookConfigUserIdentitySource.g.cs @@ -0,0 +1,53 @@ +#nullable enable + +namespace Speechify.JsonConverters +{ + /// + public sealed class TriggerWebhookConfigUserIdentitySourceJsonConverter : global::System.Text.Json.Serialization.JsonConverter + { + /// + public override global::Speechify.TriggerWebhookConfigUserIdentitySource Read( + ref global::System.Text.Json.Utf8JsonReader reader, + global::System.Type typeToConvert, + global::System.Text.Json.JsonSerializerOptions options) + { + switch (reader.TokenType) + { + case global::System.Text.Json.JsonTokenType.String: + { + var stringValue = reader.GetString(); + if (stringValue != null) + { + return global::Speechify.TriggerWebhookConfigUserIdentitySourceExtensions.ToEnum(stringValue) ?? default; + } + + break; + } + case global::System.Text.Json.JsonTokenType.Number: + { + var numValue = reader.GetInt32(); + return (global::Speechify.TriggerWebhookConfigUserIdentitySource)numValue; + } + case global::System.Text.Json.JsonTokenType.Null: + { + return default(global::Speechify.TriggerWebhookConfigUserIdentitySource); + } + default: + throw new global::System.ArgumentOutOfRangeException(nameof(reader)); + } + + return default; + } + + /// + public override void Write( + global::System.Text.Json.Utf8JsonWriter writer, + global::Speechify.TriggerWebhookConfigUserIdentitySource value, + global::System.Text.Json.JsonSerializerOptions options) + { + writer = writer ?? throw new global::System.ArgumentNullException(nameof(writer)); + + writer.WriteStringValue(global::Speechify.TriggerWebhookConfigUserIdentitySourceExtensions.ToValueString(value)); + } + } +} diff --git a/src/libs/Speechify/Generated/Speechify.JsonConverters.TriggerWebhookConfigUserIdentitySourceNullable.g.cs b/src/libs/Speechify/Generated/Speechify.JsonConverters.TriggerWebhookConfigUserIdentitySourceNullable.g.cs new file mode 100644 index 0000000..6a625cb --- /dev/null +++ b/src/libs/Speechify/Generated/Speechify.JsonConverters.TriggerWebhookConfigUserIdentitySourceNullable.g.cs @@ -0,0 +1,60 @@ +#nullable enable + +namespace Speechify.JsonConverters +{ + /// + public sealed class TriggerWebhookConfigUserIdentitySourceNullableJsonConverter : global::System.Text.Json.Serialization.JsonConverter + { + /// + public override global::Speechify.TriggerWebhookConfigUserIdentitySource? Read( + ref global::System.Text.Json.Utf8JsonReader reader, + global::System.Type typeToConvert, + global::System.Text.Json.JsonSerializerOptions options) + { + switch (reader.TokenType) + { + case global::System.Text.Json.JsonTokenType.String: + { + var stringValue = reader.GetString(); + if (stringValue != null) + { + return global::Speechify.TriggerWebhookConfigUserIdentitySourceExtensions.ToEnum(stringValue); + } + + break; + } + case global::System.Text.Json.JsonTokenType.Number: + { + var numValue = reader.GetInt32(); + return (global::Speechify.TriggerWebhookConfigUserIdentitySource)numValue; + } + case global::System.Text.Json.JsonTokenType.Null: + { + return default(global::Speechify.TriggerWebhookConfigUserIdentitySource?); + } + default: + throw new global::System.ArgumentOutOfRangeException(nameof(reader)); + } + + return default; + } + + /// + public override void Write( + global::System.Text.Json.Utf8JsonWriter writer, + global::Speechify.TriggerWebhookConfigUserIdentitySource? value, + global::System.Text.Json.JsonSerializerOptions options) + { + writer = writer ?? throw new global::System.ArgumentNullException(nameof(writer)); + + if (value == null) + { + writer.WriteNullValue(); + } + else + { + writer.WriteStringValue(global::Speechify.TriggerWebhookConfigUserIdentitySourceExtensions.ToValueString(value.Value)); + } + } + } +} diff --git a/src/libs/Speechify/Generated/Speechify.JsonSerializerContext.g.cs b/src/libs/Speechify/Generated/Speechify.JsonSerializerContext.g.cs index 6320440..7864d6c 100644 --- a/src/libs/Speechify/Generated/Speechify.JsonSerializerContext.g.cs +++ b/src/libs/Speechify/Generated/Speechify.JsonSerializerContext.g.cs @@ -581,6 +581,7 @@ internal sealed partial class SourceGenerationContextChunk0 : global::System.Tex [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.AgentTriggerType), TypeInfoPropertyName = "AgentTriggerType2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.TriggerRunSpec))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.TriggerScheduleConfig))] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.TriggerWebhookConfigUserIdentitySource), TypeInfoPropertyName = "TriggerWebhookConfigUserIdentitySource2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.TriggerWebhookConfig))] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.AgentTriggerLastFireStatus), TypeInfoPropertyName = "AgentTriggerLastFireStatus2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.AgentTrigger))] @@ -862,6 +863,7 @@ internal sealed partial class SourceGenerationContextChunk0 : global::System.Tex [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.SIPTransport?), TypeInfoPropertyName = "NullableSIPTransport2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.SIPMediaEncryption?), TypeInfoPropertyName = "NullableSIPMediaEncryption2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.AgentTriggerType?), TypeInfoPropertyName = "NullableAgentTriggerType2")] + [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.TriggerWebhookConfigUserIdentitySource?), TypeInfoPropertyName = "NullableTriggerWebhookConfigUserIdentitySource2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.AgentTriggerLastFireStatus?), TypeInfoPropertyName = "NullableAgentTriggerLastFireStatus2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.CreateAgentTriggerRequestType?), TypeInfoPropertyName = "NullableCreateAgentTriggerRequestType2")] [global::System.Text.Json.Serialization.JsonSerializable(typeof(global::Speechify.AgentTriggerFireResponseStatus?), TypeInfoPropertyName = "NullableAgentTriggerFireResponseStatus2")] @@ -1523,6 +1525,10 @@ public override bool CanConvert(global::System.Type typeToConvert) || typeToConvert == typeof(global::Speechify.AgentTriggerType?) + || typeToConvert == typeof(global::Speechify.TriggerWebhookConfigUserIdentitySource) + + || typeToConvert == typeof(global::Speechify.TriggerWebhookConfigUserIdentitySource?) + || typeToConvert == typeof(global::Speechify.AgentTriggerLastFireStatus) || typeToConvert == typeof(global::Speechify.AgentTriggerLastFireStatus?) @@ -2742,6 +2748,16 @@ public override bool CanConvert(global::System.Type typeToConvert) return new global::Speechify.JsonConverters.AgentTriggerTypeNullableJsonConverter(); } + if (typeToConvert == typeof(global::Speechify.TriggerWebhookConfigUserIdentitySource)) + { + return new global::Speechify.JsonConverters.TriggerWebhookConfigUserIdentitySourceJsonConverter(); + } + + if (typeToConvert == typeof(global::Speechify.TriggerWebhookConfigUserIdentitySource?)) + { + return new global::Speechify.JsonConverters.TriggerWebhookConfigUserIdentitySourceNullableJsonConverter(); + } + if (typeToConvert == typeof(global::Speechify.AgentTriggerLastFireStatus)) { return new global::Speechify.JsonConverters.AgentTriggerLastFireStatusJsonConverter(); diff --git a/src/libs/Speechify/Generated/Speechify.JsonSerializerContextTypes.g.cs b/src/libs/Speechify/Generated/Speechify.JsonSerializerContextTypes.g.cs index 8f95dfb..340a62d 100644 --- a/src/libs/Speechify/Generated/Speechify.JsonSerializerContextTypes.g.cs +++ b/src/libs/Speechify/Generated/Speechify.JsonSerializerContextTypes.g.cs @@ -2241,615 +2241,619 @@ public sealed partial class JsonSerializerContextTypes /// /// /// - public global::Speechify.TriggerWebhookConfig? Type552 { get; set; } + public global::Speechify.TriggerWebhookConfigUserIdentitySource? Type552 { get; set; } /// /// /// - public global::Speechify.AgentTriggerLastFireStatus? Type553 { get; set; } + public global::Speechify.TriggerWebhookConfig? Type553 { get; set; } /// /// /// - public global::Speechify.AgentTrigger? Type554 { get; set; } + public global::Speechify.AgentTriggerLastFireStatus? Type554 { get; set; } /// /// /// - public global::Speechify.ListAgentTriggersResponse? Type555 { get; set; } + public global::Speechify.AgentTrigger? Type555 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type556 { get; set; } + public global::Speechify.ListAgentTriggersResponse? Type556 { get; set; } /// /// /// - public global::Speechify.CreateAgentTriggerRequestType? Type557 { get; set; } + public global::System.Collections.Generic.IList? Type557 { get; set; } /// /// /// - public global::Speechify.CreateAgentTriggerRequest? Type558 { get; set; } + public global::Speechify.CreateAgentTriggerRequestType? Type558 { get; set; } /// /// /// - public global::Speechify.UpdateAgentTriggerRequest? Type559 { get; set; } + public global::Speechify.CreateAgentTriggerRequest? Type559 { get; set; } /// /// /// - public global::Speechify.AgentTriggerFireResponseStatus? Type560 { get; set; } + public global::Speechify.UpdateAgentTriggerRequest? Type560 { get; set; } /// /// /// - public global::Speechify.AgentTriggerFireResponse? Type561 { get; set; } + public global::Speechify.AgentTriggerFireResponseStatus? Type561 { get; set; } /// /// /// - public global::Speechify.Skill? Type562 { get; set; } + public global::Speechify.AgentTriggerFireResponse? Type562 { get; set; } /// /// /// - public global::Speechify.ListSkillsResponse? Type563 { get; set; } + public global::Speechify.Skill? Type563 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type564 { get; set; } + public global::Speechify.ListSkillsResponse? Type564 { get; set; } /// /// /// - public global::Speechify.CreateSkillRequest? Type565 { get; set; } + public global::System.Collections.Generic.IList? Type565 { get; set; } /// /// /// - public global::Speechify.UpdateSkillRequest? Type566 { get; set; } + public global::Speechify.CreateSkillRequest? Type566 { get; set; } /// /// /// - public global::Speechify.SkillVersion? Type567 { get; set; } + public global::Speechify.UpdateSkillRequest? Type567 { get; set; } /// /// /// - public global::Speechify.ListSkillVersionsResponse? Type568 { get; set; } + public global::Speechify.SkillVersion? Type568 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type569 { get; set; } + public global::Speechify.ListSkillVersionsResponse? Type569 { get; set; } /// /// /// - public global::Speechify.AgentSkill? Type570 { get; set; } + public global::System.Collections.Generic.IList? Type570 { get; set; } /// /// /// - public global::Speechify.ListAgentSkillsResponse? Type571 { get; set; } + public global::Speechify.AgentSkill? Type571 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type572 { get; set; } + public global::Speechify.ListAgentSkillsResponse? Type572 { get; set; } /// /// /// - public global::Speechify.AttachSkillRequest? Type573 { get; set; } + public global::System.Collections.Generic.IList? Type573 { get; set; } /// /// /// - public global::Speechify.UpdateAgentSkillRequest? Type574 { get; set; } + public global::Speechify.AttachSkillRequest? Type574 { get; set; } /// /// /// - public global::Speechify.Store? Type575 { get; set; } + public global::Speechify.UpdateAgentSkillRequest? Type575 { get; set; } /// /// /// - public global::Speechify.ListStoresResponse? Type576 { get; set; } + public global::Speechify.Store? Type576 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type577 { get; set; } + public global::Speechify.ListStoresResponse? Type577 { get; set; } /// /// /// - public global::Speechify.CreateStoreRequest? Type578 { get; set; } + public global::System.Collections.Generic.IList? Type578 { get; set; } /// /// /// - public global::Speechify.UpdateStoreRequest? Type579 { get; set; } + public global::Speechify.CreateStoreRequest? Type579 { get; set; } /// /// /// - public global::Speechify.StoreCollection? Type580 { get; set; } + public global::Speechify.UpdateStoreRequest? Type580 { get; set; } /// /// /// - public global::Speechify.ListStoreCollectionsResponse? Type581 { get; set; } + public global::Speechify.StoreCollection? Type581 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type582 { get; set; } + public global::Speechify.ListStoreCollectionsResponse? Type582 { get; set; } /// /// /// - public global::Speechify.StoreDocumentSource? Type583 { get; set; } + public global::System.Collections.Generic.IList? Type583 { get; set; } /// /// /// - public global::Speechify.StoreDocument? Type584 { get; set; } + public global::Speechify.StoreDocumentSource? Type584 { get; set; } /// /// /// - public global::Speechify.QueryStoreDocumentsResponse? Type585 { get; set; } + public global::Speechify.StoreDocument? Type585 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type586 { get; set; } + public global::Speechify.QueryStoreDocumentsResponse? Type586 { get; set; } /// /// /// - public global::Speechify.WriteStoreDocumentRequest? Type587 { get; set; } + public global::System.Collections.Generic.IList? Type587 { get; set; } /// /// /// - public global::Speechify.StoreWhereClauseOp? Type588 { get; set; } + public global::Speechify.WriteStoreDocumentRequest? Type588 { get; set; } /// /// /// - public global::Speechify.StoreWhereClause? Type589 { get; set; } + public global::Speechify.StoreWhereClauseOp? Type589 { get; set; } /// /// /// - public global::Speechify.StoreOrderByDirection? Type590 { get; set; } + public global::Speechify.StoreWhereClause? Type590 { get; set; } /// /// /// - public global::Speechify.StoreOrderBy? Type591 { get; set; } + public global::Speechify.StoreOrderByDirection? Type591 { get; set; } /// /// /// - public global::Speechify.StoreDocumentQuery? Type592 { get; set; } + public global::Speechify.StoreOrderBy? Type592 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type593 { get; set; } + public global::Speechify.StoreDocumentQuery? Type593 { get; set; } /// /// /// - public global::Speechify.StoreBatchWriteOp? Type594 { get; set; } + public global::System.Collections.Generic.IList? Type594 { get; set; } /// /// /// - public global::Speechify.StoreBatchWrite? Type595 { get; set; } + public global::Speechify.StoreBatchWriteOp? Type595 { get; set; } /// /// /// - public global::Speechify.StoreBatchRequest? Type596 { get; set; } + public global::Speechify.StoreBatchWrite? Type596 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type597 { get; set; } + public global::Speechify.StoreBatchRequest? Type597 { get; set; } /// /// /// - public global::Speechify.StoreBatchResultOp? Type598 { get; set; } + public global::System.Collections.Generic.IList? Type598 { get; set; } /// /// /// - public global::Speechify.StoreBatchResult? Type599 { get; set; } + public global::Speechify.StoreBatchResultOp? Type599 { get; set; } /// /// /// - public global::Speechify.StoreBatchResponse? Type600 { get; set; } + public global::Speechify.StoreBatchResult? Type600 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type601 { get; set; } + public global::Speechify.StoreBatchResponse? Type601 { get; set; } /// /// /// - public global::Speechify.StoreAsset? Type602 { get; set; } + public global::System.Collections.Generic.IList? Type602 { get; set; } /// /// /// - public global::Speechify.ListStoreAssetsResponse? Type603 { get; set; } + public global::Speechify.StoreAsset? Type603 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type604 { get; set; } + public global::Speechify.ListStoreAssetsResponse? Type604 { get; set; } /// /// /// - public global::Speechify.ListAgentStoresResponse? Type605 { get; set; } + public global::System.Collections.Generic.IList? Type605 { get; set; } /// /// /// - public global::Speechify.HostedApiAuthMode? Type606 { get; set; } + public global::Speechify.ListAgentStoresResponse? Type606 { get; set; } /// /// /// - public global::Speechify.HostedAPI? Type607 { get; set; } + public global::Speechify.HostedApiAuthMode? Type607 { get; set; } /// /// /// - public global::Speechify.ListHostedAPIsResponse? Type608 { get; set; } + public global::Speechify.HostedAPI? Type608 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type609 { get; set; } + public global::Speechify.ListHostedAPIsResponse? Type609 { get; set; } /// /// /// - public global::Speechify.CreateHostedApiRequestAuthMode? Type610 { get; set; } + public global::System.Collections.Generic.IList? Type610 { get; set; } /// /// /// - public global::Speechify.CreateHostedAPIRequest? Type611 { get; set; } + public global::Speechify.CreateHostedApiRequestAuthMode? Type611 { get; set; } /// /// /// - public global::Speechify.UpdateHostedApiRequestAuthMode? Type612 { get; set; } + public global::Speechify.CreateHostedAPIRequest? Type612 { get; set; } /// /// /// - public global::Speechify.UpdateHostedAPIRequest? Type613 { get; set; } + public global::Speechify.UpdateHostedApiRequestAuthMode? Type613 { get; set; } /// /// /// - public global::Speechify.HostedApiRouteMethod? Type614 { get; set; } + public global::Speechify.UpdateHostedAPIRequest? Type614 { get; set; } /// /// /// - public global::Speechify.HostedApiResolverType? Type615 { get; set; } + public global::Speechify.HostedApiRouteMethod? Type615 { get; set; } /// /// /// - public global::Speechify.HostedApiResolverWhereItemsOp? Type616 { get; set; } + public global::Speechify.HostedApiResolverType? Type616 { get; set; } /// /// /// - public global::Speechify.HostedApiResolverWhereItems? Type617 { get; set; } + public global::Speechify.HostedApiResolverWhereItemsOp? Type617 { get; set; } /// /// /// - public global::Speechify.HostedApiResolverOrderByDirection? Type618 { get; set; } + public global::Speechify.HostedApiResolverWhereItems? Type618 { get; set; } /// /// /// - public global::Speechify.HostedApiResolverOrderBy? Type619 { get; set; } + public global::Speechify.HostedApiResolverOrderByDirection? Type619 { get; set; } /// /// /// - public global::Speechify.HostedAPIResolver? Type620 { get; set; } + public global::Speechify.HostedApiResolverOrderBy? Type620 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type621 { get; set; } + public global::Speechify.HostedAPIResolver? Type621 { get; set; } /// /// /// - public global::Speechify.HostedAPIRoute? Type622 { get; set; } + public global::System.Collections.Generic.IList? Type622 { get; set; } /// /// /// - public global::Speechify.ListHostedAPIRoutesResponse? Type623 { get; set; } + public global::Speechify.HostedAPIRoute? Type623 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type624 { get; set; } + public global::Speechify.ListHostedAPIRoutesResponse? Type624 { get; set; } /// /// /// - public global::Speechify.CreateHostedApiRouteRequestMethod? Type625 { get; set; } + public global::System.Collections.Generic.IList? Type625 { get; set; } /// /// /// - public global::Speechify.CreateHostedAPIRouteRequest? Type626 { get; set; } + public global::Speechify.CreateHostedApiRouteRequestMethod? Type626 { get; set; } /// /// /// - public global::Speechify.UpdateHostedApiRouteRequestMethod? Type627 { get; set; } + public global::Speechify.CreateHostedAPIRouteRequest? Type627 { get; set; } /// /// /// - public global::Speechify.UpdateHostedAPIRouteRequest? Type628 { get; set; } + public global::Speechify.UpdateHostedApiRouteRequestMethod? Type628 { get; set; } /// /// /// - public global::Speechify.HostedAPIKey? Type629 { get; set; } + public global::Speechify.UpdateHostedAPIRouteRequest? Type629 { get; set; } /// /// /// - public global::Speechify.ListHostedAPIKeysResponse? Type630 { get; set; } + public global::Speechify.HostedAPIKey? Type630 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type631 { get; set; } + public global::Speechify.ListHostedAPIKeysResponse? Type631 { get; set; } /// /// /// - public global::Speechify.CreateHostedAPIKeyRequest? Type632 { get; set; } + public global::System.Collections.Generic.IList? Type632 { get; set; } /// /// /// - public global::Speechify.ContactIdentifierKind? Type633 { get; set; } + public global::Speechify.CreateHostedAPIKeyRequest? Type633 { get; set; } /// /// /// - public global::Speechify.ContactIdentifierAssertedBy? Type634 { get; set; } + public global::Speechify.ContactIdentifierKind? Type634 { get; set; } /// /// /// - public global::Speechify.ContactIdentifier? Type635 { get; set; } + public global::Speechify.ContactIdentifierAssertedBy? Type635 { get; set; } /// /// /// - public global::Speechify.Contact? Type636 { get; set; } + public global::Speechify.ContactIdentifier? Type636 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type637 { get; set; } + public global::Speechify.Contact? Type637 { get; set; } /// /// /// - public global::Speechify.ListContactsResponse? Type638 { get; set; } + public global::System.Collections.Generic.IList? Type638 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type639 { get; set; } + public global::Speechify.ListContactsResponse? Type639 { get; set; } /// /// /// - public global::Speechify.UpdateContactRequest? Type640 { get; set; } + public global::System.Collections.Generic.IList? Type640 { get; set; } /// /// /// - public global::Speechify.DeleteContactResponse? Type641 { get; set; } + public global::Speechify.UpdateContactRequest? Type641 { get; set; } /// /// /// - public global::Speechify.AttachContactIdentifierRequestKind? Type642 { get; set; } + public global::Speechify.DeleteContactResponse? Type642 { get; set; } /// /// /// - public global::Speechify.AttachContactIdentifierRequest? Type643 { get; set; } + public global::Speechify.AttachContactIdentifierRequestKind? Type643 { get; set; } /// /// /// - public global::Speechify.MergeContactsRequest? Type644 { get; set; } + public global::Speechify.AttachContactIdentifierRequest? Type644 { get; set; } /// /// /// - public global::Speechify.MergeContactsResponseMerged? Type645 { get; set; } + public global::Speechify.MergeContactsRequest? Type645 { get; set; } /// /// /// - public global::Speechify.MergeContactsResponse? Type646 { get; set; } + public global::Speechify.MergeContactsResponseMerged? Type646 { get; set; } /// /// /// - public global::Speechify.BillingEntitlementsMaxLlmModelClass? Type647 { get; set; } + public global::Speechify.MergeContactsResponse? Type647 { get; set; } /// /// /// - public global::Speechify.BillingEntitlements? Type648 { get; set; } + public global::Speechify.BillingEntitlementsMaxLlmModelClass? Type648 { get; set; } /// /// /// - public global::Speechify.EntitlementsResponse? Type649 { get; set; } + public global::Speechify.BillingEntitlements? Type649 { get; set; } /// /// /// - public global::System.Collections.Generic.Dictionary? Type650 { get; set; } + public global::Speechify.EntitlementsResponse? Type650 { get; set; } /// /// /// - public global::Speechify.ContactResolver? Type651 { get; set; } + public global::System.Collections.Generic.Dictionary? Type651 { get; set; } /// /// /// - public global::Speechify.PutContactResolverRequest? Type652 { get; set; } + public global::Speechify.ContactResolver? Type652 { get; set; } /// /// /// - public global::Speechify.WebhookEndpoint? Type653 { get; set; } + public global::Speechify.PutContactResolverRequest? Type653 { get; set; } /// /// /// - public global::Speechify.ListWebhookEndpointsResponse? Type654 { get; set; } + public global::Speechify.WebhookEndpoint? Type654 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type655 { get; set; } + public global::Speechify.ListWebhookEndpointsResponse? Type655 { get; set; } /// /// /// - public global::Speechify.CreateWebhookEndpointRequest? Type656 { get; set; } + public global::System.Collections.Generic.IList? Type656 { get; set; } /// /// /// - public global::Speechify.UpdateWebhookEndpointRequest? Type657 { get; set; } + public global::Speechify.CreateWebhookEndpointRequest? Type657 { get; set; } /// /// /// - public global::Speechify.WebhookEndpointDelivery? Type658 { get; set; } + public global::Speechify.UpdateWebhookEndpointRequest? Type658 { get; set; } /// /// /// - public global::Speechify.ListWebhookEndpointDeliveriesResponse? Type659 { get; set; } + public global::Speechify.WebhookEndpointDelivery? Type659 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type660 { get; set; } + public global::Speechify.ListWebhookEndpointDeliveriesResponse? Type660 { get; set; } /// /// /// - public global::Speechify.Project? Type661 { get; set; } + public global::System.Collections.Generic.IList? Type661 { get; set; } /// /// /// - public global::Speechify.ListProjectsResponse? Type662 { get; set; } + public global::Speechify.Project? Type662 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type663 { get; set; } + public global::Speechify.ListProjectsResponse? Type663 { get; set; } /// /// /// - public global::Speechify.CreateProjectRequest? Type664 { get; set; } + public global::System.Collections.Generic.IList? Type664 { get; set; } /// /// /// - public global::Speechify.UpdateProjectRequest? Type665 { get; set; } + public global::Speechify.CreateProjectRequest? Type665 { get; set; } /// /// /// - public global::Speechify.DeleteProjectRequestMode? Type666 { get; set; } + public global::Speechify.UpdateProjectRequest? Type666 { get; set; } /// /// /// - public global::Speechify.DeleteProjectRequest? Type667 { get; set; } + public global::Speechify.DeleteProjectRequestMode? Type667 { get; set; } /// /// /// - public global::Speechify.ProjectRestoredCounts? Type668 { get; set; } + public global::Speechify.DeleteProjectRequest? Type668 { get; set; } /// /// /// - public global::Speechify.ProjectStillRevokedCounts? Type669 { get; set; } + public global::Speechify.ProjectRestoredCounts? Type669 { get; set; } /// /// /// - public global::Speechify.ProjectRestore? Type670 { get; set; } + public global::Speechify.ProjectStillRevokedCounts? Type670 { get; set; } /// /// /// - public global::Speechify.ProjectTeardownBlockerKind? Type671 { get; set; } + public global::Speechify.ProjectRestore? Type671 { get; set; } /// /// /// - public global::Speechify.ProjectTeardownBlockerBlocksItems? Type672 { get; set; } + public global::Speechify.ProjectTeardownBlockerKind? Type672 { get; set; } /// /// /// - public global::Speechify.ProjectTeardownBlocker? Type673 { get; set; } + public global::Speechify.ProjectTeardownBlockerBlocksItems? Type673 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type674 { get; set; } + public global::Speechify.ProjectTeardownBlocker? Type674 { get; set; } /// /// /// - public global::Speechify.ProjectTeardownGroup? Type675 { get; set; } + public global::System.Collections.Generic.IList? Type675 { get; set; } /// /// /// - public global::Speechify.ProjectTeardown? Type676 { get; set; } + public global::Speechify.ProjectTeardownGroup? Type676 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type677 { get; set; } + public global::Speechify.ProjectTeardown? Type677 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type678 { get; set; } + public global::System.Collections.Generic.IList? Type678 { get; set; } /// /// /// - public global::Speechify.ProjectResourceCounts? Type679 { get; set; } + public global::System.Collections.Generic.IList? Type679 { get; set; } /// /// /// - public global::Speechify.ProjectStats? Type680 { get; set; } + public global::Speechify.ProjectResourceCounts? Type680 { get; set; } /// /// /// - public global::Speechify.PromoteProjectRequest? Type681 { get; set; } + public global::Speechify.ProjectStats? Type681 { get; set; } /// /// /// - public global::Speechify.PromoteCreated? Type682 { get; set; } + public global::Speechify.PromoteProjectRequest? Type682 { get; set; } /// /// /// - public global::Speechify.PromoteReused? Type683 { get; set; } + public global::Speechify.PromoteCreated? Type683 { get; set; } /// /// /// - public global::Speechify.PromoteAttentionKind? Type684 { get; set; } + public global::Speechify.PromoteReused? Type684 { get; set; } /// /// /// - public global::Speechify.PromoteAttentionReason? Type685 { get; set; } + public global::Speechify.PromoteAttentionKind? Type685 { get; set; } /// /// /// - public global::Speechify.PromoteAttention? Type686 { get; set; } + public global::Speechify.PromoteAttentionReason? Type686 { get; set; } /// /// /// - public global::Speechify.PromoteProjectResponse? Type687 { get; set; } + public global::Speechify.PromoteAttention? Type687 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type688 { get; set; } + public global::Speechify.PromoteProjectResponse? Type688 { get; set; } /// /// /// - public global::Speechify.ProjectAuditEventType? Type689 { get; set; } + public global::System.Collections.Generic.IList? Type689 { get; set; } /// /// /// - public global::Speechify.ProjectAuditEvent? Type690 { get; set; } + public global::Speechify.ProjectAuditEventType? Type690 { get; set; } /// /// /// - public global::Speechify.ProjectAuditResponse? Type691 { get; set; } + public global::Speechify.ProjectAuditEvent? Type691 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type692 { get; set; } + public global::Speechify.ProjectAuditResponse? Type692 { get; set; } /// /// /// - public global::Speechify.ProjectMember? Type693 { get; set; } + public global::System.Collections.Generic.IList? Type693 { get; set; } /// /// /// - public global::Speechify.ProjectMembersResponse? Type694 { get; set; } + public global::Speechify.ProjectMember? Type694 { get; set; } /// /// /// - public global::System.Collections.Generic.IList? Type695 { get; set; } + public global::Speechify.ProjectMembersResponse? Type695 { get; set; } /// /// /// - public global::Speechify.GrantProjectMemberRequest? Type696 { get; set; } + public global::System.Collections.Generic.IList? Type696 { get; set; } /// /// /// - public global::Speechify.CreateRequest? Type697 { get; set; } + public global::Speechify.GrantProjectMemberRequest? Type697 { get; set; } /// /// /// - public global::Speechify.DetectRequest? Type698 { get; set; } + public global::Speechify.CreateRequest? Type698 { get; set; } /// /// /// - public global::Speechify.VerifyRequest? Type699 { get; set; } + public global::Speechify.DetectRequest? Type699 { get; set; } /// /// /// - public global::Speechify.UploadDocumentRequest? Type700 { get; set; } + public global::Speechify.VerifyRequest? Type700 { get; set; } /// /// /// - public global::Speechify.UpdateDocumentRequest? Type701 { get; set; } + public global::Speechify.UploadDocumentRequest? Type701 { get; set; } /// /// /// - public global::Speechify.RunTestRequest? Type702 { get; set; } + public global::Speechify.UpdateDocumentRequest? Type702 { get; set; } /// /// /// - public global::Speechify.UploadRequest? Type703 { get; set; } + public global::Speechify.RunTestRequest? Type703 { get; set; } /// /// /// - public global::Speechify.UploadAssetRequest? Type704 { get; set; } + public global::Speechify.UploadRequest? Type704 { get; set; } + /// + /// + /// + public global::Speechify.UploadAssetRequest? Type705 { get; set; } /// /// diff --git a/src/libs/Speechify/Generated/Speechify.Models.AgentTTSConfig.g.cs b/src/libs/Speechify/Generated/Speechify.Models.AgentTTSConfig.g.cs index 695ffba..ed96725 100644 --- a/src/libs/Speechify/Generated/Speechify.Models.AgentTTSConfig.g.cs +++ b/src/libs/Speechify/Generated/Speechify.Models.AgentTTSConfig.g.cs @@ -26,21 +26,21 @@ public sealed partial class AgentTTSConfig /// /// Pins the Simba model this agent synthesizes on. **Null is the
/// default and the recommended setting**: the agent follows the
- /// model its voice is curated for, so a voice promoted to a newer
- /// training moves with it and no configuration goes stale.
+ /// model VMS proposes for its voice (`default_model` on
+ /// GET /v1/agents/voices), so a voice promoted to a newer training
+ /// moves with it and no configuration goes stale.
/// Set it to override that choice in either direction - onto an
/// experimental training, or back down off one. Call
- /// GET /v1/agents/tts-models for the catalog, and read the voice's
- /// `models` and `default_model` on GET /v1/agents/voices for what
- /// this particular voice can serve on.
+ /// GET /v1/agents/tts-models for the catalog. Every model there
+ /// serves every voice we speak ourselves; a partner voice takes none
+ /// of them, because its provider selects its own model.
/// A write is rejected when the agent could not actually be served
/// with the model: an English-only model on an agent that resolves
/// through the multilingual serving (it declares
- /// `additional_languages`, or its own `language` is not English),
- /// or a model the chosen voice is not curated for. The pair is
- /// re-checked whenever `voice_id`, `language`, or
- /// `additional_languages` change, so a stored pin cannot be
- /// orphaned by an edit elsewhere.
+ /// `additional_languages`, or its own `language` is not English), or
+ /// any Simba model on a partner voice. It is re-checked whenever
+ /// `language` or `additional_languages` change, so a stored pin
+ /// cannot be orphaned by an edit elsewhere.
/// Send `null` (or `""`) to clear it back to automatic. /// [global::System.Text.Json.Serialization.JsonPropertyName("model")] @@ -66,21 +66,21 @@ public sealed partial class AgentTTSConfig /// /// Pins the Simba model this agent synthesizes on. **Null is the
/// default and the recommended setting**: the agent follows the
- /// model its voice is curated for, so a voice promoted to a newer
- /// training moves with it and no configuration goes stale.
+ /// model VMS proposes for its voice (`default_model` on
+ /// GET /v1/agents/voices), so a voice promoted to a newer training
+ /// moves with it and no configuration goes stale.
/// Set it to override that choice in either direction - onto an
/// experimental training, or back down off one. Call
- /// GET /v1/agents/tts-models for the catalog, and read the voice's
- /// `models` and `default_model` on GET /v1/agents/voices for what
- /// this particular voice can serve on.
+ /// GET /v1/agents/tts-models for the catalog. Every model there
+ /// serves every voice we speak ourselves; a partner voice takes none
+ /// of them, because its provider selects its own model.
/// A write is rejected when the agent could not actually be served
/// with the model: an English-only model on an agent that resolves
/// through the multilingual serving (it declares
- /// `additional_languages`, or its own `language` is not English),
- /// or a model the chosen voice is not curated for. The pair is
- /// re-checked whenever `voice_id`, `language`, or
- /// `additional_languages` change, so a stored pin cannot be
- /// orphaned by an edit elsewhere.
+ /// `additional_languages`, or its own `language` is not English), or
+ /// any Simba model on a partner voice. It is re-checked whenever
+ /// `language` or `additional_languages` change, so a stored pin
+ /// cannot be orphaned by an edit elsewhere.
/// Send `null` (or `""`) to clear it back to automatic. /// #if NET7_0_OR_GREATER diff --git a/src/libs/Speechify/Generated/Speechify.Models.AgentTTSModelInfo.g.cs b/src/libs/Speechify/Generated/Speechify.Models.AgentTTSModelInfo.g.cs index d4cb2ea..1ad9909 100644 --- a/src/libs/Speechify/Generated/Speechify.Models.AgentTTSModelInfo.g.cs +++ b/src/libs/Speechify/Generated/Speechify.Models.AgentTTSModelInfo.g.cs @@ -1,4 +1,6 @@ +#pragma warning disable CS0618 // Type or member is obsolete + #nullable enable namespace Speechify @@ -39,9 +41,8 @@ public sealed partial class AgentTTSModelInfo public required bool Beta { get; set; } /// - /// True for the model an agent lands on with no pin and an
- /// uncurated voice. The floor of the catalog, and the only entry
- /// selectable for every agent and every voice. + /// True for the model an agent lands on with no pin. The floor of
+ /// the catalog, and the only entry selectable in every language. /// [global::System.Text.Json.Serialization.JsonPropertyName("default")] [global::System.Text.Json.Serialization.JsonRequired] @@ -56,14 +57,11 @@ public sealed partial class AgentTTSModelInfo public required bool EnglishOnly { get; set; } /// - /// A voice must be registered for this model before it can be
- /// selected with that voice, because the model has a voice roster
- /// built for it. False for a model offered across the catalog.
- /// Either way, the voice's `models` array on GET /v1/agents/voices is
- /// the per-voice answer and the one to drive a picker from - a voice
- /// built for a curated model is absent from the open models too. This
- /// flag explains WHY a voice is absent; it does not decide whether to
- /// check. + /// Deprecated and always `false`. No model requires a voice to be
+ /// registered for it: every training conditions on the voice's own
+ /// prompt audio, so every model is selectable on every voice we speak
+ /// ourselves. The field stays on the response for compatibility and
+ /// can be ignored. /// [global::System.Text.Json.Serialization.JsonPropertyName("requires_voice_curation")] [global::System.Text.Json.Serialization.JsonRequired] @@ -88,23 +86,19 @@ public sealed partial class AgentTTSModelInfo /// simply not one agents are steered onto by default. /// /// - /// True for the model an agent lands on with no pin and an
- /// uncurated voice. The floor of the catalog, and the only entry
- /// selectable for every agent and every voice. + /// True for the model an agent lands on with no pin. The floor of
+ /// the catalog, and the only entry selectable in every language. /// /// /// The model has no multilingual deployment. An agent that resolves
/// through the multilingual serving cannot select it at all. /// /// - /// A voice must be registered for this model before it can be
- /// selected with that voice, because the model has a voice roster
- /// built for it. False for a model offered across the catalog.
- /// Either way, the voice's `models` array on GET /v1/agents/voices is
- /// the per-voice answer and the one to drive a picker from - a voice
- /// built for a curated model is absent from the open models too. This
- /// flag explains WHY a voice is absent; it does not decide whether to
- /// check. + /// Deprecated and always `false`. No model requires a voice to be
+ /// registered for it: every training conditions on the voice's own
+ /// prompt audio, so every model is selectable on every voice we speak
+ /// ourselves. The field stays on the response for compatibility and
+ /// can be ignored. /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] diff --git a/src/libs/Speechify/Generated/Speechify.Models.AgentVoiceModel.g.cs b/src/libs/Speechify/Generated/Speechify.Models.AgentVoiceModel.g.cs index 596c984..30f8788 100644 --- a/src/libs/Speechify/Generated/Speechify.Models.AgentVoiceModel.g.cs +++ b/src/libs/Speechify/Generated/Speechify.Models.AgentVoiceModel.g.cs @@ -6,17 +6,12 @@ namespace Speechify /// /// One Simba model version the voice can be synthesised through, and
/// therefore one an agent on this voice may pin with `tts.model`.
- /// Every agent voice supports `simba-3.0`. English-only upgrade tiers
- /// (`simba-3.5-turbo`, `simba-3.2`) are listed when this voice can
- /// select them: a tier with `requires_voice_curation` only where the
- /// voice is curated for it, a tier without it on any voice we speak
- /// ourselves EXCEPT one built for a curated roster, whose speaker
- /// embedding is valid for that training alone. A partner voice lists no
+ /// Every voice we speak ourselves supports every model listed here -
+ /// `simba-3.0` plus the English-only tiers `simba-3.2` and
+ /// `simba-3.5-turbo` - because each training conditions on the voice's
+ /// own prompt audio, cloned voices included. A partner voice lists no
/// tier at all - Simba model selection does not apply to it.
- /// So read this array rather than inferring membership from
- /// `requires_voice_curation`: a voice can be absent from a model that
- /// needs no curation. It is the per-voice answer for every model, and a
- /// pin outside it is a 400. Which of these `tts.model: null`
+ /// A pin outside this array is a 400. Which of these `tts.model: null`
/// actually resolves to is `default_model`, not the order here.
/// Like `default_model`, the tiers listed here are the ENGLISH answer,
/// and they are a fact about the voice rather than about any one agent.
diff --git a/src/libs/Speechify/Generated/Speechify.Models.Model.g.cs b/src/libs/Speechify/Generated/Speechify.Models.Model.g.cs index 34b870e..59225f8 100644 --- a/src/libs/Speechify/Generated/Speechify.Models.Model.g.cs +++ b/src/libs/Speechify/Generated/Speechify.Models.Model.g.cs @@ -1,4 +1,6 @@ +#pragma warning disable CS0618 // Type or member is obsolete + #nullable enable namespace Speechify @@ -26,8 +28,8 @@ public sealed partial class Model /// /// Whether this is the model used when a synthesis request omits
/// `model`. Exactly one model in the list is the default. Distinct
- /// from `recommended`: the default accepts every voice, while the
- /// recommended model may serve a curated or English-only set. + /// from `recommended`: the default accepts every voice in every
+ /// language, while the recommended model may be English-only. /// [global::System.Text.Json.Serialization.JsonPropertyName("default")] [global::System.Text.Json.Serialization.JsonRequired] @@ -103,13 +105,12 @@ public sealed partial class Model public required global::System.Collections.Generic.IList Endpoints { get; set; } /// - /// Whether the model's stock voices are restricted to the set curated
- /// for it. When true, pick a stock voice whose `models` array in
- /// GET /v1/voices names this model; any other stock voice is rejected.
- /// When false, every stock catalogue voice works. Cloned voices are
- /// governed separately - always read each voice's own `models` array in
- /// GET /v1/voices, which reflects what your workspace may actually
- /// synthesize. + /// Deprecated and always `false`. No model restricts synthesis to a
+ /// registered voice set: every training conditions on the voice's own
+ /// prompt audio, so every catalogue voice and every cloned voice works
+ /// on every model, subject only to `english_voices_only`. Each voice's
+ /// `models` array in GET /v1/voices stays the per-voice answer. The
+ /// field remains on the response for compatibility. /// [global::System.Text.Json.Serialization.JsonPropertyName("curated_voices")] [global::System.Text.Json.Serialization.JsonRequired] @@ -143,8 +144,8 @@ public sealed partial class Model /// /// Whether this is the model used when a synthesis request omits
/// `model`. Exactly one model in the list is the default. Distinct
- /// from `recommended`: the default accepts every voice, while the
- /// recommended model may serve a curated or English-only set. + /// from `recommended`: the default accepts every voice in every
+ /// language, while the recommended model may be English-only. /// /// /// Whether this is the model we recommend for new integrations.
@@ -172,13 +173,12 @@ public sealed partial class Model /// response, so branch on it instead of discovering it at call time. /// /// - /// Whether the model's stock voices are restricted to the set curated
- /// for it. When true, pick a stock voice whose `models` array in
- /// GET /v1/voices names this model; any other stock voice is rejected.
- /// When false, every stock catalogue voice works. Cloned voices are
- /// governed separately - always read each voice's own `models` array in
- /// GET /v1/voices, which reflects what your workspace may actually
- /// synthesize. + /// Deprecated and always `false`. No model restricts synthesis to a
+ /// registered voice set: every training conditions on the voice's own
+ /// prompt audio, so every catalogue voice and every cloned voice works
+ /// on every model, subject only to `english_voices_only`. Each voice's
+ /// `models` array in GET /v1/voices stays the per-voice answer. The
+ /// field remains on the response for compatibility. /// /// /// Whether the model rejects a non-English voice. Independent of
diff --git a/src/libs/Speechify/Generated/Speechify.Models.TriggerRunSpec.g.cs b/src/libs/Speechify/Generated/Speechify.Models.TriggerRunSpec.g.cs index 7be6d96..46ede35 100644 --- a/src/libs/Speechify/Generated/Speechify.Models.TriggerRunSpec.g.cs +++ b/src/libs/Speechify/Generated/Speechify.Models.TriggerRunSpec.g.cs @@ -58,7 +58,9 @@ public sealed partial class TriggerRunSpec /// `GET /v1/agents/runs?user_identity=` finds it, so you keep no
/// trigger-to-person index of your own. Validated when the trigger is
/// saved, by the run surface's rule: must not begin with `user_`,
- /// `embed_` or `anon_`. + /// `embed_` or `anon_`.
+ /// Leave it empty and set `webhook.user_identity_source` to `fire`
+ /// when one trigger serves many people and each delivery says which. /// [global::System.Text.Json.Serialization.JsonPropertyName("user_identity")] public string? UserIdentity { get; set; } @@ -119,7 +121,9 @@ public sealed partial class TriggerRunSpec /// `GET /v1/agents/runs?user_identity=` finds it, so you keep no
/// trigger-to-person index of your own. Validated when the trigger is
/// saved, by the run surface's rule: must not begin with `user_`,
- /// `embed_` or `anon_`. + /// `embed_` or `anon_`.
+ /// Leave it empty and set `webhook.user_identity_source` to `fire`
+ /// when one trigger serves many people and each delivery says which. /// /// /// Up to 16 key/value pairs merged onto every run this trigger fires,
diff --git a/src/libs/Speechify/Generated/Speechify.Models.TriggerWebhookConfig.g.cs b/src/libs/Speechify/Generated/Speechify.Models.TriggerWebhookConfig.g.cs index d8e1862..95e77e1 100644 --- a/src/libs/Speechify/Generated/Speechify.Models.TriggerWebhookConfig.g.cs +++ b/src/libs/Speechify/Generated/Speechify.Models.TriggerWebhookConfig.g.cs @@ -14,6 +14,27 @@ public sealed partial class TriggerWebhookConfig [global::System.Text.Json.Serialization.JsonPropertyName("payload_variable")] public string? PayloadVariable { get; set; } + /// + /// Who names the person a fired run acts for. Defaults to `trigger`.
+ /// `trigger` uses `run.user_identity`, so every fire on
+ /// this trigger acts for the same person - or for nobody, when it is
+ /// unset.
+ /// `fire` takes the person from each delivery, as a
+ /// `Speechify-User-Identity` header on the fire request. One trigger
+ /// then serves every person your connector watches, instead of one
+ /// trigger per person. `run.user_identity` must be empty when you
+ /// choose it: a trigger that both pins a person and reads one per
+ /// delivery would run silently as the pinned person whenever your
+ /// connector forgot the header, so the combination is refused with a
+ /// `400` when the trigger is saved.
+ /// A fire that names a person the trigger does not accept, and a fire
+ /// that names nobody on a `fire`-sourced trigger, are both refused
+ /// with a `400` rather than quietly running for the wrong person. + /// + [global::System.Text.Json.Serialization.JsonPropertyName("user_identity_source")] + [global::System.Text.Json.Serialization.JsonConverter(typeof(global::Speechify.JsonConverters.TriggerWebhookConfigUserIdentitySourceJsonConverter))] + public global::Speechify.TriggerWebhookConfigUserIdentitySource? UserIdentitySource { get; set; } + /// /// Additional properties that are not explicitly defined in the schema /// @@ -26,13 +47,32 @@ public sealed partial class TriggerWebhookConfig /// /// The run-variable key the POST body is bound to. Defaults to `payload`. /// + /// + /// Who names the person a fired run acts for. Defaults to `trigger`.
+ /// `trigger` uses `run.user_identity`, so every fire on
+ /// this trigger acts for the same person - or for nobody, when it is
+ /// unset.
+ /// `fire` takes the person from each delivery, as a
+ /// `Speechify-User-Identity` header on the fire request. One trigger
+ /// then serves every person your connector watches, instead of one
+ /// trigger per person. `run.user_identity` must be empty when you
+ /// choose it: a trigger that both pins a person and reads one per
+ /// delivery would run silently as the pinned person whenever your
+ /// connector forgot the header, so the combination is refused with a
+ /// `400` when the trigger is saved.
+ /// A fire that names a person the trigger does not accept, and a fire
+ /// that names nobody on a `fire`-sourced trigger, are both refused
+ /// with a `400` rather than quietly running for the wrong person. + /// #if NET7_0_OR_GREATER [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] #endif public TriggerWebhookConfig( - string? payloadVariable) + string? payloadVariable, + global::Speechify.TriggerWebhookConfigUserIdentitySource? userIdentitySource) { this.PayloadVariable = payloadVariable; + this.UserIdentitySource = userIdentitySource; } /// diff --git a/src/libs/Speechify/Generated/Speechify.Models.TriggerWebhookConfigUserIdentitySource.g.cs b/src/libs/Speechify/Generated/Speechify.Models.TriggerWebhookConfigUserIdentitySource.g.cs new file mode 100644 index 0000000..df7102f --- /dev/null +++ b/src/libs/Speechify/Generated/Speechify.Models.TriggerWebhookConfigUserIdentitySource.g.cs @@ -0,0 +1,65 @@ + +#nullable enable + +namespace Speechify +{ + /// + /// Who names the person a fired run acts for. Defaults to `trigger`.
+ /// `trigger` uses `run.user_identity`, so every fire on
+ /// this trigger acts for the same person - or for nobody, when it is
+ /// unset.
+ /// `fire` takes the person from each delivery, as a
+ /// `Speechify-User-Identity` header on the fire request. One trigger
+ /// then serves every person your connector watches, instead of one
+ /// trigger per person. `run.user_identity` must be empty when you
+ /// choose it: a trigger that both pins a person and reads one per
+ /// delivery would run silently as the pinned person whenever your
+ /// connector forgot the header, so the combination is refused with a
+ /// `400` when the trigger is saved.
+ /// A fire that names a person the trigger does not accept, and a fire
+ /// that names nobody on a `fire`-sourced trigger, are both refused
+ /// with a `400` rather than quietly running for the wrong person. + /// + public enum TriggerWebhookConfigUserIdentitySource + { + /// + /// + /// + Fire, + /// + /// a trigger that both pins a person and reads one per + /// + Trigger, + } + + /// + /// Enum extensions to do fast conversions without the reflection. + /// + public static class TriggerWebhookConfigUserIdentitySourceExtensions + { + /// + /// Converts an enum to a string. + /// + public static string ToValueString(this TriggerWebhookConfigUserIdentitySource value) + { + return value switch + { + TriggerWebhookConfigUserIdentitySource.Fire => "fire", + TriggerWebhookConfigUserIdentitySource.Trigger => "trigger", + _ => throw new global::System.ArgumentOutOfRangeException(nameof(value), value, null), + }; + } + /// + /// Converts an string to a enum. + /// + public static TriggerWebhookConfigUserIdentitySource? ToEnum(string value) + { + return value switch + { + "fire" => TriggerWebhookConfigUserIdentitySource.Fire, + "trigger" => TriggerWebhookConfigUserIdentitySource.Trigger, + _ => null, + }; + } + } +} \ No newline at end of file diff --git a/src/libs/Speechify/Generated/Speechify.TriggersClient.Fire.g.cs b/src/libs/Speechify/Generated/Speechify.TriggersClient.Fire.g.cs index 659ba4e..d62546c 100644 --- a/src/libs/Speechify/Generated/Speechify.TriggersClient.Fire.g.cs +++ b/src/libs/Speechify/Generated/Speechify.TriggersClient.Fire.g.cs @@ -29,12 +29,14 @@ partial void PrepareFireArguments( global::System.Net.Http.HttpClient httpClient, ref string triggerId, ref string? speechifyVersion, + ref string? speechifyUserIdentity, object request); partial void PrepareFireRequest( global::System.Net.Http.HttpClient httpClient, global::System.Net.Http.HttpRequestMessage httpRequestMessage, string triggerId, string? speechifyVersion, + string? speechifyUserIdentity, object request); partial void ProcessFireResponse( global::System.Net.Http.HttpClient httpClient, @@ -51,10 +53,24 @@ partial void ProcessFireResponseContent( /// one-time fire token as `Authorization: Bearer <secret>`. The JSON body
/// becomes the started run's payload variable. Supply an `Idempotency-Key`
/// (or `Speechify-Delivery-Id`) header to make a redelivery replay the
- /// original run instead of starting a second one. + /// original run instead of starting a second one.
+ /// **Reacting to something that happened, for one person.** Set the
+ /// trigger's `webhook.user_identity_source` to `fire` and send
+ /// `Speechify-User-Identity` on each POST. The run then acts for that
+ /// person - their memory, and every tool call told who it is for - so one
+ /// trigger serves every person your connector watches and you hold no
+ /// trigger id per person. Use the plain form (`user_identity_source:
+ /// trigger`) when the work is the same whoever it is for: a nightly
+ /// reconciliation, an alert fan-out, a build that finished.
+ /// **Rate.** A trigger admits 60 fires a minute, and 12 a minute for any
+ /// one person; past either the endpoint answers `429` with `Retry-After`.
+ /// A fire starts a durable run against your credit balance, so a burst is
+ /// deferred rather than fanned out. Retry the refused delivery under the
+ /// same delivery id and it runs exactly once. /// /// /// + /// /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. /// The token to cancel the operation with @@ -64,6 +80,7 @@ partial void ProcessFireResponseContent( object request, string? speechifyVersion = default, + string? speechifyUserIdentity = default, global::Speechify.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default) { @@ -72,6 +89,7 @@ partial void ProcessFireResponseContent( request: request, speechifyVersion: speechifyVersion, + speechifyUserIdentity: speechifyUserIdentity, requestOptions: requestOptions, cancellationToken: cancellationToken ).ConfigureAwait(false); @@ -84,10 +102,24 @@ partial void ProcessFireResponseContent( /// one-time fire token as `Authorization: Bearer <secret>`. The JSON body
/// becomes the started run's payload variable. Supply an `Idempotency-Key`
/// (or `Speechify-Delivery-Id`) header to make a redelivery replay the
- /// original run instead of starting a second one. + /// original run instead of starting a second one.
+ /// **Reacting to something that happened, for one person.** Set the
+ /// trigger's `webhook.user_identity_source` to `fire` and send
+ /// `Speechify-User-Identity` on each POST. The run then acts for that
+ /// person - their memory, and every tool call told who it is for - so one
+ /// trigger serves every person your connector watches and you hold no
+ /// trigger id per person. Use the plain form (`user_identity_source:
+ /// trigger`) when the work is the same whoever it is for: a nightly
+ /// reconciliation, an alert fan-out, a build that finished.
+ /// **Rate.** A trigger admits 60 fires a minute, and 12 a minute for any
+ /// one person; past either the endpoint answers `429` with `Retry-After`.
+ /// A fire starts a durable run against your credit balance, so a burst is
+ /// deferred rather than fanned out. Retry the refused delivery under the
+ /// same delivery id and it runs exactly once. /// /// /// + /// /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. /// The token to cancel the operation with @@ -97,6 +129,7 @@ partial void ProcessFireResponseContent( object request, string? speechifyVersion = default, + string? speechifyUserIdentity = default, global::Speechify.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default) { @@ -108,6 +141,7 @@ partial void ProcessFireResponseContent( httpClient: HttpClient, triggerId: ref triggerId, speechifyVersion: ref speechifyVersion, + speechifyUserIdentity: ref speechifyUserIdentity, request: request); @@ -170,6 +204,10 @@ partial void ProcessFireResponseContent( { __httpRequest.Headers.TryAddWithoutValidation("Speechify-Version", speechifyVersion.ToString()); } + if (speechifyUserIdentity != default) + { + __httpRequest.Headers.TryAddWithoutValidation("Speechify-User-Identity", speechifyUserIdentity.ToString()); + } var __httpRequestContentBody = global::System.Text.Json.JsonSerializer.Serialize(request, request.GetType(), JsonSerializerContext); var __httpRequestContent = new global::System.Net.Http.StringContent( @@ -190,6 +228,7 @@ partial void ProcessFireResponseContent( httpRequestMessage: __httpRequest, triggerId: triggerId!, speechifyVersion: speechifyVersion, + speechifyUserIdentity: speechifyUserIdentity, request: request); return __httpRequest; @@ -369,6 +408,43 @@ partial void ProcessFireResponseContent( retryReason: global::System.String.Empty, cancellationToken: __effectiveCancellationToken)).ConfigureAwait(false); } + // The request was malformed or failed validation. The response body is the standard `Error` envelope; for validation failures `error.fields` enumerates the offending fields as a `path -> message` map (code = `validation_failed`). + if ((int)__response.StatusCode == 400) + { + string? __content_400 = null; + global::System.Exception? __exception_400 = null; + global::Speechify.Error? __value_400 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_400 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_400 = global::Speechify.Error.FromJson(__content_400, JsonSerializerContext); + } + else + { + __content_400 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_400 = global::Speechify.Error.FromJson(__content_400, JsonSerializerContext); + } + } + catch (global::System.Exception __ex) + { + __exception_400 = __ex; + } + + + throw global::Speechify.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_400 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_400, + responseBody: __content_400, + responseObject: __value_400, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } // Authentication is missing or invalid. The request did not carry a recognised credential (console session token, API key, or worker JWT). if ((int)__response.StatusCode == 401) { @@ -480,6 +556,43 @@ partial void ProcessFireResponseContent( h => h.Key, h => h.Value)); } + // Rate limit or concurrency limit exceeded. `error.code` distinguishes request-rate limiting (`rate_limited`) from concurrency exhaustion (`concurrency_limit_reached`). Carries `Retry-After` and the request-rate budget headers; a concurrency-exhaustion 429 also carries `RateLimit-Remaining-Calls: 0`. + if ((int)__response.StatusCode == 429) + { + string? __content_429 = null; + global::System.Exception? __exception_429 = null; + global::Speechify.Error? __value_429 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_429 = global::Speechify.Error.FromJson(__content_429, JsonSerializerContext); + } + else + { + __content_429 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_429 = global::Speechify.Error.FromJson(__content_429, JsonSerializerContext); + } + } + catch (global::System.Exception __ex) + { + __exception_429 = __ex; + } + + + throw global::Speechify.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_429 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_429, + responseBody: __content_429, + responseObject: __value_429, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } if (__effectiveReadResponseAsString) { @@ -582,16 +695,31 @@ partial void ProcessFireResponseContent( /// one-time fire token as `Authorization: Bearer <secret>`. The JSON body
/// becomes the started run's payload variable. Supply an `Idempotency-Key`
/// (or `Speechify-Delivery-Id`) header to make a redelivery replay the
- /// original run instead of starting a second one. + /// original run instead of starting a second one.
+ /// **Reacting to something that happened, for one person.** Set the
+ /// trigger's `webhook.user_identity_source` to `fire` and send
+ /// `Speechify-User-Identity` on each POST. The run then acts for that
+ /// person - their memory, and every tool call told who it is for - so one
+ /// trigger serves every person your connector watches and you hold no
+ /// trigger id per person. Use the plain form (`user_identity_source:
+ /// trigger`) when the work is the same whoever it is for: a nightly
+ /// reconciliation, an alert fan-out, a build that finished.
+ /// **Rate.** A trigger admits 60 fires a minute, and 12 a minute for any
+ /// one person; past either the endpoint answers `429` with `Retry-After`.
+ /// A fire starts a durable run against your credit balance, so a burst is
+ /// deferred rather than fanned out. Retry the refused delivery under the
+ /// same delivery id and it runs exactly once. /// /// /// + /// /// Per-request overrides such as headers, query parameters, timeout, retries, and response buffering. /// The token to cancel the operation with /// public async global::System.Threading.Tasks.Task FireAsync( string triggerId, string? speechifyVersion = default, + string? speechifyUserIdentity = default, global::Speechify.AutoSDKRequestOptions? requestOptions = default, global::System.Threading.CancellationToken cancellationToken = default) { @@ -602,6 +730,7 @@ partial void ProcessFireResponseContent( return await FireAsync( triggerId: triggerId, speechifyVersion: speechifyVersion, + speechifyUserIdentity: speechifyUserIdentity, request: __request, requestOptions: requestOptions, cancellationToken: cancellationToken).ConfigureAwait(false); diff --git a/src/libs/Speechify/openapi.yaml b/src/libs/Speechify/openapi.yaml index 562610e..e1a80c5 100644 --- a/src/libs/Speechify/openapi.yaml +++ b/src/libs/Speechify/openapi.yaml @@ -1 +1 @@ -{"openapi":"3.1.0","info":{"title":"API Reference","version":"1.0.0"},"paths":{"/v1/audio/speech":{"post":{"operationId":"speech","summary":"Create Speech","description":"Synthesize speech audio from text or SSML. Returns the complete audio\nfile plus billing and speech-mark metadata in a single JSON response.\nFor low-latency playback or long-form text, use POST /v1/audio/stream.\nSet `output_format` for explicit sample-rate/bitrate control (e.g.\n`pcm_16000` or `ulaw_8000` for telephony).","tags":["audio"],"parameters":[{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Synthesized speech audio for the requested input.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSpeechResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"The workspace has insufficient credits, or the request needs a\nplan tier the workspace is not on (e.g. voice cloning). Distinct\nfrom `Forbidden` so SDK consumers can drive upgrade UX.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The credential authenticated, but is not authorised for this\nresource - typically a workspace-role gate (owner / admin\nrequired) or a cross-tenant access attempt.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"An upstream dependency (the TTS composer or voice-metadata\nservice) returned a 5xx. The raw upstream detail is not\nforwarded - the cause is in the server log; the response is a\nfixed `upstream_failure` envelope. Safe to retry.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"A downstream dependency is degraded or the endpoint is\nintentionally disabled (e.g. phone-number purchase before\nops setup).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSpeechRequest"}}}}}},"/v1/audio/stream":{"post":{"operationId":"stream","summary":"Stream Speech","description":"Synthesize speech and stream the audio back as it is generated, for\nlow-latency playback. Set `output_format` in the body for explicit\ncodec/sample-rate/bitrate control (e.g. `pcm_16000` or `ulaw_8000` for\ntelephony), or fall back to the Accept header for the container; the\nresponse is raw audio bytes (HTTP chunked). For Base64-encoded audio\nwith speech-mark metadata in a single JSON response, use\nPOST /v1/audio/speech.","tags":["audio"],"parameters":[{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Selects the audio container/codec for the streamed response when\n`output_format` is not set in the request body. The response\nContent-Type echoes this value, except `audio/pcm` returns\n`audio/L16` with rate and channels parameters (raw 16-bit linear\nPCM, 24 kHz mono, little-endian). For explicit sample-rate/bitrate\ncontrol (e.g. `pcm_16000`, `ulaw_8000`), set `output_format` in the\nbody instead; it takes precedence over this header.","required":false,"schema":{"$ref":"#/components/schemas/V1AudioStreamPostParametersAccept"}}],"responses":{"200":{"description":"Streamed audio. When `output_format` is set it selects the\ncodec/sample rate; otherwise the Accept header does. The\nContent-Type reflects the selected format: it matches the Accept\nheader, except raw PCM returns `audio/L16` (with rate and channels\nparameters) and u-law returns `audio/basic`.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"The workspace has insufficient credits, or the request needs a\nplan tier the workspace is not on (e.g. voice cloning). Distinct\nfrom `Forbidden` so SDK consumers can drive upgrade UX.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The credential authenticated, but is not authorised for this\nresource - typically a workspace-role gate (owner / admin\nrequired) or a cross-tenant access attempt.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"An upstream dependency (the TTS composer or voice-metadata\nservice) returned a 5xx. The raw upstream detail is not\nforwarded - the cause is in the server log; the response is a\nfixed `upstream_failure` envelope. Safe to retry.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"A downstream dependency is degraded or the endpoint is\nintentionally disabled (e.g. phone-number purchase before\nops setup).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStreamRequest"}}}}}},"/v1/audio/stream/with-timestamps":{"post":{"operationId":"streamWithTimestamps","summary":"Stream Speech With Timestamps","description":"Synthesize speech and stream it back together with word-level speech\nmarks, for text highlighting, captions and audio-text synchronization\nwhile the audio is still arriving.\n\nThe response is a Server-Sent Events stream. Each `speech.chunk` event\ncarries a Base64-encoded run of audio, the speech marks that became\nfinal with it, or both - a chunk may carry only one of the two, and the\nlast chunk of a stream is often marks-only. A terminal `speech.done`\nevent ends the stream; there is no `[DONE]` sentinel. Ignore any event\ntype you do not recognize, so that new event types do not break your\nintegration.\n\nSpeech-mark times are absolute milliseconds from the start of the\nsynthesis, so concatenate the audio chunks into one stream and apply the\nmarks against that single timeline. Which chunk a mark arrives on is a\ndelivery detail and carries no meaning. Times stay correct for every\n`output_format`: changing the codec or sample rate does not change the\nduration.\n\nSpeech marks are produced by the streaming-native models. The default\n`simba-3.0` and `simba-3.2` both serve this route. The legacy\n`simba-english` and `simba-multilingual` models never could: on a\nworkspace pinned before API version `2026-09-21` they return 400\n`speech_marks_unsupported` here, and from that version on they return\n400 `model_retired` on every synthesis route. Both are switched off\nentirely on 2026-11-21.\nFor Base64-encoded audio and speech marks in one non-streamed JSON\nresponse, on any model, use POST /v1/audio/speech.","tags":["audio"],"parameters":[{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}},{"name":"Accept","in":"header","description":"Selects the audio container/codec carried inside the events when\n`output_format` is not set in the request body. The selected media\ntype is echoed on the `Speechify-Audio-Content-Type` response\nheader, since the response's own Content-Type is `text/event-stream`.","required":false,"schema":{"$ref":"#/components/schemas/V1AudioStreamWithTimestampsPostParametersAccept"}}],"responses":{"200":{"description":"A Server-Sent Events stream of `speech.chunk` events followed by one\nterminal `speech.done` event. A failure after the stream has started\nis delivered as a `speech.error` event carrying the standard error\nenvelope, because the status code is already committed.\n\nThe transport is `text/event-stream`: each event is an\n`event:`/`data:` pair whose `data` is one JSON payload matching the\nschema below. The payload's `type` field mirrors the `event:` name,\nso the stream is also parseable from `data:` lines alone. Ignore\nevent types you do not recognize.","content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/SpeechStreamEvent"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"The workspace has insufficient credits, or the request needs a\nplan tier the workspace is not on (e.g. voice cloning). Distinct\nfrom `Forbidden` so SDK consumers can drive upgrade UX.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The credential authenticated, but is not authorised for this\nresource - typically a workspace-role gate (owner / admin\nrequired) or a cross-tenant access attempt.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"An upstream dependency (the TTS composer or voice-metadata\nservice) returned a 5xx. The raw upstream detail is not\nforwarded - the cause is in the server log; the response is a\nfixed `upstream_failure` envelope. Safe to retry.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"A downstream dependency is degraded or the endpoint is\nintentionally disabled (e.g. phone-number purchase before\nops setup).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStreamRequest"}}}}}},"/v1/voices":{"get":{"operationId":"list","summary":"List Voices","description":"Lists the voices available to the caller - the shared voice\ncatalog plus the cloned voices they can reach, whichever member or\nservice-account key created them. A clone filed under a project is\nlisted only for a caller who can reach that project; a clone no\nproject filed is shared with the whole workspace and is listed for\neveryone in it. By default\nthe full catalogue is returned in one response. Pagination is\nopt-in: pass `limit` (and then `cursor` from the previous\nresponse) to page through the list while `has_more` is true. Max\npage size is 200. Narrow the list with the `type` and `locale`\nfilters.\n\nA page can come back with fewer than `limit` voices, and a short\npage - an empty one included - is not the end of the list. Keep\nfollowing `next_cursor` while `has_more` is true.","tags":["voices"],"parameters":[{"name":"cursor","in":"query","description":"Opaque pagination cursor from a previous response.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max items per page (default 50, max 200).","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"type","in":"query","description":"Filter by voice type: `personal` (the workspace's cloned voices)\nor `shared` (the public catalogue). Omit to return both.","required":false,"schema":{"$ref":"#/components/schemas/V1VoicesGetParametersType"}},{"name":"locale","in":"query","description":"Filter to voices whose locale matches this BCP-47 language range,\nprefix-matched: `en` matches `en-US` and `en-GB`; `en-US` matches\nonly `en-US`. Case-insensitive. Omit to return all locales.","required":false,"schema":{"type":"string"}},{"name":"gender","in":"query","description":"Filter by voice gender. Omit to return all genders.","required":false,"schema":{"$ref":"#/components/schemas/V1VoicesGetParametersGender"}},{"name":"model","in":"query","description":"Filter to voices that support this model (as listed in each voice's\n`models[]`), e.g. `simba-3.2`. Omit to return voices for all models.","required":false,"schema":{"type":"string"}},{"name":"project_id","in":"query","description":"Filter cloned voices by workspace project: omit for every voice you\ncan reach, pass the literal `shared` for the clones no project\nfiled, or a `proj_...` id for the clones filed under that project.\nThe shared catalog carries no project and is returned either way.\n\nA clone is filed under a project when a project-pinned key created\nit. A clone with no project is shared with the whole workspace\nrather than sitting in a Default project, so the literal here is\n`shared`, never `default` - passing `default` is a 400. Returns 404\nproject_not_found for a malformed id and for any project outside\nyour reach: a project-pinned key reaches only its pinned project,\nand a member holding project grants reaches only the granted ones.\nThat 404 is the same in every case and does not reveal whether such\na project exists. `shared` is always inside your reach.\n","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The voice catalogue (or a page of it when `limit` is set).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVoicesResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The credential authenticated, but is not authorised for this\nresource - typically a workspace-role gate (owner / admin\nrequired) or a cross-tenant access attempt.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"create","summary":"Create Voice","description":"Create a cloned voice for the workspace from a 10-30 second audio sample, with verified consent from the speaker.\n\nCloning requires proof that the speaker agreed to it. Create a consent challenge with `POST /v1/voices/consent-challenges`, show the returned `phrase` to the speaker, record them reading it aloud, and send that recording here as `consent_recording` together with the challenge's `consent_challenge_id`. Speechify transcribes the recording, checks it against the phrase it issued, checks that its speaker is the speaker in your `sample`, and keeps it as the consent record for the voice. The person consenting therefore has to be the person being cloned. A challenge is single use and short-lived, so record and submit in one sitting.\n\nThe clone belongs to the workspace rather than the member who created it, and access follows the caller's workspace role and API-key scopes exactly as for any other voice: voices scopes to list it, audio scopes to synthesize with it, and the content-management permission plus a write scope on the key to delete it. Cloned voices are usable self-serve on `simba-3.0` (and, on a workspace pinned before API version `2026-09-21`, on the retired `simba-english` and `simba-multilingual` until they are switched off on 2026-11-21). `simba-3.2` also serves cloned voices.\n\nCallers pinned before `Speechify-Version: 2026-09-13` use the previous flow instead: no challenge, and a `consent` form field carrying the speaker's name and email as a JSON string. That flow is deprecated and will be removed after a sunset window announced in the changelog.","tags":["voices"],"parameters":[{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"A client-generated key (an opaque string, max 255 chars) that makes a\nside-effect POST safe to retry: the server runs the operation exactly\nonce and replays the first response (its status and body) for 24 hours.\nReusing a key with a different request body, or while the first request\nis still in flight, returns `409 idempotency_conflict`. A replayed\nresponse carries the `Idempotent-Replayed: true` header.\n","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"A created voice","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVoice"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"The workspace has insufficient credits, or the request needs a\nplan tier the workspace is not on (e.g. voice cloning). Distinct\nfrom `Forbidden` so SDK consumers can drive upgrade UX.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The credential authenticated, but is not authorised for this\nresource - typically a workspace-role gate (owner / admin\nrequired) or a cross-tenant access attempt.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Request body exceeded a per-endpoint size limit (e.g. KB\ndocument upload cap, batch-call CSV cap, audio-asset WAV cap).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The request was well-formed but semantically rejected -\ntypically a referential integrity violation (e.g. flow node\nreferences an audio asset in another workspace) or a state\nmachine refusal.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"An upstream dependency (the TTS composer or voice-metadata\nservice) returned a 5xx. The raw upstream detail is not\nforwarded - the cause is in the server log; the response is a\nfixed `upstream_failure` envelope. Safe to retry.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"A downstream dependency is degraded or the endpoint is\nintentionally disabled (e.g. phone-number purchase before\nops setup).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the personal voice"},"locale":{"type":"string","default":"en-US","description":"Native language (locale) of the personal voice (e.g. en-US, es-ES, etc.)"},"gender":{"$ref":"#/components/schemas/V1VoicesPostRequestBodyContentMultipartFormDataSchemaGender","description":"Gender marker for the personal voice\nmale GenderMale\nfemale GenderFemale\nnot_specified GenderNotSpecified"},"sample":{"type":"string","format":"binary","description":"Audio sample of the voice to clone, 10-30 seconds of clean speech."},"avatar":{"type":"string","format":"binary","description":"Avatar image file"},"consent_challenge_id":{"type":"string","description":"The `id` of the consent challenge this create consumes, from\n`POST /v1/voices/consent-challenges`. Single use: once a\ncreate has consumed it, whether or not that create\nsucceeded, it cannot be used again."},"consent_recording":{"type":"string","format":"binary","description":"Recording of the speaker reading the challenge's `phrase`\naloud. This is the consent record for the voice, not a\nsecond voice sample: it must be the same person as in\n`sample`, and it is retained as evidence. 5-30 seconds, at\nmost 25 MB, in any common audio container."}},"required":["name","gender","sample","consent_challenge_id","consent_recording"]}}}}}},"/v1/voices/consent-challenges":{"post":{"operationId":"create","summary":"Create Consent Challenge","description":"Start the consent check for a voice clone.\n\nReturns a `phrase` for the speaker to read aloud and an `id` that identifies this challenge. Show the phrase to the speaker exactly as returned, record them reading it, then send the recording and the `id` to `POST /v1/voices`, which verifies the recording against the phrase and against the voice sample being cloned, then keeps it as the consent record.\n\nA challenge is single use, is bound to the workspace that created it, and expires at `expires_at` - it is proof that a speaker was in front of a microphone just now, so create it when you are ready to record, not at the start of your flow. If it expires, create another one and record again.\n\nChallenge creation is rate limited per workspace at a few dozen per hour, far more tightly than the rest of the voice surface, because each one precedes a person recording themselves - mint it when your speaker is ready, not speculatively. Read the live ceiling off `RateLimit-*` rather than hard-coding it. **On a `429`, always honour `Retry-After` rather than a fixed backoff of your own**: the wait is measured in minutes and can run to most of an hour. `RateLimit-*` are omitted rather than reporting a bucket that is not the one refusing.","tags":["consentChallenges"],"parameters":[{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"A client-generated key (an opaque string, max 255 chars) that makes a\nside-effect POST safe to retry: the server runs the operation exactly\nonce and replays the first response (its status and body) for 24 hours.\nReusing a key with a different request body, or while the first request\nis still in flight, returns `409 idempotency_conflict`. A replayed\nresponse carries the `Idempotent-Replayed: true` header.\n","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"The created consent challenge.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentChallenge"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"The workspace has insufficient credits, or the request needs a\nplan tier the workspace is not on (e.g. voice cloning). Distinct\nfrom `Forbidden` so SDK consumers can drive upgrade UX.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The credential authenticated, but is not authorised for this\nresource - typically a workspace-role gate (owner / admin\nrequired) or a cross-tenant access attempt.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"An upstream dependency (the TTS composer or voice-metadata\nservice) returned a 5xx. The raw upstream detail is not\nforwarded - the cause is in the server log; the response is a\nfixed `upstream_failure` envelope. Safe to retry.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"A downstream dependency is degraded or the endpoint is\nintentionally disabled (e.g. phone-number purchase before\nops setup).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConsentChallengeRequest"}}}}}},"/v1/voices/{voice_id}":{"get":{"operationId":"get","summary":"Get Voice","description":"Fetch a single voice by id - a shared catalogue voice or one of\nthe workspace's cloned voices. A cloned voice that belongs to\nanother workspace returns 404, identical to an unknown id, so\nvoice inventory is never enumerable across tenants.","tags":["voices"],"parameters":[{"name":"voice_id","in":"path","description":"The ID of the voice to fetch","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The voice.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVoice"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"An upstream dependency (the TTS composer or voice-metadata\nservice) returned a 5xx. The raw upstream detail is not\nforwarded - the cause is in the server log; the response is a\nfixed `upstream_failure` envelope. Safe to retry.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"A downstream dependency is degraded or the endpoint is\nintentionally disabled (e.g. phone-number purchase before\nops setup).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"delete","summary":"Delete Voice","description":"Delete one of the workspace's cloned voices. Requires the\n`content.manage` permission (owner, admin, or member); a\nservice-account key is authorized by its scopes instead.","tags":["voices"],"parameters":[{"name":"voice_id","in":"path","description":"The ID of the voice to delete","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Voice deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The credential authenticated, but is not authorised for this\nresource - typically a workspace-role gate (owner / admin\nrequired) or a cross-tenant access attempt.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"An upstream dependency (the TTS composer or voice-metadata\nservice) returned a 5xx. The raw upstream detail is not\nforwarded - the cause is in the server log; the response is a\nfixed `upstream_failure` envelope. Safe to retry.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"A downstream dependency is degraded or the endpoint is\nintentionally disabled (e.g. phone-number purchase before\nops setup).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/voices/{voice_id}/sample":{"get":{"operationId":"downloadSample","summary":"Download Voice Sample","description":"Download a personal (cloned) voice sample","tags":["voices"],"parameters":[{"name":"voice_id","in":"path","description":"The ID of the voice to download sample for","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Voice sample audio file","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The credential authenticated, but is not authorised for this\nresource - typically a workspace-role gate (owner / admin\nrequired) or a cross-tenant access attempt.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"An upstream dependency (the TTS composer or voice-metadata\nservice) returned a 5xx. The raw upstream detail is not\nforwarded - the cause is in the server log; the response is a\nfixed `upstream_failure` envelope. Safe to retry.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"A downstream dependency is degraded or the endpoint is\nintentionally disabled (e.g. phone-number purchase before\nops setup).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/audio/models":{"get":{"operationId":"list","summary":"List Models","description":"List the text-to-speech models available for synthesis. Drive a model\npicker from this response, then pass a model `id` as the `model`\nparameter to POST /v1/audio/speech or /v1/audio/stream. The response\nmarks the default model (used when a request omits `model`), the\nroutes each model may be passed to, and which voices it accepts.\nMulti-speaker models arrive in a separate `dialogue_models` array\nbecause they are valid only on POST /v1/audio/dialogue. Returns\nthe full set in a single response: the model catalog is static\nplatform reference data, so it is intentionally not paginated.","tags":["models"],"parameters":[{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The available text-to-speech models.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelsResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The credential authenticated, but is not authorised for this\nresource - typically a workspace-role gate (owner / admin\nrequired) or a cross-tenant access attempt.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/audio/watermark/detect":{"post":{"operationId":"detect","summary":"Detect Watermark","description":"Check whether a clip carries the watermark Speechify seals into audio it\ngenerates. Upload the audio as `audio`; nothing about it is stored, and\nno voice is read or written.\n\nRead the answer carefully in one direction. A `watermarked: true` is\npositive evidence that the audio came from Speechify synthesis. A\n`watermarked: false` is NOT proof that it did not: only models\nredeployed since the watermark shipped mark their output, the detector\nneeds at least three seconds of clear speech to judge, and re-encoding\nor changing the speed of a clip degrades the mark. Treat a negative as\nthe absence of evidence rather than as evidence of absence.\n\nChecks are rate-limited well below the synthesis budget: this is a\nforensic question, not a data-plane call.","tags":["watermark"],"parameters":[{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The clip was checked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatermarkDetectionResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The credential authenticated, but is not authorised for this\nresource - typically a workspace-role gate (owner / admin\nrequired) or a cross-tenant access attempt.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Request body exceeded a per-endpoint size limit (e.g. KB\ndocument upload cap, batch-call CSV cap, audio-asset WAV cap).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The request was well-formed but semantically rejected -\ntypically a referential integrity violation (e.g. flow node\nreferences an audio asset in another workspace) or a state\nmachine refusal.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"An upstream dependency (the TTS composer or voice-metadata\nservice) returned a 5xx. The raw upstream detail is not\nforwarded - the cause is in the server log; the response is a\nfixed `upstream_failure` envelope. Safe to retry.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"audio":{"type":"string","format":"binary","description":"The clip to check, at most 25MB. Give the detector at least\nthree seconds of clear speech; below that its confidence is\nnot worth acting on, and below half a second it always\nreports zero."}},"required":["audio"]}}}}}},"/v1/audio/watermark/verify":{"post":{"operationId":"verify","summary":"Verify Watermark","description":"The public AI detection tool. Ask whether a clip carries the watermark\nSpeechify seals into audio it generates, with no account, no API key and\nno credential of any kind.\n\n`verify` answers; `detect` measures. This route returns a bare yes or no,\nthe way verifying a signature does. Its sibling\n`POST /v1/audio/watermark/detect` takes an API key and returns the\ndetector's confidence alongside the verdict.\n\nThis is the programmatic half of the tool published at\n, and it exists so the tool can be invoked\nwithout visiting our website, as California's AI Transparency Act\n(BPC 22757.2) requires. Nothing about the clip is stored, and nothing\nidentifying about you is collected or retained.\n\nThe answer is a bare verdict. `watermarked: true` is positive evidence\nthat the audio came from Speechify synthesis. `watermarked: false` is\nNOT proof that it did not: only models redeployed since the watermark\nshipped mark their output, the detector needs at least three seconds of\nclear speech to judge, and re-encoding or changing the speed of a clip\ndegrades the mark. Treat a negative as the absence of evidence rather\nthan as evidence of absence.\n\nBecause the tool takes no credential, it is rate-limited per client\naddress and shares a platform-wide budget: expect a 429 under sustained\nautomated use, and retry after the interval the response advertises.\nUse `POST /v1/audio/watermark/detect` with an API key for the detector's\nconfidence score and a per-workspace allowance of its own.","tags":["watermark"],"parameters":[{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The clip was checked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatermarkVerificationResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Request body exceeded a per-endpoint size limit (e.g. KB\ndocument upload cap, batch-call CSV cap, audio-asset WAV cap).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The request was well-formed but semantically rejected -\ntypically a referential integrity violation (e.g. flow node\nreferences an audio asset in another workspace) or a state\nmachine refusal.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"502":{"description":"An upstream dependency (the TTS composer or voice-metadata\nservice) returned a 5xx. The raw upstream detail is not\nforwarded - the cause is in the server log; the response is a\nfixed `upstream_failure` envelope. Safe to retry.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"audio":{"type":"string","format":"binary","description":"The clip to check, at most 25MB. Give the detector at least\nthree seconds of clear speech; below that its answer is not\nworth acting on."}},"required":["audio"]}}}}}},"/v1/agents":{"get":{"operationId":"list","summary":"List Agents","description":"List voice agents owned by the caller. Cursor-paginated: omit\n`cursor` for the first page; walk pages while `has_more` is true\n(default page size 50, max 200).","tags":["agent"],"parameters":[{"name":"cursor","in":"query","description":"Opaque pagination cursor from a previous response.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max items per page (default 50, max 200).","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"project_id","in":"query","description":"Filter by workspace project: omit for every project you can reach,\npass the literal `default` for resources in the implicit Default\nproject only, or a `proj_...` id for that project's resources.\nReturns 404 project_not_found for a malformed id and for any filter\noutside your reach: a project-pinned API key or service-account key\nreaches only its pinned project, and a member holding project grants\nreaches only the granted projects, so neither can name `default`.\nThat 404 is the same in every case and does not reveal whether such\na project exists - outside your reach a project is answered as\nnonexistent, never as forbidden. Inside it, a well-formed id that\nmatches no project yields an empty page.\n","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of voice agents.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAgentsResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"create","summary":"Create Agent","description":"Create a voice agent.\n\nThe agent lands in the project named by `project_id`, or in the\nimplicit Default project when none is given. Each project holds at\nmost a fixed number of live agents; a create past that answers\n`409 agent_limit_reached` naming the ceiling, and deleting an agent\nin that project - or creating this one in another - frees a slot.\n","tags":["agent"],"parameters":[{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"The created agent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentRequest"}}}}}},"/v1/agents/voices":{"get":{"operationId":"listAgentVoices","summary":"List Agent Voices","description":"List the voice catalogue available for voice agents: the curated\nshared catalogue plus your workspace's own cloned voices, each\nmarked by `type` (`shared` or `personal`). The same slug set is\naccepted by POST/PATCH /v1/agents, so any voice listed here can be\nassigned to an agent. Cloned voices are workspace-owned only - a\npersonal voice scoped to an individual is not selectable on an\nagent, which is a workspace-shared resource. The JSON layout\nintentionally mirrors the TTS `/v1/voices` shape so a single voice\npicker can consume both endpoints.\n\nCursor-paginated: pass `cursor` + `limit` and walk pages while\n`has_more` is true. From API version `2026-08-07` an omitted `limit`\nreturns the first page (default 50, max 200); a caller pinned before\nthat date keeps the historical whole-catalogue response until it opts\nin. The shared catalogue is served first, then your cloned voices.\n","tags":["agent"],"parameters":[{"name":"cursor","in":"query","description":"Opaque pagination cursor from a previous response.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max items per page (default 50, max 200).","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The curated agent voice catalogue.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAgentVoicesResponse"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/tts-models":{"get":{"operationId":"listTTSModels","summary":"List Agent TTS Models","description":"List the Simba text-to-speech models a voice agent can be pinned to\nwith `tts.model`.\n\nThe response is the whole catalog and is the same for every\nworkspace - which model serves an agent is a routing decision, not\nan entitlement, so nothing here is plan-gated. Whether a *particular*\nagent may select an entry depends on two facts this response\npublishes rather than resolving for you, because both change without\nthis list changing:\n\n- `english_only` - the model has no multilingual deployment, so an\n agent that declares `additional_languages` (or whose `language` is\n not English) cannot select it.\n- `requires_voice_curation` - a voice must be registered for the\n model before it can be selected with that voice. The voice's\n `models` array on GET /v1/agents/voices is the per-voice answer,\n and it changes as voices are curated, with no release here. It is\n false for a model offered across the catalog, which every Speechify\n voice can then select.\n\nDrive a model picker from this and the voice catalog together and it\ncan only offer combinations POST/PATCH /v1/agents will accept.\nReturns the full set in one response: bounded by the platform's\ncurated model catalog, so it is intentionally not paginated.\n","tags":["agent"],"parameters":[{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The TTS models selectable for voice agents.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTTSModelsResponse"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/{agent_id}":{"delete":{"operationId":"delete","summary":"Delete Agent","description":"Delete an agent, and with it everything that belonged only to that\nagent.\n\n**Goes with the agent**, immediately unreadable through every\nendpoint: its runs and their step journals and approvals, its\nconversations and the transcripts, messages and recordings inside\nthem, what it learned about the people it spoke to, its triggers,\nshare links, channel bindings, team memberships and the batch\ncampaigns it dialled. A run that has not settled is asked to stop,\nincluding one parked waiting on a person or on a delegated child. These are removed for good 30 days\nlater; until then the delete can still be walked back by support.\n\n**Survives the agent**, because it belongs to the workspace rather\nthan to this agent: attached tools, knowledge bases, stores and\nskills (only the attachment is dropped), the agent's tests, phone\nnumbers, and the teams it belonged to.\n\n**Kept regardless**, because it is accounting rather than content:\nthe usage the workspace was billed for.\n\nRefused with `409 agent_in_use` while a live phone number still\nroutes to the agent, including the agent a webhook binding\nprovisioned for its number; `used_by` names the numbers. Unbind them\n(`DELETE /v1/agents/{agent_id}/phone-numbers/{phone_number_id}`,\nwhich also clears a webhook binding) and the delete proceeds.\n","tags":["agent"],"parameters":[{"name":"agent_id","in":"path","description":"Agent id (prefixed external id, `agent_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Agent deleted.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"A live phone number still routes to the agent. `used_by` names\nthem so the caller can unbind first.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentInUseError"}}}}}},"get":{"operationId":"get","summary":"Get Agent","description":"Retrieve a voice agent by ID.","tags":["agent"],"parameters":[{"name":"agent_id","in":"path","description":"Agent id (prefixed external id, `agent_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested agent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"operationId":"update","summary":"Update Agent","description":"Update a voice agent. Only fields present on the request body are changed.","tags":["agent"],"parameters":[{"name":"agent_id","in":"path","description":"Agent id (prefixed external id, `agent_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The updated agent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentRequest"}}}}}},"/v1/agents/{agent_id}/widget-config":{"get":{"operationId":"getWidgetConfig","summary":"Get Agent Widget Config","description":"Return the embed-widget appearance config for an agent. Works\nunauthenticated for public agents; the body is cosmetic only.\n","tags":["agent"],"parameters":[{"name":"agent_id","in":"path","description":"Prefixed agent id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The agent's widget configuration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WidgetConfig"}}}},"403":{"description":"The credential authenticated, but is not authorised for this\nresource - typically a workspace-role gate (owner / admin\nrequired) or a cross-tenant access attempt.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/flow/schema":{"get":{"operationId":"getSchema","summary":"Get Flow Graph Schema","description":"Return the JSON Schema describing the flow graph node taxonomy.\nUnauthenticated; flow editors fetch it to validate graphs client-side.\n","tags":["flow"],"parameters":[{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A JSON Schema document for the flow graph.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/agent_flow_getSchema_Response_200"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/{agent_id}/flow":{"get":{"operationId":"getFlow","summary":"Get Agent Flow","description":"Return the agent's flow graph: the current draft (if any), the\nactive published graph (if any), and the version history.\n","tags":["flow"],"parameters":[{"name":"agent_id","in":"path","description":"Prefixed agent id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The draft graph, active graph, and version history.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFlowResponse"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"updateFlow","summary":"Update Agent Flow Draft","description":"Replace the agent's draft flow graph. The graph is validated\nbefore it is stored; publish it separately to make it active.\n","tags":["flow"],"parameters":[{"name":"agent_id","in":"path","description":"Prefixed agent id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The stored draft graph.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowGraph"}}}},"400":{"description":"Flow validation failed (or the request body was undecodable). The\nstandard `Error` envelope plus an `issues` array locating each problem\nfor the editor. See the `FlowValidationError` schema.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowValidationError"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutFlowRequest"}}}}}},"/v1/agents/{agent_id}/flow/publish":{"post":{"operationId":"publish","summary":"Publish Agent Flow","description":"Publish the agent's draft graph as a new active flow version.","tags":["flow"],"parameters":[{"name":"agent_id","in":"path","description":"Prefixed agent id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The newly published flow version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowVersion"}}}},"400":{"description":"Flow validation failed (or the request body was undecodable). The\nstandard `Error` envelope plus an `issues` array locating each problem\nfor the editor. See the `FlowValidationError` schema.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowValidationError"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The behavioral-eval publish gate refused the publish\n(`agent_publish_gate_failed`): the agent's configured suite did not\npass. `error.details` carries the verdict (per-case, per-criterion).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The publish checks could not run (`agent_publish_gate_unavailable`):\nthe eval worker, the judge or the probe corpus errored, so nothing\nabout the agent was judged. Not a verdict on the configuration; retry\nafter `Retry-After`. `error.details` lists the cases that could not\nrun.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishFlowRequest"}}}}}},"/v1/agents/{agent_id}/flow/rollback":{"post":{"operationId":"rollback","summary":"Roll Back Agent Flow","description":"Publish a prior flow version as the active graph.","tags":["flow"],"parameters":[{"name":"agent_id","in":"path","description":"Prefixed agent id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The flow version that is now active.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowVersion"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"The behavioral-eval publish gate refused the rollback\n(`agent_publish_gate_failed`): the target version did not pass the\nagent's configured suite. `error.details` carries the verdict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The gate's checks could not run on the rollback target\n(`agent_publish_gate_unavailable`): the eval worker, the judge or\nthe probe corpus errored, so nothing about the version was judged.\nNot a verdict on it; retry after `Retry-After`. `error.details`\nlists the cases that could not run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollbackFlowRequest"}}}}}},"/v1/agents/{agent_id}/flow/deactivate":{"post":{"operationId":"deactivate","summary":"Deactivate Agent Flow","description":"Deactivate the agent's published flow so the agent runs the synthesized default flow.","tags":["flow"],"parameters":[{"name":"agent_id","in":"path","description":"Prefixed agent id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Flow deactivated.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/{agent_id}/flow/draft":{"delete":{"operationId":"discardDraft","summary":"Discard Agent Flow Draft","description":"Discard the agent's unpublished draft flow graph.","tags":["flow"],"parameters":[{"name":"agent_id","in":"path","description":"Prefixed agent id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Draft discarded.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/{agent_id}/flow/versions":{"get":{"operationId":"listVersions","summary":"List Agent Flow Versions","description":"List every published flow version for the agent, newest first.\nCursor-paginated: omit `cursor` for the first page; walk pages\nwhile `has_more` is true (default page size 50, max 200).","tags":["flow"],"parameters":[{"name":"agent_id","in":"path","description":"Prefixed agent id.","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Opaque pagination cursor from a previous response.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max items per page (default 50, max 200).","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The agent's flow version history.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFlowVersionsResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/{agent_id}/flow/versions/{version_id}":{"get":{"operationId":"getVersion","summary":"Get Agent Flow Version","description":"Return the full flow graph for a specific published version.","tags":["flow"],"parameters":[{"name":"agent_id","in":"path","description":"Prefixed agent id.","required":true,"schema":{"type":"string"}},{"name":"version_id","in":"path","description":"Prefixed flow version id (`fver_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested flow version's graph.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowGraph"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/flow/templates":{"get":{"operationId":"listTemplates","summary":"List Flow Templates","description":"List the reusable flow templates available to the workspace.\nCursor-paginated: omit `cursor` for the first page; walk pages\nwhile `has_more` is true (default page size 50, max 200).","tags":["flow"],"parameters":[{"name":"cursor","in":"query","description":"Opaque pagination cursor from a previous response.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max items per page (default 50, max 200).","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The available flow templates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFlowTemplatesResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"createTemplate","summary":"Create Flow Template","description":"Create a reusable flow template from a graph.","tags":["flow"],"parameters":[{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"The created flow template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowTemplate"}}}},"400":{"description":"Flow validation failed (or the request body was undecodable). The\nstandard `Error` envelope plus an `issues` array locating each problem\nfor the editor. See the `FlowValidationError` schema.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowValidationError"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFlowTemplateRequest"}}}}}},"/v1/agents/flow/templates/{flow_template_id}":{"get":{"operationId":"getTemplate","summary":"Get Flow Template","description":"Retrieve a flow template by id.","tags":["flow"],"parameters":[{"name":"flow_template_id","in":"path","description":"Flow template id (prefixed external id, `tmpl_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested flow template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowTemplate"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"updateTemplate","summary":"Update Flow Template","description":"Replace a flow template. The whole template is replaced, not patched field-by-field.","tags":["flow"],"parameters":[{"name":"flow_template_id","in":"path","description":"Flow template id (prefixed external id, `tmpl_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The updated flow template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowTemplate"}}}},"400":{"description":"Flow validation failed (or the request body was undecodable). The\nstandard `Error` envelope plus an `issues` array locating each problem\nfor the editor. See the `FlowValidationError` schema.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowValidationError"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFlowTemplateRequest"}}}}},"delete":{"operationId":"deleteTemplate","summary":"Delete Flow Template","description":"Delete a flow template.","tags":["flow"],"parameters":[{"name":"flow_template_id","in":"path","description":"Flow template id (prefixed external id, `tmpl_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Template deleted.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/flow/templates/{flow_template_id}/clone":{"post":{"operationId":"cloneTemplate","summary":"Clone Flow Template","description":"Clone a flow template onto an agent as a new draft graph.","tags":["flow"],"parameters":[{"name":"flow_template_id","in":"path","description":"Flow template id (prefixed external id, `tmpl_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The agent's new draft graph.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowGraph"}}}},"400":{"description":"Flow validation failed (or the request body was undecodable). The\nstandard `Error` envelope plus an `issues` array locating each problem\nfor the editor. See the `FlowValidationError` schema.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowValidationError"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"An unexpected server-side error occurred. Safe to retry with\nexponential backoff for idempotent requests.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloneFlowTemplateRequest"}}}}}},"/v1/agents/{agent_id}/evaluation-config":{"get":{"operationId":"getEvaluationConfig","summary":"Get Evaluation Config","description":"Retrieve the agent's post-call evaluation criteria + data-collection config.","tags":["agent"],"parameters":[{"name":"agent_id","in":"path","description":"Agent id (prefixed external id, `agent_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The evaluation config for the agent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationConfig"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"updateEvaluationConfig","summary":"Update Evaluation Config","description":"Replace the agent's evaluation criteria + data-collection fields.","tags":["agent"],"parameters":[{"name":"agent_id","in":"path","description":"Agent id (prefixed external id, `agent_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The updated evaluation config.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationConfig"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEvaluationConfigRequest"}}}}}},"/v1/agents/{agent_id}/variables":{"get":{"operationId":"getDynamicVariables","summary":"Get Dynamic Variables","description":"Retrieve the agent's customer-scope dynamic variables and the read-only\ncatalogue of reserved `system__*` keys. The system variables list is\nprovided so editor UIs can render the reference list without maintaining\na client-side copy of the catalogue.\n","tags":["agent"],"parameters":[{"name":"agent_id","in":"path","description":"Agent id (prefixed external id, `agent_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The agent's variable catalogue.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDynamicVariablesResponse"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"updateDynamicVariables","summary":"Update Dynamic Variables","description":"Replace the agent's customer-scope dynamic variable definitions.\nThe supplied list overwrites the stored list wholesale (same\nsemantics as `updateEvaluationConfig`). Pass an empty array to\nclear all variables. Up to 20 variables per agent. Keys must\nmatch `[a-zA-Z0-9_]+` and must not start with the reserved\n`system__` prefix.\n","tags":["agent"],"parameters":[{"name":"agent_id","in":"path","description":"Agent id (prefixed external id, `agent_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The updated variable catalogue.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDynamicVariablesResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDynamicVariablesRequest"}}}}}},"/v1/agents/{agent_id}/conversations":{"post":{"operationId":"createConversation","summary":"Create Conversation","description":"Start a new voice conversation with the agent. Returns a realtime\nvoice session + short-lived client token so the caller can\nconnect the audio pipeline directly. The agent is dispatched\nserver-side; no additional client action required.\n\nPass `dynamic_variables` to supply per-session values that override\nthe agent's stored variable defaults for this one conversation.\nKeys in the `system__` namespace are rejected at this boundary.\n\nPass `user_identity` as the stable caller key your application uses\nfor memory and caller correlation. It is kept separate from the\nopaque, per-session realtime participant identity.\n\n`overrides.voice_id` replaces the configured voice for the entire\nconversation, including every configured language the voice can\nserve. The request is rejected when the voice is unavailable or\ncannot cover the agent's configured language set; the rejection\nnames `overrides.voice_id` in the error envelope's `fields` map.\nThe override belongs to this conversation only: if the call is\ntransferred to another agent mid-conversation, that agent speaks\nwith its own configured voice.\n","tags":["agent"],"parameters":[{"name":"agent_id","in":"path","description":"Agent id (prefixed external id, `agent_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"A client-generated key (an opaque string, max 255 chars) that makes a\nside-effect POST safe to retry: the server runs the operation exactly\nonce and replays the first response (its status and body) for 24 hours.\nReusing a key with a different request body, or while the first request\nis still in flight, returns `409 idempotency_conflict`. A replayed\nresponse carries the `Idempotent-Replayed: true` header.\n","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"The created conversation with its realtime session token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversationResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversationRequest"}}}}}},"/v1/agents/{agent_id}/sessions":{"post":{"operationId":"createSession","summary":"Create Session","description":"Mint a realtime voice session for the given agent. Widget-friendly\ncounterpart to `createConversation` \u2014 same response shape, dual\nauthentication:\n\n* **Authenticated (Bearer)**: works for any agent the caller\n owns. Typical server-to-server flow where the embedding\n site's backend mints a token and hands it to the browser so\n the API key never reaches the client.\n* **Unauthenticated**: works only when `agent.is_public = true`\n AND the request's `Origin` header matches `agent.allowed_origins`\n (or that list is empty). When `agent.hostname_allowlist` is\n non-empty, the `Origin` hostname must additionally be a\n member of that list. Used directly by the\n `` web component.\n\nResponds with the same `CreateConversationResponse` as\n`createConversation`.\n\n`Idempotency-Key` replay is scoped to the authenticated caller, so it\napplies to Bearer requests only: an unauthenticated mint has no scope\nto replay under, and retrying one mints a fresh session.\n","tags":["agent"],"parameters":[{"name":"agent_id","in":"path","description":"Agent id (prefixed external id, `agent_...`).","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"A client-generated key (an opaque string, max 255 chars) that makes a\nside-effect POST safe to retry: the server runs the operation exactly\nonce and replays the first response (its status and body) for 24 hours.\nReusing a key with a different request body, or while the first request\nis still in flight, returns `409 idempotency_conflict`. A replayed\nresponse carries the `Idempotent-Replayed: true` header.\n","required":false,"schema":{"type":"string","maxLength":255}}],"responses":{"201":{"description":"The created session with its realtime token + URL.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversationResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"The workspace has insufficient credits, or the request needs a\nplan tier the workspace is not on (e.g. voice cloning). Distinct\nfrom `Forbidden` so SDK consumers can drive upgrade UX.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The credential authenticated, but is not authorised for this\nresource - typically a workspace-role gate (owner / admin\nrequired) or a cross-tenant access attempt.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"The request conflicts with the current resource state - e.g.\nduplicate, optimistic-concurrency mismatch, or last-owner\nguard.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit or concurrency limit exceeded. `error.code` distinguishes\nrequest-rate limiting (`rate_limited`) from concurrency exhaustion\n(`concurrency_limit_reached`). Carries `Retry-After` and the\nrequest-rate budget headers; a concurrency-exhaustion 429 also carries\n`RateLimit-Remaining-Calls: 0`.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSessionRequest"}}}}}},"/v1/agents/conversations":{"get":{"operationId":"list","summary":"List Conversations","description":"List conversations owned by the caller, ordered by most recent.\nCursor-paginated: omit `cursor` to fetch the first page; pass the\nprevious response's `next_cursor` back to fetch the next page.\nWalk pages while `has_more` is true.\n\n`project_id` matches the project the call was DISPATCHED under, which\nis frozen when the conversation starts. Moving an agent to another\nproject therefore leaves its past calls attributed where they ran, the\nsame way per-project usage reports them.","tags":["conversations"],"parameters":[{"name":"cursor","in":"query","description":"Opaque pagination cursor from a previous response.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max items per page (default 50, max 200).","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"agent_id","in":"query","description":"Filter to conversations for this agent.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter by conversation status.","required":false,"schema":{"$ref":"#/components/schemas/ConversationStatus"}},{"name":"transport","in":"query","description":"Filter by transport.","required":false,"schema":{"$ref":"#/components/schemas/ConversationTransport"}},{"name":"caller_identity","in":"query","description":"Filter by caller identity.","required":false,"schema":{"type":"string"}},{"name":"contact_id","in":"query","description":"Narrow to one person's conversations, whichever agent or channel\nreached them. Prefixed `contact_...` id.\n","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Free-text search across conversation content.","required":false,"schema":{"type":"string"}},{"name":"started_after","in":"query","description":"Only conversations started at or after this RFC 3339 timestamp.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"started_before","in":"query","description":"Only conversations started at or before this RFC 3339 timestamp.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"duration_min_ms","in":"query","description":"Minimum conversation duration in milliseconds.","required":false,"schema":{"type":"integer"}},{"name":"duration_max_ms","in":"query","description":"Maximum conversation duration in milliseconds.","required":false,"schema":{"type":"integer"}},{"name":"project_id","in":"query","description":"Filter by workspace project: omit for every project you can reach,\npass the literal `default` for resources in the implicit Default\nproject only, or a `proj_...` id for that project's resources.\nReturns 404 project_not_found for a malformed id and for any filter\noutside your reach: a project-pinned API key or service-account key\nreaches only its pinned project, and a member holding project grants\nreaches only the granted projects, so neither can name `default`.\nThat 404 is the same in every case and does not reveal whether such\na project exists - outside your reach a project is answered as\nnonexistent, never as forbidden. Inside it, a well-formed id that\nmatches no project yields an empty page.\n","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of conversations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConversationsResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/conversations/{conversation_id}":{"get":{"operationId":"get","summary":"Get Conversation","description":"Retrieve a conversation by ID.","tags":["conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"Conversation id (prefixed external id, `conv_...`).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested conversation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/conversations/recent-callees":{"get":{"operationId":"recent_callees","summary":"List recent callees","description":"Distinct phone numbers the caller's workspace has dialled on\noutbound calls, ordered by most recent. Feeds the batch-calls\ncomposer's \"Suggested from history\" surface. Cursor-paginated:\nomit `cursor` to fetch the first page. Default page size is 50\nand max is 200. Walk pages while `has_more` is true.\n","tags":["conversations"],"parameters":[{"name":"cursor","in":"query","description":"Opaque pagination cursor from a previous response.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max items per page (default 50, max 200).","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Recent callees for the caller's workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRecentCalleesResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/conversations/stats":{"get":{"operationId":"stats","summary":"Conversation stats","description":"Aggregated counts and averages over the caller's conversations, scoped\nby the same filters as the list endpoint, `project_id` included.","tags":["conversations"],"parameters":[{"name":"agent_id","in":"query","description":"Filter to conversations for this agent.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Filter by conversation status.","required":false,"schema":{"$ref":"#/components/schemas/ConversationStatus"}},{"name":"transport","in":"query","description":"Filter by transport.","required":false,"schema":{"$ref":"#/components/schemas/ConversationTransport"}},{"name":"caller_identity","in":"query","description":"Filter by caller identity.","required":false,"schema":{"type":"string"}},{"name":"contact_id","in":"query","description":"Narrow to one person's conversations, whichever agent or channel\nreached them. Prefixed `contact_...` id.\n","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","description":"Free-text search across conversation content.","required":false,"schema":{"type":"string"}},{"name":"started_after","in":"query","description":"Only conversations started at or after this RFC 3339 timestamp.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"started_before","in":"query","description":"Only conversations started at or before this RFC 3339 timestamp.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"duration_min_ms","in":"query","description":"Minimum conversation duration in milliseconds.","required":false,"schema":{"type":"integer"}},{"name":"duration_max_ms","in":"query","description":"Maximum conversation duration in milliseconds.","required":false,"schema":{"type":"integer"}},{"name":"project_id","in":"query","description":"Filter by workspace project: omit for every project you can reach,\npass the literal `default` for resources in the implicit Default\nproject only, or a `proj_...` id for that project's resources.\nReturns 404 project_not_found for a malformed id and for any filter\noutside your reach: a project-pinned API key or service-account key\nreaches only its pinned project, and a member holding project grants\nreaches only the granted projects, so neither can name `default`.\nThat 404 is the same in every case and does not reveal whether such\na project exists - outside your reach a project is answered as\nnonexistent, never as forbidden. Inside it, a well-formed id that\nmatches no project yields an empty page.\n","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Stats for the matched conversations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationStats"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/conversations/{conversation_id}/messages":{"get":{"operationId":"listMessages","summary":"List Messages","description":"Retrieve the transcript for a conversation in started_at order\n(oldest first). Cursor-paginated: omit `cursor` to fetch the\nfirst page. Default page size is 50 and max is 200. Walk pages\nwhile `has_more` is true.","tags":["conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"Conversation id (prefixed external id, `conv_...`).","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Opaque pagination cursor from a previous response.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max items per page (default 50, max 200).","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"Authorization","in":"header","description":"Enter your API key with the `Bearer` prefix, e.g. 'Bearer sk_...'.","required":true,"schema":{"type":"string"}},{"name":"Speechify-Version","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The messages for the conversation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMessagesResponse"}}}},"400":{"description":"The request was malformed or failed validation. The response\nbody is the standard `Error` envelope; for validation\nfailures `error.fields` enumerates the offending fields as\na `path -> message` map (code = `validation_failed`).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Authentication is missing or invalid. The request did not\ncarry a recognised credential (console session token, API key,\nor worker JWT).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"The referenced resource does not exist or is not visible to\nthe caller's workspace.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/agents/conversations/{conversation_id}/recording":{"get":{"operationId":"streamRecording","summary":"Stream Recording","description":"Proxy the GCS-stored audio recording for a conversation through\nthe Cloud Run service identity. Returns OGG/Opus bytes (LiveKit\nroom-composite egress default). The response is streamed so a\nlong recording does not buffer in memory; `