diff --git a/src/libs/Speechify/Generated/Speechify.AgentClient.Create.g.cs b/src/libs/Speechify/Generated/Speechify.AgentClient.Create.g.cs index ab87381..097a95b 100644 --- a/src/libs/Speechify/Generated/Speechify.AgentClient.Create.g.cs +++ b/src/libs/Speechify/Generated/Speechify.AgentClient.Create.g.cs @@ -45,7 +45,12 @@ partial void ProcessCreateResponseContent( /// /// Create Agent
- /// Create a voice agent. + /// Create a voice agent.
+ /// The agent lands in the project named by `project_id`, or in the
+ /// implicit Default project when none is given. Each project holds at
+ /// most a fixed number of live agents; a create past that answers
+ /// `409 agent_limit_reached` naming the ceiling, and deleting an agent
+ /// in that project - or creating this one in another - frees a slot. /// /// /// @@ -71,7 +76,12 @@ partial void ProcessCreateResponseContent( } /// /// Create Agent
- /// Create a voice agent. + /// Create a voice agent.
+ /// The agent lands in the project named by `project_id`, or in the
+ /// implicit Default project when none is given. Each project holds at
+ /// most a fixed number of live agents; a create past that answers
+ /// `409 agent_limit_reached` naming the ceiling, and deleting an agent
+ /// in that project - or creating this one in another - frees a slot. /// /// /// @@ -426,6 +436,43 @@ partial void ProcessCreateResponseContent( h => h.Key, h => h.Value)); } + // The request conflicts with the current resource state - e.g. duplicate, optimistic-concurrency mismatch, or last-owner guard. + if ((int)__response.StatusCode == 409) + { + string? __content_409 = null; + global::System.Exception? __exception_409 = null; + global::Speechify.Error? __value_409 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_409 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_409 = global::Speechify.Error.FromJson(__content_409, JsonSerializerContext); + } + else + { + __content_409 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_409 = global::Speechify.Error.FromJson(__content_409, JsonSerializerContext); + } + } + catch (global::System.Exception __ex) + { + __exception_409 = __ex; + } + + + throw global::Speechify.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_409 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_409, + responseBody: __content_409, + responseObject: __value_409, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } if (__effectiveReadResponseAsString) { @@ -524,7 +571,12 @@ partial void ProcessCreateResponseContent( } /// /// Create Agent
- /// Create a voice agent. + /// Create a voice agent.
+ /// The agent lands in the project named by `project_id`, or in the
+ /// implicit Default project when none is given. Each project holds at
+ /// most a fixed number of live agents; a create past that answers
+ /// `409 agent_limit_reached` naming the ceiling, and deleting an agent
+ /// in that project - or creating this one in another - frees a slot. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.AgentClient.CreateTool.g.cs b/src/libs/Speechify/Generated/Speechify.AgentClient.CreateTool.g.cs index bf12d47..f892cfa 100644 --- a/src/libs/Speechify/Generated/Speechify.AgentClient.CreateTool.g.cs +++ b/src/libs/Speechify/Generated/Speechify.AgentClient.CreateTool.g.cs @@ -53,7 +53,13 @@ partial void ProcessCreateToolResponseContent( /// `kind=webhook`, `client`, or `mcp` this atomically creates a
/// workspace tool definition AND attaches it to the agent in one
/// call. To attach a definition that already exists, use
- /// `PUT /v1/agents/{agent_id}/tools/{tool_id}` instead. + /// `PUT /v1/agents/{agent_id}/tools/{tool_id}` instead.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -88,7 +94,13 @@ partial void ProcessCreateToolResponseContent( /// `kind=webhook`, `client`, or `mcp` this atomically creates a
/// workspace tool definition AND attaches it to the agent in one
/// call. To attach a definition that already exists, use
- /// `PUT /v1/agents/{agent_id}/tools/{tool_id}` instead. + /// `PUT /v1/agents/{agent_id}/tools/{tool_id}` instead.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -625,7 +637,13 @@ partial void ProcessCreateToolResponseContent( /// `kind=webhook`, `client`, or `mcp` this atomically creates a
/// workspace tool definition AND attaches it to the agent in one
/// call. To attach a definition that already exists, use
- /// `PUT /v1/agents/{agent_id}/tools/{tool_id}` instead. + /// `PUT /v1/agents/{agent_id}/tools/{tool_id}` instead.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.AgentClient.UpdateTool.g.cs b/src/libs/Speechify/Generated/Speechify.AgentClient.UpdateTool.g.cs index ec0d6d1..5828af1 100644 --- a/src/libs/Speechify/Generated/Speechify.AgentClient.UpdateTool.g.cs +++ b/src/libs/Speechify/Generated/Speechify.AgentClient.UpdateTool.g.cs @@ -54,7 +54,13 @@ partial void ProcessUpdateToolResponseContent( /// editable here — its shared config/name is edited on the
/// definition (`PATCH /v1/agents/tool-definitions/{tool_definition_id}`), since the
/// definition is referenced live by every agent it is attached to;
- /// attempting a shared-config edit here returns `tool_config_shared`. + /// attempting a shared-config edit here returns `tool_config_shared`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -91,7 +97,13 @@ partial void ProcessUpdateToolResponseContent( /// editable here — its shared config/name is edited on the
/// definition (`PATCH /v1/agents/tool-definitions/{tool_definition_id}`), since the
/// definition is referenced live by every agent it is attached to;
- /// attempting a shared-config edit here returns `tool_config_shared`. + /// attempting a shared-config edit here returns `tool_config_shared`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -631,7 +643,13 @@ partial void ProcessUpdateToolResponseContent( /// editable here — its shared config/name is edited on the
/// definition (`PATCH /v1/agents/tool-definitions/{tool_definition_id}`), since the
/// definition is referenced live by every agent it is attached to;
- /// attempting a shared-config edit here returns `tool_config_shared`. + /// attempting a shared-config edit here returns `tool_config_shared`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.ContactsClient.Delete.g.cs b/src/libs/Speechify/Generated/Speechify.ContactsClient.Delete.g.cs index b61ebe8..50c5fc6 100644 --- a/src/libs/Speechify/Generated/Speechify.ContactsClient.Delete.g.cs +++ b/src/libs/Speechify/Generated/Speechify.ContactsClient.Delete.g.cs @@ -62,15 +62,19 @@ partial void ProcessDeleteResponseContent( /// the variables, the output and every journalled step. The facts
/// extracted from either, and the copies frozen into past prompts, go
/// with them.
- /// A recording stops being served from the moment of the request, and a
- /// call still in progress can no longer append to its transcript, so a
- /// turn that lands after the erasure cannot put the person back.
- /// The stored audio itself is deleted 30 days later, not immediately.
- /// This is deliberate: an erasure that destroyed the bytes on request
- /// would be a way to erase evidence, so the recording stops being
- /// reachable at once and stays recoverable by us for the same 30 days a
- /// deleted agent or a purged project does. Absent an erasure, every
+ /// The transcript and the recording of a call both stop being readable
+ /// from the moment of the request, and a call still in progress can no
+ /// longer append to its transcript, so a turn that lands after the
+ /// erasure cannot put the person back.
+ /// Both are destroyed 30 days later, not immediately. This is
+ /// deliberate: an erasure that destroyed them on request would be a way
+ /// to erase evidence of what happened on the call, so they stop being
+ /// reachable at once and stay recoverable by us for the same 30 days a
+ /// deleted agent or a purged project does. Absent an erasure, a
/// recording is kept for one year from the call and removed after that.
+ /// `conversations_erased` and `messages_erased` count what stopped being
+ /// readable, which is what the request asked for; the rows behind them
+ /// are removed on the schedule above.
/// The identifiers are tombstoned as part of the purge, which is what
/// stops the person's phone number ever resolving again: a later merge
/// naming the purged contact moves rows that are already dead rather than
@@ -122,15 +126,19 @@ partial void ProcessDeleteResponseContent( /// the variables, the output and every journalled step. The facts
/// extracted from either, and the copies frozen into past prompts, go
/// with them.
- /// A recording stops being served from the moment of the request, and a
- /// call still in progress can no longer append to its transcript, so a
- /// turn that lands after the erasure cannot put the person back.
- /// The stored audio itself is deleted 30 days later, not immediately.
- /// This is deliberate: an erasure that destroyed the bytes on request
- /// would be a way to erase evidence, so the recording stops being
- /// reachable at once and stays recoverable by us for the same 30 days a
- /// deleted agent or a purged project does. Absent an erasure, every
+ /// The transcript and the recording of a call both stop being readable
+ /// from the moment of the request, and a call still in progress can no
+ /// longer append to its transcript, so a turn that lands after the
+ /// erasure cannot put the person back.
+ /// Both are destroyed 30 days later, not immediately. This is
+ /// deliberate: an erasure that destroyed them on request would be a way
+ /// to erase evidence of what happened on the call, so they stop being
+ /// reachable at once and stay recoverable by us for the same 30 days a
+ /// deleted agent or a purged project does. Absent an erasure, a
/// recording is kept for one year from the call and removed after that.
+ /// `conversations_erased` and `messages_erased` count what stopped being
+ /// readable, which is what the request asked for; the rows behind them
+ /// are removed on the schedule above.
/// The identifiers are tombstoned as part of the purge, which is what
/// stops the person's phone number ever resolving again: a later merge
/// naming the purged contact moves rows that are already dead rather than
diff --git a/src/libs/Speechify/Generated/Speechify.IAgentClient.Create.g.cs b/src/libs/Speechify/Generated/Speechify.IAgentClient.Create.g.cs index eddb946..0ad1d77 100644 --- a/src/libs/Speechify/Generated/Speechify.IAgentClient.Create.g.cs +++ b/src/libs/Speechify/Generated/Speechify.IAgentClient.Create.g.cs @@ -6,7 +6,12 @@ public partial interface IAgentClient { /// /// Create Agent
- /// Create a voice agent. + /// Create a voice agent.
+ /// The agent lands in the project named by `project_id`, or in the
+ /// implicit Default project when none is given. Each project holds at
+ /// most a fixed number of live agents; a create past that answers
+ /// `409 agent_limit_reached` naming the ceiling, and deleting an agent
+ /// in that project - or creating this one in another - frees a slot. /// /// /// @@ -21,7 +26,12 @@ public partial interface IAgentClient global::System.Threading.CancellationToken cancellationToken = default); /// /// Create Agent
- /// Create a voice agent. + /// Create a voice agent.
+ /// The agent lands in the project named by `project_id`, or in the
+ /// implicit Default project when none is given. Each project holds at
+ /// most a fixed number of live agents; a create past that answers
+ /// `409 agent_limit_reached` naming the ceiling, and deleting an agent
+ /// in that project - or creating this one in another - frees a slot. /// /// /// @@ -36,7 +46,12 @@ public partial interface IAgentClient global::System.Threading.CancellationToken cancellationToken = default); /// /// Create Agent
- /// Create a voice agent. + /// Create a voice agent.
+ /// The agent lands in the project named by `project_id`, or in the
+ /// implicit Default project when none is given. Each project holds at
+ /// most a fixed number of live agents; a create past that answers
+ /// `409 agent_limit_reached` naming the ceiling, and deleting an agent
+ /// in that project - or creating this one in another - frees a slot. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.IAgentClient.CreateTool.g.cs b/src/libs/Speechify/Generated/Speechify.IAgentClient.CreateTool.g.cs index 3deb2df..904eabe 100644 --- a/src/libs/Speechify/Generated/Speechify.IAgentClient.CreateTool.g.cs +++ b/src/libs/Speechify/Generated/Speechify.IAgentClient.CreateTool.g.cs @@ -12,7 +12,13 @@ public partial interface IAgentClient /// `kind=webhook`, `client`, or `mcp` this atomically creates a
/// workspace tool definition AND attaches it to the agent in one
/// call. To attach a definition that already exists, use
- /// `PUT /v1/agents/{agent_id}/tools/{tool_id}` instead. + /// `PUT /v1/agents/{agent_id}/tools/{tool_id}` instead.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -35,7 +41,13 @@ public partial interface IAgentClient /// `kind=webhook`, `client`, or `mcp` this atomically creates a
/// workspace tool definition AND attaches it to the agent in one
/// call. To attach a definition that already exists, use
- /// `PUT /v1/agents/{agent_id}/tools/{tool_id}` instead. + /// `PUT /v1/agents/{agent_id}/tools/{tool_id}` instead.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -58,7 +70,13 @@ public partial interface IAgentClient /// `kind=webhook`, `client`, or `mcp` this atomically creates a
/// workspace tool definition AND attaches it to the agent in one
/// call. To attach a definition that already exists, use
- /// `PUT /v1/agents/{agent_id}/tools/{tool_id}` instead. + /// `PUT /v1/agents/{agent_id}/tools/{tool_id}` instead.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.IAgentClient.UpdateTool.g.cs b/src/libs/Speechify/Generated/Speechify.IAgentClient.UpdateTool.g.cs index 2d64cb7..21dde73 100644 --- a/src/libs/Speechify/Generated/Speechify.IAgentClient.UpdateTool.g.cs +++ b/src/libs/Speechify/Generated/Speechify.IAgentClient.UpdateTool.g.cs @@ -11,7 +11,13 @@ public partial interface IAgentClient /// editable here — its shared config/name is edited on the
/// definition (`PATCH /v1/agents/tool-definitions/{tool_definition_id}`), since the
/// definition is referenced live by every agent it is attached to;
- /// attempting a shared-config edit here returns `tool_config_shared`. + /// attempting a shared-config edit here returns `tool_config_shared`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -35,7 +41,13 @@ public partial interface IAgentClient /// editable here — its shared config/name is edited on the
/// definition (`PATCH /v1/agents/tool-definitions/{tool_definition_id}`), since the
/// definition is referenced live by every agent it is attached to;
- /// attempting a shared-config edit here returns `tool_config_shared`. + /// attempting a shared-config edit here returns `tool_config_shared`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -59,7 +71,13 @@ public partial interface IAgentClient /// editable here — its shared config/name is edited on the
/// definition (`PATCH /v1/agents/tool-definitions/{tool_definition_id}`), since the
/// definition is referenced live by every agent it is attached to;
- /// attempting a shared-config edit here returns `tool_config_shared`. + /// attempting a shared-config edit here returns `tool_config_shared`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.IContactsClient.Delete.g.cs b/src/libs/Speechify/Generated/Speechify.IContactsClient.Delete.g.cs index bfdd6b6..5b6fe12 100644 --- a/src/libs/Speechify/Generated/Speechify.IContactsClient.Delete.g.cs +++ b/src/libs/Speechify/Generated/Speechify.IContactsClient.Delete.g.cs @@ -23,15 +23,19 @@ public partial interface IContactsClient /// the variables, the output and every journalled step. The facts
/// extracted from either, and the copies frozen into past prompts, go
/// with them.
- /// A recording stops being served from the moment of the request, and a
- /// call still in progress can no longer append to its transcript, so a
- /// turn that lands after the erasure cannot put the person back.
- /// The stored audio itself is deleted 30 days later, not immediately.
- /// This is deliberate: an erasure that destroyed the bytes on request
- /// would be a way to erase evidence, so the recording stops being
- /// reachable at once and stays recoverable by us for the same 30 days a
- /// deleted agent or a purged project does. Absent an erasure, every
+ /// The transcript and the recording of a call both stop being readable
+ /// from the moment of the request, and a call still in progress can no
+ /// longer append to its transcript, so a turn that lands after the
+ /// erasure cannot put the person back.
+ /// Both are destroyed 30 days later, not immediately. This is
+ /// deliberate: an erasure that destroyed them on request would be a way
+ /// to erase evidence of what happened on the call, so they stop being
+ /// reachable at once and stay recoverable by us for the same 30 days a
+ /// deleted agent or a purged project does. Absent an erasure, a
/// recording is kept for one year from the call and removed after that.
+ /// `conversations_erased` and `messages_erased` count what stopped being
+ /// readable, which is what the request asked for; the rows behind them
+ /// are removed on the schedule above.
/// The identifiers are tombstoned as part of the purge, which is what
/// stops the person's phone number ever resolving again: a later merge
/// naming the purged contact moves rows that are already dead rather than
@@ -73,15 +77,19 @@ public partial interface IContactsClient /// the variables, the output and every journalled step. The facts
/// extracted from either, and the copies frozen into past prompts, go
/// with them.
- /// A recording stops being served from the moment of the request, and a
- /// call still in progress can no longer append to its transcript, so a
- /// turn that lands after the erasure cannot put the person back.
- /// The stored audio itself is deleted 30 days later, not immediately.
- /// This is deliberate: an erasure that destroyed the bytes on request
- /// would be a way to erase evidence, so the recording stops being
- /// reachable at once and stays recoverable by us for the same 30 days a
- /// deleted agent or a purged project does. Absent an erasure, every
+ /// The transcript and the recording of a call both stop being readable
+ /// from the moment of the request, and a call still in progress can no
+ /// longer append to its transcript, so a turn that lands after the
+ /// erasure cannot put the person back.
+ /// Both are destroyed 30 days later, not immediately. This is
+ /// deliberate: an erasure that destroyed them on request would be a way
+ /// to erase evidence of what happened on the call, so they stop being
+ /// reachable at once and stay recoverable by us for the same 30 days a
+ /// deleted agent or a purged project does. Absent an erasure, a
/// recording is kept for one year from the call and removed after that.
+ /// `conversations_erased` and `messages_erased` count what stopped being
+ /// readable, which is what the request asked for; the rows behind them
+ /// are removed on the schedule above.
/// The identifiers are tombstoned as part of the purge, which is what
/// stops the person's phone number ever resolving again: a later merge
/// naming the purged contact moves rows that are already dead rather than
diff --git a/src/libs/Speechify/Generated/Speechify.IProjectsClient.Update.g.cs b/src/libs/Speechify/Generated/Speechify.IProjectsClient.Update.g.cs index 40a5963..b18ed69 100644 --- a/src/libs/Speechify/Generated/Speechify.IProjectsClient.Update.g.cs +++ b/src/libs/Speechify/Generated/Speechify.IProjectsClient.Update.g.cs @@ -59,6 +59,14 @@ public partial interface IProjectsClient /// /// /// + /// + /// Sets the project's concurrent-run ceiling; `null` removes it.
+ /// Must be a positive integer at or below the workspace's own run
+ /// ceiling, otherwise the request is refused with
+ /// `400 validation_failed` naming the field and the ceiling.
+ /// Requires the `billing.manage` permission. Takes effect on the
+ /// next run start attributed to the project. + /// /// /// Sets the project's active-call ceiling; `null` removes it.
/// Must be a positive integer at or below the workspace's own
@@ -101,6 +109,7 @@ public partial interface IProjectsClient global::System.Threading.Tasks.Task UpdateAsync( string projectId, string? speechifyVersion = default, + int? maxConcurrentRuns = default, int? maxConcurrentCalls = default, int? maxRequestsPerMinute = default, string? name = default, diff --git a/src/libs/Speechify/Generated/Speechify.IRunsClient.CreateRun.g.cs b/src/libs/Speechify/Generated/Speechify.IRunsClient.CreateRun.g.cs index 8e804cc..f4e7203 100644 --- a/src/libs/Speechify/Generated/Speechify.IRunsClient.CreateRun.g.cs +++ b/src/libs/Speechify/Generated/Speechify.IRunsClient.CreateRun.g.cs @@ -27,15 +27,33 @@ public partial interface IRunsClient /// cannot execute; the message names the tool. Switch it to
/// `http_streamable` or detach it, then retry.
/// Returns `429 concurrency_limit_reached` when the workspace already has
- /// 200 runs queued or running. Runs execute on a shared queue, so the
- /// ceiling is what keeps one workspace's backlog from delaying everyone
- /// else's next run; it is not a plan limit. `Retry-After` is a hint at the
- /// scale runs take, not a promise - what actually frees a slot is one of
- /// your own runs ending, so follow the ones you have with the event stream
- /// and start the next when one does.
+ /// 200 runs queued or running, and the same code when the run's PROJECT is
+ /// at its own `max_concurrent_runs` ceiling - only the message says which
+ /// bit, so one retry path handles both. Runs execute on a shared queue, so
+ /// the workspace ceiling is what keeps one workspace's backlog from
+ /// delaying everyone else's next run; it is not a plan limit. The project
+ /// ceiling narrows it further, which is how an application keeps one of its
+ /// customers from occupying every slot the workspace has. `Retry-After` is
+ /// a hint at the scale runs take, not a promise - what actually frees a
+ /// slot is one of your own runs ending, so follow the ones you have with
+ /// the event stream and start the next when one does.
+ /// ## The project a run bills to
+ /// A run is attributed to its AGENT's project, captured at creation and
+ /// frozen there, so moving the agent later never moves a finished run's
+ /// cost. That project's money gates apply to the run exactly as they apply
+ /// to a call in it: `402 project_spend_limit_exceeded` once its
+ /// `monthly_budget` is reached, and `409 project_archived` while it is
+ /// archived. Both can fire for a workspace-wide key, because the project
+ /// charged is the agent's rather than the key's pin.
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `variables` and `metadata`, and the contents of
+ /// `output_schema`, are your own data rather than field names, and are
+ /// never refused. /// /// /// @@ -77,15 +95,33 @@ public partial interface IRunsClient /// cannot execute; the message names the tool. Switch it to
/// `http_streamable` or detach it, then retry.
/// Returns `429 concurrency_limit_reached` when the workspace already has
- /// 200 runs queued or running. Runs execute on a shared queue, so the
- /// ceiling is what keeps one workspace's backlog from delaying everyone
- /// else's next run; it is not a plan limit. `Retry-After` is a hint at the
- /// scale runs take, not a promise - what actually frees a slot is one of
- /// your own runs ending, so follow the ones you have with the event stream
- /// and start the next when one does.
+ /// 200 runs queued or running, and the same code when the run's PROJECT is
+ /// at its own `max_concurrent_runs` ceiling - only the message says which
+ /// bit, so one retry path handles both. Runs execute on a shared queue, so
+ /// the workspace ceiling is what keeps one workspace's backlog from
+ /// delaying everyone else's next run; it is not a plan limit. The project
+ /// ceiling narrows it further, which is how an application keeps one of its
+ /// customers from occupying every slot the workspace has. `Retry-After` is
+ /// a hint at the scale runs take, not a promise - what actually frees a
+ /// slot is one of your own runs ending, so follow the ones you have with
+ /// the event stream and start the next when one does.
+ /// ## The project a run bills to
+ /// A run is attributed to its AGENT's project, captured at creation and
+ /// frozen there, so moving the agent later never moves a finished run's
+ /// cost. That project's money gates apply to the run exactly as they apply
+ /// to a call in it: `402 project_spend_limit_exceeded` once its
+ /// `monthly_budget` is reached, and `409 project_archived` while it is
+ /// archived. Both can fire for a workspace-wide key, because the project
+ /// charged is the agent's rather than the key's pin.
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `variables` and `metadata`, and the contents of
+ /// `output_schema`, are your own data rather than field names, and are
+ /// never refused. /// /// /// @@ -127,15 +163,33 @@ public partial interface IRunsClient /// cannot execute; the message names the tool. Switch it to
/// `http_streamable` or detach it, then retry.
/// Returns `429 concurrency_limit_reached` when the workspace already has
- /// 200 runs queued or running. Runs execute on a shared queue, so the
- /// ceiling is what keeps one workspace's backlog from delaying everyone
- /// else's next run; it is not a plan limit. `Retry-After` is a hint at the
- /// scale runs take, not a promise - what actually frees a slot is one of
- /// your own runs ending, so follow the ones you have with the event stream
- /// and start the next when one does.
+ /// 200 runs queued or running, and the same code when the run's PROJECT is
+ /// at its own `max_concurrent_runs` ceiling - only the message says which
+ /// bit, so one retry path handles both. Runs execute on a shared queue, so
+ /// the workspace ceiling is what keeps one workspace's backlog from
+ /// delaying everyone else's next run; it is not a plan limit. The project
+ /// ceiling narrows it further, which is how an application keeps one of its
+ /// customers from occupying every slot the workspace has. `Retry-After` is
+ /// a hint at the scale runs take, not a promise - what actually frees a
+ /// slot is one of your own runs ending, so follow the ones you have with
+ /// the event stream and start the next when one does.
+ /// ## The project a run bills to
+ /// A run is attributed to its AGENT's project, captured at creation and
+ /// frozen there, so moving the agent later never moves a finished run's
+ /// cost. That project's money gates apply to the run exactly as they apply
+ /// to a call in it: `402 project_spend_limit_exceeded` once its
+ /// `monthly_budget` is reached, and `409 project_archived` while it is
+ /// archived. Both can fire for a workspace-wide key, because the project
+ /// charged is the agent's rather than the key's pin.
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `variables` and `metadata`, and the contents of
+ /// `output_schema`, are your own data rather than field names, and are
+ /// never refused. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.IRunsClient.SubmitRun.g.cs b/src/libs/Speechify/Generated/Speechify.IRunsClient.SubmitRun.g.cs index 3e085d3..a83e46b 100644 --- a/src/libs/Speechify/Generated/Speechify.IRunsClient.SubmitRun.g.cs +++ b/src/libs/Speechify/Generated/Speechify.IRunsClient.SubmitRun.g.cs @@ -21,7 +21,10 @@ public partial interface IRunsClient /// run's current pending action.
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// @@ -59,7 +62,10 @@ public partial interface IRunsClient /// run's current pending action.
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// @@ -97,7 +103,10 @@ public partial interface IRunsClient /// run's current pending action.
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.ITeamsClient.Run.g.cs b/src/libs/Speechify/Generated/Speechify.ITeamsClient.Run.g.cs index 76d65a3..75f0309 100644 --- a/src/libs/Speechify/Generated/Speechify.ITeamsClient.Run.g.cs +++ b/src/libs/Speechify/Generated/Speechify.ITeamsClient.Run.g.cs @@ -18,11 +18,20 @@ public partial interface ITeamsClient /// agent: the publish gate (`422 agent_publish_gate_required` until the
/// manager's current configuration is published), the MCP transport check
/// (`422 tool_transport_unsupported`), the 200-run workspace backlog
- /// ceiling (`429 concurrency_limit_reached` - and a team run's children
- /// count towards it as they start), and the spend gate.
+ /// ceiling and the manager's project ceiling
+ /// (`429 concurrency_limit_reached` - and a team run's children count
+ /// towards both as they start), and the spend gate, including the
+ /// manager's project (`402 project_spend_limit_exceeded`,
+ /// `409 project_archived`).
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `variables` and `metadata`, and the contents of
+ /// `output_schema`, are your own data rather than field names, and are
+ /// never refused. /// /// /// @@ -55,11 +64,20 @@ public partial interface ITeamsClient /// agent: the publish gate (`422 agent_publish_gate_required` until the
/// manager's current configuration is published), the MCP transport check
/// (`422 tool_transport_unsupported`), the 200-run workspace backlog
- /// ceiling (`429 concurrency_limit_reached` - and a team run's children
- /// count towards it as they start), and the spend gate.
+ /// ceiling and the manager's project ceiling
+ /// (`429 concurrency_limit_reached` - and a team run's children count
+ /// towards both as they start), and the spend gate, including the
+ /// manager's project (`402 project_spend_limit_exceeded`,
+ /// `409 project_archived`).
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `variables` and `metadata`, and the contents of
+ /// `output_schema`, are your own data rather than field names, and are
+ /// never refused. /// /// /// @@ -92,11 +110,20 @@ public partial interface ITeamsClient /// agent: the publish gate (`422 agent_publish_gate_required` until the
/// manager's current configuration is published), the MCP transport check
/// (`422 tool_transport_unsupported`), the 200-run workspace backlog
- /// ceiling (`429 concurrency_limit_reached` - and a team run's children
- /// count towards it as they start), and the spend gate.
+ /// ceiling and the manager's project ceiling
+ /// (`429 concurrency_limit_reached` - and a team run's children count
+ /// towards both as they start), and the spend gate, including the
+ /// manager's project (`402 project_spend_limit_exceeded`,
+ /// `409 project_archived`).
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `variables` and `metadata`, and the contents of
+ /// `output_schema`, are your own data rather than field names, and are
+ /// never refused. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.Create.g.cs b/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.Create.g.cs index bdec4a3..a458ae6 100644 --- a/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.Create.g.cs +++ b/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.Create.g.cs @@ -8,7 +8,13 @@ public partial interface IToolDefinitionsClient /// Create Tool
/// Create a tool. For webhook tools, the response includes the HMAC
/// `webhook_secret` exactly once — store it immediately; subsequent
- /// reads return a masked placeholder. + /// reads return a masked placeholder.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -25,7 +31,13 @@ public partial interface IToolDefinitionsClient /// Create Tool
/// Create a tool. For webhook tools, the response includes the HMAC
/// `webhook_secret` exactly once — store it immediately; subsequent
- /// reads return a masked placeholder. + /// reads return a masked placeholder.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -42,7 +54,13 @@ public partial interface IToolDefinitionsClient /// Create Tool
/// Create a tool. For webhook tools, the response includes the HMAC
/// `webhook_secret` exactly once — store it immediately; subsequent
- /// reads return a masked placeholder. + /// reads return a masked placeholder.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.TestMCPConnection.g.cs b/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.TestMCPConnection.g.cs index d8c17dc..feef9ee 100644 --- a/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.TestMCPConnection.g.cs +++ b/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.TestMCPConnection.g.cs @@ -12,7 +12,10 @@ public partial interface IToolDefinitionsClient /// discovered tool catalogue or a structured error string. Pass
/// `tool_id` from the edit-form flow when the auth payload carries
/// `_set` markers but no plaintext, so the server can hydrate the
- /// stored secret from the encrypted column before probing. + /// stored secret from the encrypted column before probing.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// @@ -33,7 +36,10 @@ public partial interface IToolDefinitionsClient /// discovered tool catalogue or a structured error string. Pass
/// `tool_id` from the edit-form flow when the auth payload carries
/// `_set` markers but no plaintext, so the server can hydrate the
- /// stored secret from the encrypted column before probing. + /// stored secret from the encrypted column before probing.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// @@ -54,7 +60,10 @@ public partial interface IToolDefinitionsClient /// discovered tool catalogue or a structured error string. Pass
/// `tool_id` from the edit-form flow when the auth payload carries
/// `_set` markers but no plaintext, so the server can hydrate the
- /// stored secret from the encrypted column before probing. + /// stored secret from the encrypted column before probing.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.TestWebhookConnection.g.cs b/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.TestWebhookConnection.g.cs index 537f0f3..1bd1161 100644 --- a/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.TestWebhookConnection.g.cs +++ b/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.TestWebhookConnection.g.cs @@ -15,7 +15,10 @@ public partial interface IToolDefinitionsClient /// `Speechify-Webhook-Test: true` header so a careful endpoint
/// can recognise the test and skip its real side effect. Pass
/// `tool_id` from the edit-form flow so the server signs the probe
- /// with the tool's stored HMAC secret. + /// with the tool's stored HMAC secret.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// @@ -39,7 +42,10 @@ public partial interface IToolDefinitionsClient /// `Speechify-Webhook-Test: true` header so a careful endpoint
/// can recognise the test and skip its real side effect. Pass
/// `tool_id` from the edit-form flow so the server signs the probe
- /// with the tool's stored HMAC secret. + /// with the tool's stored HMAC secret.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// @@ -63,7 +69,10 @@ public partial interface IToolDefinitionsClient /// `Speechify-Webhook-Test: true` header so a careful endpoint
/// can recognise the test and skip its real side effect. Pass
/// `tool_id` from the edit-form flow so the server signs the probe
- /// with the tool's stored HMAC secret. + /// with the tool's stored HMAC secret.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.Update.g.cs b/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.Update.g.cs index c3f644f..710c657 100644 --- a/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.Update.g.cs +++ b/src/libs/Speechify/Generated/Speechify.IToolDefinitionsClient.Update.g.cs @@ -6,7 +6,14 @@ public partial interface IToolDefinitionsClient { /// /// Update Tool
- /// Update a tool. Tool kind is immutable — create a new tool to change it. + /// Update a tool. Tool kind is immutable — create a new tool to change
+ /// it.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -23,7 +30,14 @@ public partial interface IToolDefinitionsClient global::System.Threading.CancellationToken cancellationToken = default); /// /// Update Tool
- /// Update a tool. Tool kind is immutable — create a new tool to change it. + /// Update a tool. Tool kind is immutable — create a new tool to change
+ /// it.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -40,7 +54,14 @@ public partial interface IToolDefinitionsClient global::System.Threading.CancellationToken cancellationToken = default); /// /// Update Tool
- /// Update a tool. Tool kind is immutable — create a new tool to change it. + /// Update a tool. Tool kind is immutable — create a new tool to change
+ /// it.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.ITriggersClient.Create.g.cs b/src/libs/Speechify/Generated/Speechify.ITriggersClient.Create.g.cs index d5c6456..e455936 100644 --- a/src/libs/Speechify/Generated/Speechify.ITriggersClient.Create.g.cs +++ b/src/libs/Speechify/Generated/Speechify.ITriggersClient.Create.g.cs @@ -9,7 +9,13 @@ public partial interface ITriggersClient /// Create a trigger that starts a durable run of a task agent. A
/// `schedule` trigger fires on a cron expression or an interval; a
/// `webhook` trigger returns a one-time `secret` plus a `fire_path` your
- /// backend POSTs to. Idempotent via `Idempotency-Key`. + /// backend POSTs to. Idempotent via `Idempotency-Key`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `run.variables` and `run.metadata`, and the contents of
+ /// `run.output_schema`, are your own data rather than field names, and
+ /// are never refused. /// /// /// @@ -33,7 +39,13 @@ public partial interface ITriggersClient /// Create a trigger that starts a durable run of a task agent. A
/// `schedule` trigger fires on a cron expression or an interval; a
/// `webhook` trigger returns a one-time `secret` plus a `fire_path` your
- /// backend POSTs to. Idempotent via `Idempotency-Key`. + /// backend POSTs to. Idempotent via `Idempotency-Key`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `run.variables` and `run.metadata`, and the contents of
+ /// `run.output_schema`, are your own data rather than field names, and
+ /// are never refused. /// /// /// @@ -57,7 +69,13 @@ public partial interface ITriggersClient /// Create a trigger that starts a durable run of a task agent. A
/// `schedule` trigger fires on a cron expression or an interval; a
/// `webhook` trigger returns a one-time `secret` plus a `fire_path` your
- /// backend POSTs to. Idempotent via `Idempotency-Key`. + /// backend POSTs to. Idempotent via `Idempotency-Key`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `run.variables` and `run.metadata`, and the contents of
+ /// `run.output_schema`, are your own data rather than field names, and
+ /// are never refused. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.ITriggersClient.Update.g.cs b/src/libs/Speechify/Generated/Speechify.ITriggersClient.Update.g.cs index 0042998..72f1b0b 100644 --- a/src/libs/Speechify/Generated/Speechify.ITriggersClient.Update.g.cs +++ b/src/libs/Speechify/Generated/Speechify.ITriggersClient.Update.g.cs @@ -8,7 +8,13 @@ public partial interface ITriggersClient /// Update Agent Trigger
/// Update a trigger. Merge-patch semantics: an omitted field is left
/// unchanged. `type` is immutable. Changing a schedule's cadence or
- /// `enabled` reschedules its next fire. + /// `enabled` reschedules its next fire.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `run.variables` and `run.metadata`, and the contents of
+ /// `run.output_schema`, are your own data rather than field names, and
+ /// are never refused. /// /// /// @@ -29,7 +35,13 @@ public partial interface ITriggersClient /// Update Agent Trigger
/// Update a trigger. Merge-patch semantics: an omitted field is left
/// unchanged. `type` is immutable. Changing a schedule's cadence or
- /// `enabled` reschedules its next fire. + /// `enabled` reschedules its next fire.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `run.variables` and `run.metadata`, and the contents of
+ /// `run.output_schema`, are your own data rather than field names, and
+ /// are never refused. /// /// /// @@ -50,7 +62,13 @@ public partial interface ITriggersClient /// Update Agent Trigger
/// Update a trigger. Merge-patch semantics: an omitted field is left
/// unchanged. `type` is immutable. Changing a schedule's cadence or
- /// `enabled` reschedules its next fire. + /// `enabled` reschedules its next fire.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `run.variables` and `run.metadata`, and the contents of
+ /// `run.output_schema`, are your own data rather than field names, and
+ /// are never refused. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.Models.ErrorCode.g.cs b/src/libs/Speechify/Generated/Speechify.Models.ErrorCode.g.cs index e3c3233..459fe6b 100644 --- a/src/libs/Speechify/Generated/Speechify.Models.ErrorCode.g.cs +++ b/src/libs/Speechify/Generated/Speechify.Models.ErrorCode.g.cs @@ -24,6 +24,10 @@ public enum ErrorCode /// /// /// + AgentLimitReached, + /// + /// + /// AgentNotFound, /// /// @@ -581,6 +585,7 @@ public static string ToValueString(this ErrorCode value) { ErrorCode.AccountDeletionBlocked => "account_deletion_blocked", ErrorCode.AgentInUse => "agent_in_use", + ErrorCode.AgentLimitReached => "agent_limit_reached", ErrorCode.AgentNotFound => "agent_not_found", ErrorCode.AgentPublishGateFailed => "agent_publish_gate_failed", ErrorCode.AgentPublishGateRequired => "agent_publish_gate_required", @@ -729,6 +734,7 @@ public static string ToValueString(this ErrorCode value) { "account_deletion_blocked" => ErrorCode.AccountDeletionBlocked, "agent_in_use" => ErrorCode.AgentInUse, + "agent_limit_reached" => ErrorCode.AgentLimitReached, "agent_not_found" => ErrorCode.AgentNotFound, "agent_publish_gate_failed" => ErrorCode.AgentPublishGateFailed, "agent_publish_gate_required" => ErrorCode.AgentPublishGateRequired, diff --git a/src/libs/Speechify/Generated/Speechify.Models.Project.g.cs b/src/libs/Speechify/Generated/Speechify.Models.Project.g.cs index 822d4de..88eff24 100644 --- a/src/libs/Speechify/Generated/Speechify.Models.Project.g.cs +++ b/src/libs/Speechify/Generated/Speechify.Models.Project.g.cs @@ -13,10 +13,19 @@ namespace Speechify /// stays workspace-level with no billing split. A project may
/// carry a monthly spend LIMIT, which bounds work without splitting
/// the bill, capacity CEILINGS (`max_concurrent_calls`,
- /// `max_requests_per_minute`) that sit below the workspace's own
- /// plan limits so one project cannot consume the whole allowance,
- /// and it may be ARCHIVED, which suspends all work and spend inside
- /// it while everything stays readable. + /// `max_requests_per_minute`, `max_concurrent_runs`) that sit below
+ /// the workspace's own plan limits so one project cannot consume the
+ /// whole allowance, and it may be ARCHIVED, which suspends all work
+ /// and spend inside it while everything stays readable.
+ /// An application building on this platform models one of its OWN
+ /// business customers as a project: it is the level that both
+ /// attributes cost (`monthly_spend`, grouped per project on the usage
+ /// breakdown) and ENFORCES it (`monthly_budget` and the three capacity
+ /// ceilings). The person an agent is dealing with is NOT a project -
+ /// that is `user_identity` on a conversation or a run. How many
+ /// projects a workspace may hold is the workspace's own ceiling; a
+ /// create past it answers `409 project_limit_reached`, and deleting an
+ /// unused project frees a slot. /// public sealed partial class Project { @@ -57,6 +66,24 @@ public sealed partial class Project [global::System.Text.Json.Serialization.JsonPropertyName("max_concurrent_calls")] public int? MaxConcurrentCalls { get; set; } + /// + /// The most durable agent runs this project may have queued or
+ /// running at once, present only when set. Checked after the
+ /// workspace's own run ceiling on every run start (a request, a
+ /// team run, or an unattended trigger fire), keyed on the project
+ /// the run is ATTRIBUTED to - its agent's project, captured at
+ /// creation - so a workspace-wide key starting a run in this
+ /// project counts against it. A run over the ceiling is refused
+ /// with the same `429 concurrency_limit_reached` the workspace
+ /// ceiling answers, carrying `Retry-After`, while sibling projects
+ /// keep their headroom. A run parked on a human approval or on its
+ /// children holds no slot and does not count. Never higher than the
+ /// workspace's own run ceiling: a project can narrow the
+ /// workspace's capacity, not raise it. + /// + [global::System.Text.Json.Serialization.JsonPropertyName("max_concurrent_runs")] + public int? MaxConcurrentRuns { get; set; } + /// /// The most API requests per minute credentials pinned to this
/// project may make across every surface, present only when set.
@@ -169,6 +196,21 @@ public sealed partial class Project /// workspace's cap: a project can narrow the workspace's
/// capacity, not raise it. /// + /// + /// The most durable agent runs this project may have queued or
+ /// running at once, present only when set. Checked after the
+ /// workspace's own run ceiling on every run start (a request, a
+ /// team run, or an unattended trigger fire), keyed on the project
+ /// the run is ATTRIBUTED to - its agent's project, captured at
+ /// creation - so a workspace-wide key starting a run in this
+ /// project counts against it. A run over the ceiling is refused
+ /// with the same `429 concurrency_limit_reached` the workspace
+ /// ceiling answers, carrying `Retry-After`, while sibling projects
+ /// keep their headroom. A run parked on a human approval or on its
+ /// children holds no slot and does not count. Never higher than the
+ /// workspace's own run ceiling: a project can narrow the
+ /// workspace's capacity, not raise it. + /// /// /// The most API requests per minute credentials pinned to this
/// project may make across every surface, present only when set.
@@ -210,6 +252,7 @@ public Project( global::System.DateTime? archivedAt, global::System.DateTime? purgedAt, int? maxConcurrentCalls, + int? maxConcurrentRuns, int? maxRequestsPerMinute, double? monthlyBudget, double? monthlySpend) @@ -217,6 +260,7 @@ public Project( this.ArchivedAt = archivedAt; this.PurgedAt = purgedAt; this.MaxConcurrentCalls = maxConcurrentCalls; + this.MaxConcurrentRuns = maxConcurrentRuns; this.MaxRequestsPerMinute = maxRequestsPerMinute; this.MonthlyBudget = monthlyBudget; this.MonthlySpend = monthlySpend; diff --git a/src/libs/Speechify/Generated/Speechify.Models.Tool.g.cs b/src/libs/Speechify/Generated/Speechify.Models.Tool.g.cs index 5ab22fa..f05088a 100644 --- a/src/libs/Speechify/Generated/Speechify.Models.Tool.g.cs +++ b/src/libs/Speechify/Generated/Speechify.Models.Tool.g.cs @@ -6,7 +6,26 @@ namespace Speechify /// /// A workspace tool definition: a reusable webhook / client / MCP
/// integration created once and attached to many agents. Built-ins
- /// are NOT definitions - they are per-agent (see `AgentTool`). + /// are NOT definitions - they are per-agent (see `AgentTool`).
+ /// **A tool row belongs to exactly one project and is reused only inside
+ /// it.** An attach whose agent and tool sit in different projects is
+ /// refused with `409 cross_project_reference`, and there is no
+ /// workspace-shared tier for a tool the way there is for a vault
+ /// credential: a tool with no `project_id` lives in the implicit Default
+ /// project and attaches only to agents that also live there. So an
+ /// application running one project per business customer duplicates its
+ /// connector tool per customer, and that is deliberate rather than a
+ /// limitation to route around. A tool row carries the endpoint, the
+ /// headers and the credential reference the agent will call with, and
+ /// those are exactly what an application wants to be able to vary, revoke
+ /// or rotate for ONE of its customers without touching the others. Its
+ /// `project_id` is also what makes a tool follow its agents through a
+ /// move, a promote and a project teardown; a shared row would have to be
+ /// left behind by all three.
+ /// What does NOT need duplicating is the person: the customer's end-user
+ /// travels per call as `user_identity` in the signed webhook body or the
+ /// `Speechify-User-Identity` header, so one connector row per project
+ /// serves every person under that customer. /// public sealed partial class Tool { diff --git a/src/libs/Speechify/Generated/Speechify.Models.UpdateProjectRequest.g.cs b/src/libs/Speechify/Generated/Speechify.Models.UpdateProjectRequest.g.cs index 7fc12d1..e2fc8ed 100644 --- a/src/libs/Speechify/Generated/Speechify.Models.UpdateProjectRequest.g.cs +++ b/src/libs/Speechify/Generated/Speechify.Models.UpdateProjectRequest.g.cs @@ -13,6 +13,17 @@ namespace Speechify /// public sealed partial class UpdateProjectRequest { + /// + /// Sets the project's concurrent-run ceiling; `null` removes it.
+ /// Must be a positive integer at or below the workspace's own run
+ /// ceiling, otherwise the request is refused with
+ /// `400 validation_failed` naming the field and the ceiling.
+ /// Requires the `billing.manage` permission. Takes effect on the
+ /// next run start attributed to the project. + /// + [global::System.Text.Json.Serialization.JsonPropertyName("max_concurrent_runs")] + public int? MaxConcurrentRuns { get; set; } + /// /// Sets the project's active-call ceiling; `null` removes it.
/// Must be a positive integer at or below the workspace's own
@@ -70,6 +81,14 @@ public sealed partial class UpdateProjectRequest /// /// Initializes a new instance of the class. /// + /// + /// Sets the project's concurrent-run ceiling; `null` removes it.
+ /// Must be a positive integer at or below the workspace's own run
+ /// ceiling, otherwise the request is refused with
+ /// `400 validation_failed` naming the field and the ceiling.
+ /// Requires the `billing.manage` permission. Takes effect on the
+ /// next run start attributed to the project. + /// /// /// Sets the project's active-call ceiling; `null` removes it.
/// Must be a positive integer at or below the workspace's own
@@ -110,11 +129,13 @@ public sealed partial class UpdateProjectRequest [global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers] #endif public UpdateProjectRequest( + int? maxConcurrentRuns, int? maxConcurrentCalls, int? maxRequestsPerMinute, string? name, double? monthlyBudget) { + this.MaxConcurrentRuns = maxConcurrentRuns; this.MaxConcurrentCalls = maxConcurrentCalls; this.MaxRequestsPerMinute = maxRequestsPerMinute; this.Name = name; diff --git a/src/libs/Speechify/Generated/Speechify.ProjectsClient.Update.g.cs b/src/libs/Speechify/Generated/Speechify.ProjectsClient.Update.g.cs index 78d816a..ca0bef8 100644 --- a/src/libs/Speechify/Generated/Speechify.ProjectsClient.Update.g.cs +++ b/src/libs/Speechify/Generated/Speechify.ProjectsClient.Update.g.cs @@ -626,6 +626,14 @@ partial void ProcessUpdateResponseContent( /// /// /// + /// + /// Sets the project's concurrent-run ceiling; `null` removes it.
+ /// Must be a positive integer at or below the workspace's own run
+ /// ceiling, otherwise the request is refused with
+ /// `400 validation_failed` naming the field and the ceiling.
+ /// Requires the `billing.manage` permission. Takes effect on the
+ /// next run start attributed to the project. + /// /// /// Sets the project's active-call ceiling; `null` removes it.
/// Must be a positive integer at or below the workspace's own
@@ -668,6 +676,7 @@ partial void ProcessUpdateResponseContent( public async global::System.Threading.Tasks.Task UpdateAsync( string projectId, string? speechifyVersion = default, + int? maxConcurrentRuns = default, int? maxConcurrentCalls = default, int? maxRequestsPerMinute = default, string? name = default, @@ -677,6 +686,7 @@ partial void ProcessUpdateResponseContent( { var __request = new global::Speechify.UpdateProjectRequest { + MaxConcurrentRuns = maxConcurrentRuns, MaxConcurrentCalls = maxConcurrentCalls, MaxRequestsPerMinute = maxRequestsPerMinute, Name = name, diff --git a/src/libs/Speechify/Generated/Speechify.RunsClient.CreateRun.g.cs b/src/libs/Speechify/Generated/Speechify.RunsClient.CreateRun.g.cs index 7593fb9..9fb1cb6 100644 --- a/src/libs/Speechify/Generated/Speechify.RunsClient.CreateRun.g.cs +++ b/src/libs/Speechify/Generated/Speechify.RunsClient.CreateRun.g.cs @@ -70,15 +70,33 @@ partial void ProcessCreateRunResponseContent( /// cannot execute; the message names the tool. Switch it to
/// `http_streamable` or detach it, then retry.
/// Returns `429 concurrency_limit_reached` when the workspace already has
- /// 200 runs queued or running. Runs execute on a shared queue, so the
- /// ceiling is what keeps one workspace's backlog from delaying everyone
- /// else's next run; it is not a plan limit. `Retry-After` is a hint at the
- /// scale runs take, not a promise - what actually frees a slot is one of
- /// your own runs ending, so follow the ones you have with the event stream
- /// and start the next when one does.
+ /// 200 runs queued or running, and the same code when the run's PROJECT is
+ /// at its own `max_concurrent_runs` ceiling - only the message says which
+ /// bit, so one retry path handles both. Runs execute on a shared queue, so
+ /// the workspace ceiling is what keeps one workspace's backlog from
+ /// delaying everyone else's next run; it is not a plan limit. The project
+ /// ceiling narrows it further, which is how an application keeps one of its
+ /// customers from occupying every slot the workspace has. `Retry-After` is
+ /// a hint at the scale runs take, not a promise - what actually frees a
+ /// slot is one of your own runs ending, so follow the ones you have with
+ /// the event stream and start the next when one does.
+ /// ## The project a run bills to
+ /// A run is attributed to its AGENT's project, captured at creation and
+ /// frozen there, so moving the agent later never moves a finished run's
+ /// cost. That project's money gates apply to the run exactly as they apply
+ /// to a call in it: `402 project_spend_limit_exceeded` once its
+ /// `monthly_budget` is reached, and `409 project_archived` while it is
+ /// archived. Both can fire for a workspace-wide key, because the project
+ /// charged is the agent's rather than the key's pin.
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `variables` and `metadata`, and the contents of
+ /// `output_schema`, are your own data rather than field names, and are
+ /// never refused. /// /// /// @@ -133,15 +151,33 @@ partial void ProcessCreateRunResponseContent( /// cannot execute; the message names the tool. Switch it to
/// `http_streamable` or detach it, then retry.
/// Returns `429 concurrency_limit_reached` when the workspace already has
- /// 200 runs queued or running. Runs execute on a shared queue, so the
- /// ceiling is what keeps one workspace's backlog from delaying everyone
- /// else's next run; it is not a plan limit. `Retry-After` is a hint at the
- /// scale runs take, not a promise - what actually frees a slot is one of
- /// your own runs ending, so follow the ones you have with the event stream
- /// and start the next when one does.
+ /// 200 runs queued or running, and the same code when the run's PROJECT is
+ /// at its own `max_concurrent_runs` ceiling - only the message says which
+ /// bit, so one retry path handles both. Runs execute on a shared queue, so
+ /// the workspace ceiling is what keeps one workspace's backlog from
+ /// delaying everyone else's next run; it is not a plan limit. The project
+ /// ceiling narrows it further, which is how an application keeps one of its
+ /// customers from occupying every slot the workspace has. `Retry-After` is
+ /// a hint at the scale runs take, not a promise - what actually frees a
+ /// slot is one of your own runs ending, so follow the ones you have with
+ /// the event stream and start the next when one does.
+ /// ## The project a run bills to
+ /// A run is attributed to its AGENT's project, captured at creation and
+ /// frozen there, so moving the agent later never moves a finished run's
+ /// cost. That project's money gates apply to the run exactly as they apply
+ /// to a call in it: `402 project_spend_limit_exceeded` once its
+ /// `monthly_budget` is reached, and `409 project_archived` while it is
+ /// archived. Both can fire for a workspace-wide key, because the project
+ /// charged is the agent's rather than the key's pin.
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `variables` and `metadata`, and the contents of
+ /// `output_schema`, are your own data rather than field names, and are
+ /// never refused. /// /// /// @@ -584,6 +620,43 @@ partial void ProcessCreateRunResponseContent( h => h.Key, h => h.Value)); } + // The request conflicts with the current resource state - e.g. duplicate, optimistic-concurrency mismatch, or last-owner guard. + if ((int)__response.StatusCode == 409) + { + string? __content_409 = null; + global::System.Exception? __exception_409 = null; + global::Speechify.Error? __value_409 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_409 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_409 = global::Speechify.Error.FromJson(__content_409, JsonSerializerContext); + } + else + { + __content_409 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_409 = global::Speechify.Error.FromJson(__content_409, JsonSerializerContext); + } + } + catch (global::System.Exception __ex) + { + __exception_409 = __ex; + } + + + throw global::Speechify.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_409 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_409, + responseBody: __content_409, + responseObject: __value_409, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } // The request was well-formed but semantically rejected - typically a referential integrity violation (e.g. flow node references an audio asset in another workspace) or a state machine refusal. if ((int)__response.StatusCode == 422) { @@ -777,15 +850,33 @@ partial void ProcessCreateRunResponseContent( /// cannot execute; the message names the tool. Switch it to
/// `http_streamable` or detach it, then retry.
/// Returns `429 concurrency_limit_reached` when the workspace already has
- /// 200 runs queued or running. Runs execute on a shared queue, so the
- /// ceiling is what keeps one workspace's backlog from delaying everyone
- /// else's next run; it is not a plan limit. `Retry-After` is a hint at the
- /// scale runs take, not a promise - what actually frees a slot is one of
- /// your own runs ending, so follow the ones you have with the event stream
- /// and start the next when one does.
+ /// 200 runs queued or running, and the same code when the run's PROJECT is
+ /// at its own `max_concurrent_runs` ceiling - only the message says which
+ /// bit, so one retry path handles both. Runs execute on a shared queue, so
+ /// the workspace ceiling is what keeps one workspace's backlog from
+ /// delaying everyone else's next run; it is not a plan limit. The project
+ /// ceiling narrows it further, which is how an application keeps one of its
+ /// customers from occupying every slot the workspace has. `Retry-After` is
+ /// a hint at the scale runs take, not a promise - what actually frees a
+ /// slot is one of your own runs ending, so follow the ones you have with
+ /// the event stream and start the next when one does.
+ /// ## The project a run bills to
+ /// A run is attributed to its AGENT's project, captured at creation and
+ /// frozen there, so moving the agent later never moves a finished run's
+ /// cost. That project's money gates apply to the run exactly as they apply
+ /// to a call in it: `402 project_spend_limit_exceeded` once its
+ /// `monthly_budget` is reached, and `409 project_archived` while it is
+ /// archived. Both can fire for a workspace-wide key, because the project
+ /// charged is the agent's rather than the key's pin.
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `variables` and `metadata`, and the contents of
+ /// `output_schema`, are your own data rather than field names, and are
+ /// never refused. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.RunsClient.SubmitRun.g.cs b/src/libs/Speechify/Generated/Speechify.RunsClient.SubmitRun.g.cs index 69844de..95d8540 100644 --- a/src/libs/Speechify/Generated/Speechify.RunsClient.SubmitRun.g.cs +++ b/src/libs/Speechify/Generated/Speechify.RunsClient.SubmitRun.g.cs @@ -66,7 +66,10 @@ partial void ProcessSubmitRunResponseContent( /// run's current pending action.
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// @@ -118,7 +121,10 @@ partial void ProcessSubmitRunResponseContent( /// run's current pending action.
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// @@ -752,7 +758,10 @@ partial void ProcessSubmitRunResponseContent( /// run's current pending action.
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.TeamsClient.Run.g.cs b/src/libs/Speechify/Generated/Speechify.TeamsClient.Run.g.cs index 9f30d3b..a87d742 100644 --- a/src/libs/Speechify/Generated/Speechify.TeamsClient.Run.g.cs +++ b/src/libs/Speechify/Generated/Speechify.TeamsClient.Run.g.cs @@ -61,11 +61,20 @@ partial void ProcessRunResponseContent( /// agent: the publish gate (`422 agent_publish_gate_required` until the
/// manager's current configuration is published), the MCP transport check
/// (`422 tool_transport_unsupported`), the 200-run workspace backlog
- /// ceiling (`429 concurrency_limit_reached` - and a team run's children
- /// count towards it as they start), and the spend gate.
+ /// ceiling and the manager's project ceiling
+ /// (`429 concurrency_limit_reached` - and a team run's children count
+ /// towards both as they start), and the spend gate, including the
+ /// manager's project (`402 project_spend_limit_exceeded`,
+ /// `409 project_archived`).
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `variables` and `metadata`, and the contents of
+ /// `output_schema`, are your own data rather than field names, and are
+ /// never refused. /// /// /// @@ -111,11 +120,20 @@ partial void ProcessRunResponseContent( /// agent: the publish gate (`422 agent_publish_gate_required` until the
/// manager's current configuration is published), the MCP transport check
/// (`422 tool_transport_unsupported`), the 200-run workspace backlog
- /// ceiling (`429 concurrency_limit_reached` - and a team run's children
- /// count towards it as they start), and the spend gate.
+ /// ceiling and the manager's project ceiling
+ /// (`429 concurrency_limit_reached` - and a team run's children count
+ /// towards both as they start), and the spend gate, including the
+ /// manager's project (`402 project_spend_limit_exceeded`,
+ /// `409 project_archived`).
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `variables` and `metadata`, and the contents of
+ /// `output_schema`, are your own data rather than field names, and are
+ /// never refused. /// /// /// @@ -558,6 +576,43 @@ partial void ProcessRunResponseContent( h => h.Key, h => h.Value)); } + // The request conflicts with the current resource state - e.g. duplicate, optimistic-concurrency mismatch, or last-owner guard. + if ((int)__response.StatusCode == 409) + { + string? __content_409 = null; + global::System.Exception? __exception_409 = null; + global::Speechify.Error? __value_409 = null; + try + { + if (__effectiveReadResponseAsString) + { + __content_409 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + __value_409 = global::Speechify.Error.FromJson(__content_409, JsonSerializerContext); + } + else + { + __content_409 = await __response.Content.ReadAsStringAsync(__effectiveCancellationToken).ConfigureAwait(false); + + __value_409 = global::Speechify.Error.FromJson(__content_409, JsonSerializerContext); + } + } + catch (global::System.Exception __ex) + { + __exception_409 = __ex; + } + + + throw global::Speechify.ApiException.Create( + statusCode: __response.StatusCode, + message: __content_409 ?? __response.ReasonPhrase ?? string.Empty, + innerException: __exception_409, + responseBody: __content_409, + responseObject: __value_409, + responseHeaders: global::System.Linq.Enumerable.ToDictionary( + __response.Headers, + h => h.Key, + h => h.Value)); + } // The request was well-formed but semantically rejected - typically a referential integrity violation (e.g. flow node references an audio asset in another workspace) or a state machine refusal. if ((int)__response.StatusCode == 422) { @@ -742,11 +797,20 @@ partial void ProcessRunResponseContent( /// agent: the publish gate (`422 agent_publish_gate_required` until the
/// manager's current configuration is published), the MCP transport check
/// (`422 tool_transport_unsupported`), the 200-run workspace backlog
- /// ceiling (`429 concurrency_limit_reached` - and a team run's children
- /// count towards it as they start), and the spend gate.
+ /// ceiling and the manager's project ceiling
+ /// (`429 concurrency_limit_reached` - and a team run's children count
+ /// towards both as they start), and the spend gate, including the
+ /// manager's project (`402 project_spend_limit_exceeded`,
+ /// `409 project_archived`).
/// This endpoint is in beta: it is available to workspaces granted
/// `durable_runs_access`, and every other workspace receives
- /// `402 durable_runs_not_in_plan`. + /// `402 durable_runs_not_in_plan`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `variables` and `metadata`, and the contents of
+ /// `output_schema`, are your own data rather than field names, and are
+ /// never refused. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.Create.g.cs b/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.Create.g.cs index 676734c..4d285af 100644 --- a/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.Create.g.cs +++ b/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.Create.g.cs @@ -47,7 +47,13 @@ partial void ProcessCreateResponseContent( /// Create Tool
/// Create a tool. For webhook tools, the response includes the HMAC
/// `webhook_secret` exactly once — store it immediately; subsequent
- /// reads return a masked placeholder. + /// reads return a masked placeholder.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -75,7 +81,13 @@ partial void ProcessCreateResponseContent( /// Create Tool
/// Create a tool. For webhook tools, the response includes the HMAC
/// `webhook_secret` exactly once — store it immediately; subsequent
- /// reads return a masked placeholder. + /// reads return a masked placeholder.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -567,7 +579,13 @@ partial void ProcessCreateResponseContent( /// Create Tool
/// Create a tool. For webhook tools, the response includes the HMAC
/// `webhook_secret` exactly once — store it immediately; subsequent
- /// reads return a masked placeholder. + /// reads return a masked placeholder.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.TestMCPConnection.g.cs b/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.TestMCPConnection.g.cs index 67f962c..06da9a4 100644 --- a/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.TestMCPConnection.g.cs +++ b/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.TestMCPConnection.g.cs @@ -51,7 +51,10 @@ partial void ProcessTestMCPConnectionResponseContent( /// discovered tool catalogue or a structured error string. Pass
/// `tool_id` from the edit-form flow when the auth payload carries
/// `_set` markers but no plaintext, so the server can hydrate the
- /// stored secret from the encrypted column before probing. + /// stored secret from the encrypted column before probing.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// @@ -83,7 +86,10 @@ partial void ProcessTestMCPConnectionResponseContent( /// discovered tool catalogue or a structured error string. Pass
/// `tool_id` from the edit-form flow when the auth payload carries
/// `_set` markers but no plaintext, so the server can hydrate the
- /// stored secret from the encrypted column before probing. + /// stored secret from the encrypted column before probing.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// @@ -542,7 +548,10 @@ partial void ProcessTestMCPConnectionResponseContent( /// discovered tool catalogue or a structured error string. Pass
/// `tool_id` from the edit-form flow when the auth payload carries
/// `_set` markers but no plaintext, so the server can hydrate the
- /// stored secret from the encrypted column before probing. + /// stored secret from the encrypted column before probing.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.TestWebhookConnection.g.cs b/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.TestWebhookConnection.g.cs index f19d564..a49e55f 100644 --- a/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.TestWebhookConnection.g.cs +++ b/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.TestWebhookConnection.g.cs @@ -54,7 +54,10 @@ partial void ProcessTestWebhookConnectionResponseContent( /// `Speechify-Webhook-Test: true` header so a careful endpoint
/// can recognise the test and skip its real side effect. Pass
/// `tool_id` from the edit-form flow so the server signs the probe
- /// with the tool's stored HMAC secret. + /// with the tool's stored HMAC secret.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// @@ -89,7 +92,10 @@ partial void ProcessTestWebhookConnectionResponseContent( /// `Speechify-Webhook-Test: true` header so a careful endpoint
/// can recognise the test and skip its real side effect. Pass
/// `tool_id` from the edit-form flow so the server signs the probe
- /// with the tool's stored HMAC secret. + /// with the tool's stored HMAC secret.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// @@ -551,7 +557,10 @@ partial void ProcessTestWebhookConnectionResponseContent( /// `Speechify-Webhook-Test: true` header so a careful endpoint
/// can recognise the test and skip its real side effect. Pass
/// `tool_id` from the edit-form flow so the server signs the probe
- /// with the tool's stored HMAC secret. + /// with the tool's stored HMAC secret.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.Update.g.cs b/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.Update.g.cs index c78ad47..aea4a87 100644 --- a/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.Update.g.cs +++ b/src/libs/Speechify/Generated/Speechify.ToolDefinitionsClient.Update.g.cs @@ -47,7 +47,14 @@ partial void ProcessUpdateResponseContent( /// /// Update Tool
- /// Update a tool. Tool kind is immutable — create a new tool to change it. + /// Update a tool. Tool kind is immutable — create a new tool to change
+ /// it.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -76,7 +83,14 @@ partial void ProcessUpdateResponseContent( } /// /// Update Tool
- /// Update a tool. Tool kind is immutable — create a new tool to change it. + /// Update a tool. Tool kind is immutable — create a new tool to change
+ /// it.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// @@ -607,7 +621,14 @@ partial void ProcessUpdateResponseContent( } /// /// Update Tool
- /// Update a tool. Tool kind is immutable — create a new tool to change it. + /// Update a tool. Tool kind is immutable — create a new tool to change
+ /// it.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// The contents of `config` are your own data at this level; they are
+ /// validated against the tool kind's own schema, which has always
+ /// refused an unknown key there. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.TriggersClient.Create.g.cs b/src/libs/Speechify/Generated/Speechify.TriggersClient.Create.g.cs index 77685d5..ed13901 100644 --- a/src/libs/Speechify/Generated/Speechify.TriggersClient.Create.g.cs +++ b/src/libs/Speechify/Generated/Speechify.TriggersClient.Create.g.cs @@ -52,7 +52,13 @@ partial void ProcessCreateResponseContent( /// Create a trigger that starts a durable run of a task agent. A
/// `schedule` trigger fires on a cron expression or an interval; a
/// `webhook` trigger returns a one-time `secret` plus a `fire_path` your
- /// backend POSTs to. Idempotent via `Idempotency-Key`. + /// backend POSTs to. Idempotent via `Idempotency-Key`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `run.variables` and `run.metadata`, and the contents of
+ /// `run.output_schema`, are your own data rather than field names, and
+ /// are never refused. /// /// /// @@ -89,7 +95,13 @@ partial void ProcessCreateResponseContent( /// Create a trigger that starts a durable run of a task agent. A
/// `schedule` trigger fires on a cron expression or an interval; a
/// `webhook` trigger returns a one-time `secret` plus a `fire_path` your
- /// backend POSTs to. Idempotent via `Idempotency-Key`. + /// backend POSTs to. Idempotent via `Idempotency-Key`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `run.variables` and `run.metadata`, and the contents of
+ /// `run.output_schema`, are your own data rather than field names, and
+ /// are never refused. /// /// /// @@ -633,7 +645,13 @@ partial void ProcessCreateResponseContent( /// Create a trigger that starts a durable run of a task agent. A
/// `schedule` trigger fires on a cron expression or an interval; a
/// `webhook` trigger returns a one-time `secret` plus a `fire_path` your
- /// backend POSTs to. Idempotent via `Idempotency-Key`. + /// backend POSTs to. Idempotent via `Idempotency-Key`.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `run.variables` and `run.metadata`, and the contents of
+ /// `run.output_schema`, are your own data rather than field names, and
+ /// are never refused. /// /// /// diff --git a/src/libs/Speechify/Generated/Speechify.TriggersClient.Update.g.cs b/src/libs/Speechify/Generated/Speechify.TriggersClient.Update.g.cs index 9517852..81813f7 100644 --- a/src/libs/Speechify/Generated/Speechify.TriggersClient.Update.g.cs +++ b/src/libs/Speechify/Generated/Speechify.TriggersClient.Update.g.cs @@ -51,7 +51,13 @@ partial void ProcessUpdateResponseContent( /// Update Agent Trigger
/// Update a trigger. Merge-patch semantics: an omitted field is left
/// unchanged. `type` is immutable. Changing a schedule's cadence or
- /// `enabled` reschedules its next fire. + /// `enabled` reschedules its next fire.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `run.variables` and `run.metadata`, and the contents of
+ /// `run.output_schema`, are your own data rather than field names, and
+ /// are never refused. /// /// /// @@ -85,7 +91,13 @@ partial void ProcessUpdateResponseContent( /// Update Agent Trigger
/// Update a trigger. Merge-patch semantics: an omitted field is left
/// unchanged. `type` is immutable. Changing a schedule's cadence or
- /// `enabled` reschedules its next fire. + /// `enabled` reschedules its next fire.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `run.variables` and `run.metadata`, and the contents of
+ /// `run.output_schema`, are your own data rather than field names, and
+ /// are never refused. /// /// /// @@ -585,7 +597,13 @@ partial void ProcessUpdateResponseContent( /// Update Agent Trigger
/// Update a trigger. Merge-patch semantics: an omitted field is left
/// unchanged. `type` is immutable. Changing a schedule's cadence or
- /// `enabled` reschedules its next fire. + /// `enabled` reschedules its next fire.
+ /// A field this endpoint does not define is refused with `400
+ /// validation_failed` naming every unknown field, rather than accepted
+ /// and silently dropped.
+ /// Keys inside `run.variables` and `run.metadata`, and the contents of
+ /// `run.output_schema`, are your own data rather than field names, and
+ /// are never refused. /// /// /// diff --git a/src/libs/Speechify/openapi.yaml b/src/libs/Speechify/openapi.yaml index 55a63ef..562610e 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.","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"}}}}},"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; `