{ "openapi": "3.0.0", "info": { "title": "Analytics", "description": "Voiceflow analytics service", "version": "1.0.0", "contact": {} }, "servers": [ { "url": "https://analytics-api.voiceflow.com" } ], "paths": { "/v2/query/usage": { "post": { "operationId": "QueryPublicController_queryUsageV2_v2", "summary": "Query usage", "description": "Query usage for a project", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "type": "object", "properties": { "name": { "type": "string", "enum": [ "interactions" ], "x-enumNames": [ "INTERACTIONS" ] }, "filter": { "$ref": "#/components/schemas/UsageQueryBaseListFilterV2" } }, "required": [ "name", "filter" ], "description": "Aggregate the number of interactions that match the provided filter." }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "top_intents" ], "x-enumNames": [ "TOP_INTENTS" ] }, "filter": { "type": "object", "properties": { "projectID": { "type": "string", "minLength": 1 }, "startTime": { "description": "A timestamp in ISO-8601 format", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "endTime": { "description": "A timestamp in ISO-8601 format", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "projectEnvironmentIDOrAlias": { "description": "One or more Voiceflow project environment IDs or aliases", "anyOf": [ { "type": "string", "minLength": 1 }, { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } ] }, "limit": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1 } }, "required": [ "projectID" ] } }, "required": [ "name", "filter" ], "description": "Find the top intents that match the provided filter." }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "unique_users" ], "x-enumNames": [ "UNIQUE_USERS" ] }, "filter": { "$ref": "#/components/schemas/UsageQueryBaseListFilterV2" } }, "required": [ "name", "filter" ], "description": "Aggregate the number of unique users that match the provided filter." }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "credit_usage" ], "x-enumNames": [ "CREDIT_USAGE" ] }, "filter": { "$ref": "#/components/schemas/UsageQueryBaseListFilterV2" } }, "required": [ "name", "filter" ], "description": "Aggregate the number of tokens spent that match the provided filter." }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "function_usage" ], "x-enumNames": [ "FUNCTION_USAGE" ] }, "filter": { "$ref": "#/components/schemas/UsageQueryBaseListFilterV2" } }, "required": [ "name", "filter" ], "description": "Aggregate the function calls that match the provided filter." }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "api_calls" ], "x-enumNames": [ "API_CALLS" ] }, "filter": { "$ref": "#/components/schemas/UsageQueryBaseListFilterV2" } }, "required": [ "name", "filter" ], "description": "Aggregate the API calls that match the provided filter." }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "kb_documents" ], "x-enumNames": [ "KB_DOCUMENTS" ] }, "filter": { "$ref": "#/components/schemas/UsageQueryBaseListFilterV2" } }, "required": [ "name", "filter" ], "description": "Find the knowledge base documents that match the provided filter." }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "integrations" ], "x-enumNames": [ "INTEGRATIONS" ] }, "filter": { "$ref": "#/components/schemas/UsageQueryBaseListFilterV2" } }, "required": [ "name", "filter" ], "description": "Aggregate the integration tool calls that match the provided filter." }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "transcripts" ], "x-enumNames": [ "TRANSCRIPTS" ] }, "filter": { "$ref": "#/components/schemas/UsageQueryBaseListFilterV2" } }, "required": [ "name", "filter" ], "description": "Aggregate the transcripts that match the provided filter." }, { "type": "object", "properties": { "name": { "type": "string", "enum": [ "agent_usage" ], "x-enumNames": [ "AGENT_USAGE" ] }, "filter": { "$ref": "#/components/schemas/UsageQueryBaseListFilterV2" } }, "required": [ "name", "filter" ], "description": "Aggregate the agent invocations that match the provided filter." } ] } }, "required": [ "data" ] } } } }, "responses": { "200": { "description": "The query succeed and the result was returned", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "anyOf": [ { "type": "object", "properties": { "cursor": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "projectID": { "type": "string" }, "environmentID": { "type": "string" }, "count": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "type": { "type": "string" } }, "required": [ "period", "projectID", "environmentID", "count", "type" ] } } }, "required": [ "items" ] }, { "type": "object", "properties": { "intents": { "type": "array", "items": { "type": "object", "properties": { "name": { "description": "The name of the intent", "type": "string" }, "count": { "description": "The number of times the intent was used in the project(s) that matched the provided filter", "type": "integer", "maximum": 9007199254740991, "minimum": 0 } }, "required": [ "name", "count" ] } } }, "required": [ "intents" ] }, { "type": "object", "properties": { "cursor": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "projectID": { "type": "string" }, "environmentID": { "type": "string" }, "count": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 } }, "required": [ "period", "projectID", "environmentID", "count" ] } } }, "required": [ "items" ] }, { "type": "object", "properties": { "cursor": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "projectID": { "type": "string" }, "environmentID": { "type": "string" }, "count": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "diagramID": { "type": "string" }, "nodeID": { "type": "string" }, "model": { "type": "string" }, "type": { "type": "string" } }, "required": [ "period", "projectID", "environmentID", "count", "diagramID", "nodeID", "model", "type" ] } } }, "required": [ "items" ] }, { "type": "object", "properties": { "cursor": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "projectID": { "type": "string" }, "environmentID": { "type": "string" }, "count": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "functionID": { "type": "string" }, "name": { "type": "string" }, "successCount": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 } }, "required": [ "period", "projectID", "environmentID", "count", "functionID", "name", "successCount" ] } } }, "required": [ "items" ] }, { "type": "object", "properties": { "cursor": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "projectID": { "type": "string" }, "environmentID": { "type": "string" }, "count": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "apiToolID": { "type": "string" }, "name": { "type": "string" }, "successCount": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 } }, "required": [ "period", "projectID", "environmentID", "count", "apiToolID", "name", "successCount" ] } } }, "required": [ "items" ] }, { "type": "object", "properties": { "cursor": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "projectID": { "type": "string" }, "environmentID": { "type": "string" }, "count": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "documentID": { "type": "string" } }, "required": [ "period", "projectID", "environmentID", "count", "documentID" ] } } }, "required": [ "items" ] }, { "type": "object", "properties": { "cursor": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "projectID": { "type": "string" }, "environmentID": { "type": "string" }, "count": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "integrationToolName": { "type": "string" }, "successCount": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 } }, "required": [ "period", "projectID", "environmentID", "count", "integrationToolName", "successCount" ] } } }, "required": [ "items" ] }, { "type": "object", "properties": { "cursor": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "projectID": { "type": "string" }, "environmentID": { "type": "string" }, "count": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 } }, "required": [ "period", "projectID", "environmentID", "count" ] } } }, "required": [ "items" ] }, { "type": "object", "properties": { "cursor": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "projectID": { "type": "string" }, "environmentID": { "type": "string" }, "count": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "agentID": { "type": "string" }, "name": { "type": "string" }, "successCount": { "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 } }, "required": [ "period", "projectID", "environmentID", "count", "agentID", "name", "successCount" ] } } }, "required": [ "items" ] } ] } }, "required": [ "result" ] } } } }, "401": { "description": "The provided authentication token does not have permissions for some of the requested resources" } }, "security": [ { "auth": [] } ], "tags": [ "Usage", "Public-Docs" ] } }, "/v1/transcript/project/{projectID}": { "post": { "operationId": "TranscriptPublicController_searchByProjectID_v1", "summary": "Search transcripts", "description": "Search for transcripts matching the specified criteria with pagination.", "parameters": [ { "name": "projectID", "in": "path", "description": "ID of the target Voiceflow project.", "required": true, "schema": { "description": "ID of the target Voiceflow project.", "type": "string" } }, { "name": "take", "in": "query", "required": false, "schema": { "description": "The maximum number of results to return, used for pagination", "type": "integer", "default": 25, "maximum": 100, "minimum": 1 } }, { "name": "skip", "in": "query", "required": false, "schema": { "description": "The number of results to skip, used for pagination.", "type": "integer", "default": 0, "maximum": 9007199254740991, "minimum": 0 } }, { "name": "order", "in": "query", "required": false, "schema": { "description": "Used to control the order of the results returned.", "type": "string", "default": "DESC", "enum": [ "ASC", "DESC" ], "x-enumNames": [ "ASC", "DESC" ] } }, { "name": "encode", "in": "query", "required": false, "schema": { "description": "Escape HTML special characters that appear in transcripts.", "type": "boolean" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchTranscriptsRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "transcripts": { "type": "array", "items": { "$ref": "#/components/schemas/SearchProjectTranscriptsResponseItem" } } }, "additionalProperties": false, "required": [ "transcripts" ] } } } } }, "security": [ { "auth": [] } ], "tags": [ "Transcript", "Public-Docs" ] } }, "/v1/transcript/{transcriptID}": { "get": { "operationId": "TranscriptPublicController_findOneWithLogs_v1", "summary": "Get transcript", "description": "Fetch a transcript with its logs, properties and evaluation results.", "parameters": [ { "name": "transcriptID", "in": "path", "description": "ID of the transcript to target.", "required": true, "schema": { "description": "ID of the transcript to target.", "type": "string" } }, { "name": "unredacted", "in": "query", "required": false, "schema": { "description": "When enabled, un-redacted logs will be returned if they are still available.", "type": "boolean" } }, { "name": "filterConversation", "in": "query", "required": false, "schema": { "description": "When enabled, only `text`, `speak` and `live-agent-handoff` traces will be returned.", "type": "boolean" } }, { "name": "customTraceTypes", "in": "query", "required": false, "schema": { "description": "Used to indicate additional trace types that should be returned when `filterConversation` is enabled.", "type": "array", "items": { "type": "string" } } }, { "name": "encode", "in": "query", "required": false, "schema": { "description": "Escape HTML special characters that appear in transcripts.", "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "transcript": { "$ref": "#/components/schemas/TranscriptWithLogsResponse" } }, "additionalProperties": false, "required": [ "transcript" ] } } } } }, "security": [ { "auth": [] } ], "tags": [ "Transcript", "Public-Docs" ] }, "delete": { "operationId": "TranscriptPublicController_deleteOne_v1", "summary": "Delete transcript", "description": "Remove this transcript, its logs and all evaluation results.", "parameters": [ { "name": "transcriptID", "in": "path", "description": "ID of the transcript to target.", "required": true, "schema": { "description": "ID of the transcript to target.", "type": "string" } } ], "responses": { "204": { "description": "" } }, "security": [ { "auth": [] } ], "tags": [ "Transcript", "Public-Docs" ] } }, "/v1/transcript/{transcriptID}/project/{projectID}/end": { "post": { "operationId": "TranscriptPublicController_endTranscript_v1", "summary": "End transcript", "description": "Mark a transcript as complete. Once ended, enabled evaluations will be triggered.", "parameters": [ { "name": "transcriptID", "in": "path", "description": "ID of the transcript to target.", "required": true, "schema": { "description": "ID of the transcript to target.", "type": "string" } }, { "name": "projectID", "in": "path", "description": "ID of the target Voiceflow project.", "required": true, "schema": { "description": "ID of the target Voiceflow project.", "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "auth": [] } ], "tags": [ "Transcript", "Public-Docs" ] } }, "/v1/transcript-property/project/{projectID}": { "get": { "operationId": "TranscriptPropertyPublicController_searchByProjectID_v1", "summary": "Get all transcript properties", "description": "Get all transcript properties for the specified project.", "parameters": [ { "name": "projectID", "in": "path", "description": "ID of the target Voiceflow project.", "required": true, "schema": { "description": "ID of the target Voiceflow project.", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "properties": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptPropertyResponse" } } }, "required": [ "properties" ] } } } } }, "security": [ { "auth": [] } ], "tags": [ "Transcript property", "Public-Docs" ] } }, "/v1/transcript-property/{propertyID}": { "get": { "operationId": "TranscriptPropertyPublicController_findOne_v1", "summary": "Get transcript property", "description": "Get the definition of the specified transcript property.", "parameters": [ { "name": "propertyID", "in": "path", "description": "ID of the property to target.", "required": true, "schema": { "description": "ID of the property to target.", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/TranscriptPropertyResponse" } }, "required": [ "property" ] } } } } }, "security": [ { "auth": [] } ], "tags": [ "Transcript property", "Public-Docs" ] }, "patch": { "operationId": "TranscriptPropertyPublicController_update_v1", "summary": "Update transcript property", "description": "Update the definition of the specified transcript property.", "parameters": [ { "name": "propertyID", "in": "path", "description": "ID of the property to target.", "required": true, "schema": { "description": "ID of the property to target.", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "The name of this property.", "type": "string", "maxLength": 100, "minLength": 1 }, "type": { "allOf": [ { "$ref": "#/components/schemas/TranscriptPropertyType" } ] } }, "additionalProperties": false } } } }, "responses": { "204": { "description": "" } }, "security": [ { "auth": [] } ], "tags": [ "Transcript property", "Public-Docs" ] }, "delete": { "operationId": "TranscriptPropertyPublicController_deleteOne_v1", "summary": "Delete transcript property", "description": "Remove the specified property from all transcripts along with their values.", "parameters": [ { "name": "propertyID", "in": "path", "description": "ID of the property to target.", "required": true, "schema": { "description": "ID of the property to target.", "type": "string" } } ], "responses": { "204": { "description": "" } }, "security": [ { "auth": [] } ], "tags": [ "Transcript property", "Public-Docs" ] } }, "/v1/transcript-property": { "post": { "operationId": "TranscriptPropertyPublicController_create_v1", "summary": "Create transcript property", "description": "Create a new transcript property definition.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectID": { "description": "ID of the project this property belongs to.", "type": "string", "maxLength": 24, "minLength": 24 }, "name": { "description": "The name of this property.", "type": "string", "maxLength": 100, "minLength": 1 }, "type": { "$ref": "#/components/schemas/TranscriptPropertyType" } }, "additionalProperties": false, "required": [ "projectID", "name", "type" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "property": { "$ref": "#/components/schemas/TranscriptPropertyResponse" } }, "required": [ "property" ] } } } } }, "security": [ { "auth": [] } ], "tags": [ "Transcript property", "Public-Docs" ] } }, "/v1/transcript-property-value": { "post": { "operationId": "TranscriptPropertyValuePublicController_create_v1", "summary": "Set transcript property value", "description": "Associate a value with the specified property and transcript.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "propertyID": { "description": "ID of the transcript property to target.", "type": "string" }, "transcriptID": { "description": "ID of the transcript to target.", "type": "string" }, "value": { "description": "Value of the transcript property to be set.", "type": "string" }, "metadata": { "description": "Additional metadata associated with the property value.", "type": "object", "additionalProperties": {}, "nullable": true } }, "additionalProperties": false, "required": [ "propertyID", "transcriptID", "value" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "propertyValue": { "$ref": "#/components/schemas/TranscriptPropertyValueResponse" } }, "required": [ "propertyValue" ] } } } } }, "security": [ { "auth": [] } ], "tags": [ "Transcript property value", "Public-Docs" ] } }, "/v1/transcript-property-value/transcript/{transcriptID}/property/{propertyID}": { "delete": { "operationId": "TranscriptPropertyValuePublicController_deleteOne_v1", "summary": "Delete transcript property value", "description": "Remove the value of a property from the specified transcript.", "parameters": [ { "name": "propertyID", "in": "path", "description": "ID of the property to target.", "required": true, "schema": { "description": "ID of the property to target.", "type": "string" } }, { "name": "transcriptID", "in": "path", "description": "ID of the transcript to target.", "required": true, "schema": { "description": "ID of the transcript to target.", "type": "string" } } ], "responses": { "204": { "description": "" } }, "security": [ { "auth": [] } ], "tags": [ "Transcript property value", "Public-Docs" ] } }, "/v1/transcript-property-value/transcript/{transcriptID}": { "get": { "operationId": "TranscriptPropertyValuePublicController_getTranscriptPropertyValues_v1", "summary": "Get all transcript property values", "description": "Get all property values associated with the specified transcript.", "parameters": [ { "name": "transcriptID", "in": "path", "description": "ID of the transcript to target.", "required": true, "schema": { "description": "ID of the transcript to target.", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "propertyValues": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptPropertyValueResponse" } } }, "required": [ "propertyValues" ] } } } } }, "security": [ { "auth": [] } ], "tags": [ "Transcript property value", "Public-Docs" ] } }, "/v1/transcript-evaluation": { "post": { "operationId": "TranscriptEvaluationPublicController_create_v1", "summary": "Create transcript evaluation", "description": "Create a new transcript evaluation definition.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTranscriptEvaluationRequest" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "evaluation": { "$ref": "#/components/schemas/TranscriptEvaluationResponse" } }, "required": [ "evaluation" ] } } } } }, "security": [ { "auth": [] } ], "tags": [ "Transcript evaluation", "Public-Docs" ] } }, "/v1/transcript-evaluation/{evaluationID}": { "patch": { "operationId": "TranscriptEvaluationPublicController_update_v1", "summary": "Update transcript evaluation", "description": "Update the definition of the specified transcript evaluation.", "parameters": [ { "name": "evaluationID", "in": "path", "description": "ID of the transcript evaluation to target.", "required": true, "schema": { "description": "ID of the transcript evaluation to target.", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "name": { "description": "Name of the evaluation.", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "description": "Description of the evaluation.", "type": "string", "maxLength": 250, "nullable": true }, "enabled": { "description": "When enabled, evaluations will be run on every new transcript.", "type": "boolean" }, "prompt": { "description": "This prompt describes how the LLM should apply this evaluation.", "type": "string", "maxLength": 10000, "minLength": 1 }, "settings": { "description": "The model settings passed when invoking this evaluation.", "allOf": [ { "$ref": "#/components/schemas/TranscriptEvaluationSettings" } ] }, "logInjectionSettings": { "description": "The additional log types which should be injected into this evaluation.", "allOf": [ { "$ref": "#/components/schemas/TranscriptEvaluationLogInjectionSettings" } ] }, "truePrompt": { "description": "This prompt describes which transcripts should evaluate as 'true'.", "type": "string", "maxLength": 10000, "minLength": 1 }, "falsePrompt": { "description": "This prompt describes which transcripts should evaluate as 'false'.", "type": "string", "maxLength": 10000, "minLength": 1 } }, "additionalProperties": false }, { "type": "object", "properties": { "name": { "description": "Name of the evaluation.", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "description": "Description of the evaluation.", "type": "string", "maxLength": 250, "nullable": true }, "enabled": { "description": "When enabled, evaluations will be run on every new transcript.", "type": "boolean" }, "prompt": { "description": "This prompt describes how the LLM should apply this evaluation.", "type": "string", "maxLength": 10000, "minLength": 1 }, "settings": { "description": "The model settings passed when invoking this evaluation.", "allOf": [ { "$ref": "#/components/schemas/TranscriptEvaluationSettings" } ] }, "logInjectionSettings": { "description": "The additional log types which should be injected into this evaluation.", "allOf": [ { "$ref": "#/components/schemas/TranscriptEvaluationLogInjectionSettings" } ] }, "minimumPrompt": { "description": "This prompt describes which transcripts should receive lower ratings.", "type": "string", "maxLength": 10000, "minLength": 1 }, "maximumPrompt": { "description": "This prompt describes which transcripts should receive higher ratings.", "type": "string", "maxLength": 10000, "minLength": 1 } }, "additionalProperties": false }, { "type": "object", "properties": { "name": { "description": "Name of the evaluation.", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "description": "Description of the evaluation.", "type": "string", "maxLength": 250, "nullable": true }, "enabled": { "description": "When enabled, evaluations will be run on every new transcript.", "type": "boolean" }, "prompt": { "description": "This prompt describes how the LLM should apply this evaluation.", "type": "string", "maxLength": 10000, "minLength": 1 }, "settings": { "description": "The model settings passed when invoking this evaluation.", "allOf": [ { "$ref": "#/components/schemas/TranscriptEvaluationSettings" } ] }, "logInjectionSettings": { "description": "The additional log types which should be injected into this evaluation.", "allOf": [ { "$ref": "#/components/schemas/TranscriptEvaluationLogInjectionSettings" } ] } }, "additionalProperties": false }, { "type": "object", "properties": { "name": { "description": "Name of the evaluation.", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "description": "Description of the evaluation.", "type": "string", "maxLength": 250, "nullable": true }, "enabled": { "description": "When enabled, evaluations will be run on every new transcript.", "type": "boolean" }, "prompt": { "description": "This prompt describes how the LLM should apply this evaluation.", "type": "string", "maxLength": 10000, "minLength": 1 }, "settings": { "description": "The model settings passed when invoking this evaluation.", "allOf": [ { "$ref": "#/components/schemas/TranscriptEvaluationSettings" } ] }, "logInjectionSettings": { "description": "The additional log types which should be injected into this evaluation.", "allOf": [ { "$ref": "#/components/schemas/TranscriptEvaluationLogInjectionSettings" } ] }, "options": { "description": "The options that should be evaluated for.", "type": "array", "items": { "$ref": "#/components/schemas/TranscriptEvaluationOptionSchema" }, "maxItems": 20, "minItems": 1 } }, "additionalProperties": false } ] } } } }, "responses": { "204": { "description": "" } }, "security": [ { "auth": [] } ], "tags": [ "Transcript evaluation", "Public-Docs" ] }, "get": { "operationId": "TranscriptEvaluationPublicController_findOne_v1", "summary": "Get transcript evaluation", "description": "Get the definition of the specified transcript evaluation.", "parameters": [ { "name": "evaluationID", "in": "path", "description": "ID of the transcript evaluation to target.", "required": true, "schema": { "description": "ID of the transcript evaluation to target.", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "evaluation": { "$ref": "#/components/schemas/TranscriptEvaluationResponse" } }, "required": [ "evaluation" ] } } } } }, "security": [ { "auth": [] } ], "tags": [ "Transcript evaluation", "Public-Docs" ] }, "delete": { "operationId": "TranscriptEvaluationPublicController_deleteOne_v1", "summary": "Delete transcript evaluation", "description": "Remove the specified evaluation along with results for all transcripts.", "parameters": [ { "name": "evaluationID", "in": "path", "description": "ID of the transcript evaluation to target.", "required": true, "schema": { "description": "ID of the transcript evaluation to target.", "type": "string" } } ], "responses": { "204": { "description": "" } }, "security": [ { "auth": [] } ], "tags": [ "Transcript evaluation", "Public-Docs" ] } }, "/v1/transcript-evaluation/project/{projectID}": { "get": { "operationId": "TranscriptEvaluationPublicController_searchByProjectID_v1", "summary": "Get all evaluations", "description": "Get all project evaluations including the number of results per evaluation", "parameters": [ { "name": "projectID", "in": "path", "description": "ID of the target Voiceflow project.", "required": true, "schema": { "description": "ID of the target Voiceflow project.", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "evaluations": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptEvaluationResponse" } } }, "required": [ "evaluations" ] } } } } }, "security": [ { "auth": [] } ], "tags": [ "Transcript evaluation", "Public-Docs" ] } }, "/v1/transcript-evaluation/queue": { "post": { "operationId": "TranscriptEvaluationPublicController_queue_v1", "summary": "Batch run transcript evaluations", "description": "Queue a batch of evaluations to run for the specified transcripts.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectID": { "type": "string", "maxLength": 24, "minLength": 24 }, "evaluationIDs": { "type": "array", "items": { "type": "string", "minLength": 24, "maxLength": 24 }, "maxItems": 10, "minItems": 1 }, "transcriptIDs": { "type": "array", "items": { "type": "string", "minLength": 24, "maxLength": 24 }, "maxItems": 100, "minItems": 1 } }, "additionalProperties": false, "required": [ "projectID", "evaluationIDs", "transcriptIDs" ] } } } }, "responses": { "201": { "description": "One or more transcripts were successfully queued for evaluation. A warning will be returned if the per-project queue limit was exceeded including details of all skipped transcripts.", "content": { "application/json": { "schema": { "type": "object", "properties": { "transcriptCount": { "description": "The total number of transcripts queued for one or more evaluation.", "type": "number" }, "evaluationCount": { "description": "The total number of evaluations queued across all transcripts.", "type": "number" }, "warning": { "description": "Returned when the per-project quota for queuing evaluations has been exceeded.", "allOf": [ { "$ref": "#/components/schemas/QueueTranscriptEvaluationsWarning" } ] } }, "required": [ "transcriptCount", "evaluationCount" ] } } } }, "429": { "description": "No evaluations could be queued because the limit has been exceeded for this project. Retry after waiting for the time indicated in the response." } }, "security": [ { "auth": [] } ], "tags": [ "Transcript evaluation", "Public-Docs" ] } }, "/v1/transcript-evaluation/{evaluationID}/transcript/{transcriptID}": { "post": { "operationId": "TranscriptEvaluationPublicController_runEvaluation_v1", "summary": "Run transcript evaluation", "description": "Run a single evaluation for the specified transcript.", "parameters": [ { "name": "evaluationID", "in": "path", "description": "ID of the transcript evaluation to target.", "required": true, "schema": { "description": "ID of the transcript evaluation to target.", "type": "string" } }, { "name": "transcriptID", "in": "path", "description": "ID of the transcript to target.", "required": true, "schema": { "description": "ID of the transcript to target.", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectID": { "type": "string", "maxLength": 24, "minLength": 24 } }, "additionalProperties": false, "required": [ "projectID" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "object", "additionalProperties": false, "properties": { "transcriptID": { "type": "string" }, "evaluationID": { "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] }, "reason": { "type": "string" }, "cost": { "type": "number" } }, "required": [ "transcriptID", "evaluationID", "value", "reason", "cost" ] } }, "additionalProperties": false, "required": [ "result" ] } } } } }, "security": [ { "auth": [] } ], "tags": [ "Transcript evaluation", "Public-Docs" ] } }, "/v1/transcript-evaluation/estimate": { "post": { "operationId": "TranscriptEvaluationPublicController_estimate_v1", "summary": "Estimate transcript evaluation", "description": "Estimate the cost of running the specified evaluation for transcript matching the provided filters.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "description": "Filter transcripts based on properties and evaluation results.", "allOf": [ { "$ref": "#/components/schemas/TranscriptFilterArray" } ], "maxItems": 50 }, "endDate": { "description": "Select transcripts that were started before a specific date.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sessionID": { "description": "Select transcripts by sessionID.", "type": "string" }, "search": { "description": "Select transcripts containing these keywords in a user or agent message.", "type": "string", "maxLength": 256, "minLength": 1 }, "startDate": { "description": "Select transcripts that were started after a specific date.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAfter": { "description": "Select transcripts that were last updated at or after a specific date.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedBefore": { "description": "Select transcripts that were last updated at or before a specific date.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "environmentID": { "description": "@deprecated use versionID and projectEnvironmentIDOrAlias instead", "anyOf": [ { "type": "string" }, { "minItems": 1, "maxItems": 2, "type": "array", "items": { "$ref": "#/components/schemas/VersionTag" } } ], "deprecated": true }, "versionID": { "type": "string" }, "projectEnvironmentIDOrAlias": { "type": "string" }, "evaluationIDs": { "type": "array", "items": { "type": "string", "minLength": 24, "maxLength": 24 }, "minItems": 1 } }, "additionalProperties": false, "required": [ "evaluationIDs" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateTranscriptEvaluationResponse" } } } } }, "security": [ { "auth": [] } ], "tags": [ "Transcript evaluation", "Public-Docs" ] } } }, "components": { "schemas": { "UsageQueryBaseListFilterV2": { "description": "A base filter supported by all queries that return a list", "type": "object", "properties": { "projectID": { "type": "string", "minLength": 1 }, "startTime": { "description": "A timestamp in ISO-8601 format", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "endTime": { "description": "A timestamp in ISO-8601 format", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "projectEnvironmentIDOrAlias": { "description": "One or more Voiceflow project environment IDs or aliases", "anyOf": [ { "type": "string", "minLength": 1 }, { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } ] }, "limit": { "type": "integer", "default": 100, "maximum": 500, "minimum": 1 }, "cursor": { "type": "number" } }, "required": [ "projectID" ] }, "__schema0": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, { "type": "array", "items": { "$ref": "#/components/schemas/__schema0" } }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/__schema0" } } ] }, "BooleanTranscriptEvaluation": { "type": "object", "properties": { "id": { "type": "string" }, "projectID": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "default": { "type": "boolean" }, "enabled": { "type": "boolean" }, "averageCost": { "type": "number", "nullable": true }, "prompt": { "type": "string" }, "settings": { "$ref": "#/components/schemas/TranscriptEvaluationSettings" }, "systemTag": { "type": "string", "nullable": true }, "logInjectionSettings": { "$ref": "#/components/schemas/TranscriptEvaluationLogInjectionSettings" }, "type": { "type": "string", "enum": [ "boolean" ], "x-enumNames": [ "BOOLEAN" ] }, "truePrompt": { "type": "string" }, "falsePrompt": { "type": "string" } }, "required": [ "id", "projectID", "name", "description", "default", "enabled", "averageCost", "prompt", "settings", "systemTag", "logInjectionSettings", "type", "truePrompt", "falsePrompt" ] }, "TranscriptEvaluationSettings": { "allOf": [ { "$ref": "#/components/schemas/AgentSettings" } ], "nullable": true }, "AgentSettings": { "type": "object", "properties": { "model": { "allOf": [ { "$ref": "#/components/schemas/AIModel" } ] }, "realtime": { "type": "object", "properties": { "voice": { "type": "string" }, "eagerness": { "type": "string" } } }, "maxTokens": { "type": "number" }, "temperature": { "type": "number" }, "reasoningEffort": { "allOf": [ { "$ref": "#/components/schemas/AIReasoningEffort" } ], "nullable": true } } }, "AIModel": { "type": "string", "enum": [ "gpt-3.5-turbo-1106", "gpt-3.5-turbo", "gpt-4", "gpt-4o", "gpt-4o-mini", "gpt-4.1-2025-04-14", "gpt-4.1-mini-2025-04-14", "gpt-4.1-nano-2025-04-14", "gpt-o3-mini", "o3-2025-04-16", "o4-mini-2025-04-16", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-5.2", "gpt-5.4", "gpt-5.4-mini", "gpt-5.5", "gpt-5.6-sol", "gpt-5.6-terra", "gpt-5.6-luna", "gpt-realtime", "claude-4-opus", "claude-4-sonnet", "claude-4.5-sonnet", "claude-4.6-sonnet", "claude-4.5-haiku", "claude-4.5-opus", "claude-4.7-opus", "bedrock-claude-4-sonnet", "bedrock-claude-4.5-sonnet", "bedrock-claude-4.6-sonnet", "bedrock-claude-5-sonnet", "bedrock-claude-4.5-haiku", "bedrock-claude-4.5-opus", "bedrock-claude-4.7-opus", "bedrock-claude-4.8-opus", "voiceflow-core-4.0", "voiceflow-core-4.1", "voiceflow-flash-4.1", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-live-2.5-flash", "gemini-3-flash", "gemini-3.5-flash", "gemini-3.1-pro", "gpt-oss-20b", "gpt-oss-120b", "llama-guard-4", "llama-3.1-instant", "llama-3.3-versatile", "qwen3.6-27b", "gemini-flash-2", "gpt-4-turbo", "claude-3.5-haiku", "claude-3-opus", "claude-3.7-sonnet", "claude-v2", "llama-3.2-1b-preview", "gemini-pro-1.5", "claude-3-haiku", "claude-3-sonnet", "text-davinci-003", "claude-v1", "claude-instant-v1", "deep-seek-r1-distill-llama-70B", "claude-3.5-sonnet" ], "x-enumNames": [ "GPT_3_5_TURBO_1106", "GPT_3_5_TURBO", "GPT_4", "GPT_4_O", "GPT_4_O_MINI", "GPT_4_1", "GPT_4_1_MINI", "GPT_4_1_NANO", "GPT_O_3_MINI", "GPT_O_3", "GPT_O_4_MINI", "GPT_5", "GPT_5_MINI", "GPT_5_NANO", "GPT_5_2", "GPT_5_4", "GPT_5_4_MINI", "GPT_5_5", "GPT_5_6_SOL", "GPT_5_6_TERRA", "GPT_5_6_LUNA", "GPT_REALTIME", "CLAUDE_4_OPUS", "CLAUDE_4_SONNET", "CLAUDE_4_5_SONNET", "CLAUDE_4_6_SONNET", "CLAUDE_4_5_HAIKU", "CLAUDE_4_5_OPUS", "CLAUDE_4_7_OPUS", "BEDROCK_CLAUDE_4_SONNET", "BEDROCK_CLAUDE_4_5_SONNET", "BEDROCK_CLAUDE_4_6_SONNET", "BEDROCK_CLAUDE_5_SONNET", "BEDROCK_CLAUDE_4_5_HAIKU", "BEDROCK_CLAUDE_4_5_OPUS", "BEDROCK_CLAUDE_4_7_OPUS", "BEDROCK_CLAUDE_4_8_OPUS", "VOICEFLOW_CORE_4_0", "VOICEFLOW_CORE_4_1", "VOICEFLOW_FLASH_4_1", "GEMINI_2_5_PRO", "GEMINI_2_5_FLASH", "GEMINI_LIVE_2_5_FLASH", "GEMINI_3_FLASH", "GEMINI_3_5_FLASH", "GEMINI_3_1_PRO", "GPT_OSS_20_B", "GPT_OSS_120_B", "LLAMA_GUARD_4", "LLAMA_3_1_INSTANT", "LLAMA_3_3_VERSATILE", "QWEN_3_6_27_B", "GEMINI_FLASH_2", "GPT_4_TURBO", "CLAUDE_3_5_HAIKU", "CLAUDE_3_OPUS", "CLAUDE_3_7_SONNET", "CLAUDE_V_2", "LLAMA_3_2_1_B_PREVIEW", "GEMINI_PRO_1_5", "CLAUDE_3_HAIKU", "CLAUDE_3_SONNET", "DA_VINCI_003", "CLAUDE_V_1", "CLAUDE_INSTANT_V_1", "DEEP_SEEK_R_1_DISTILL_LLAMA_70_B", "CLAUDE_3_5_SONNET" ] }, "AIReasoningEffort": { "type": "string", "enum": [ "minimal", "low", "medium", "high" ], "x-enumNames": [ "MINIMAL", "LOW", "MEDIUM", "HIGH" ] }, "TranscriptEvaluationLogInjectionSettings": { "type": "object", "properties": { "playbookExecution": { "type": "boolean" }, "workflowExecution": { "type": "boolean" }, "toolExecution": { "type": "boolean" } }, "required": [ "playbookExecution", "workflowExecution", "toolExecution" ] }, "NumberTranscriptEvaluation": { "type": "object", "properties": { "id": { "type": "string" }, "projectID": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "default": { "type": "boolean" }, "enabled": { "type": "boolean" }, "averageCost": { "type": "number", "nullable": true }, "prompt": { "type": "string" }, "settings": { "$ref": "#/components/schemas/TranscriptEvaluationSettings" }, "systemTag": { "type": "string", "nullable": true }, "logInjectionSettings": { "$ref": "#/components/schemas/TranscriptEvaluationLogInjectionSettings" }, "type": { "type": "string", "enum": [ "number" ], "x-enumNames": [ "NUMBER" ] }, "minimumValue": { "type": "number" }, "minimumPrompt": { "type": "string" }, "maximumValue": { "type": "number" }, "maximumPrompt": { "type": "string" } }, "required": [ "id", "projectID", "name", "description", "default", "enabled", "averageCost", "prompt", "settings", "systemTag", "logInjectionSettings", "type", "minimumValue", "minimumPrompt", "maximumValue", "maximumPrompt" ] }, "StringTranscriptEvaluation": { "type": "object", "properties": { "id": { "type": "string" }, "projectID": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "default": { "type": "boolean" }, "enabled": { "type": "boolean" }, "averageCost": { "type": "number", "nullable": true }, "prompt": { "type": "string" }, "settings": { "$ref": "#/components/schemas/TranscriptEvaluationSettings" }, "systemTag": { "type": "string", "nullable": true }, "logInjectionSettings": { "$ref": "#/components/schemas/TranscriptEvaluationLogInjectionSettings" }, "type": { "type": "string", "enum": [ "string" ], "x-enumNames": [ "STRING" ] } }, "required": [ "id", "projectID", "name", "description", "default", "enabled", "averageCost", "prompt", "settings", "systemTag", "logInjectionSettings", "type" ] }, "OptionTranscriptEvaluation": { "type": "object", "properties": { "id": { "type": "string" }, "projectID": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "default": { "type": "boolean" }, "enabled": { "type": "boolean" }, "averageCost": { "type": "number", "nullable": true }, "prompt": { "type": "string" }, "settings": { "$ref": "#/components/schemas/TranscriptEvaluationSettings" }, "systemTag": { "type": "string", "nullable": true }, "logInjectionSettings": { "$ref": "#/components/schemas/TranscriptEvaluationLogInjectionSettings" }, "type": { "type": "string", "enum": [ "option" ], "x-enumNames": [ "OPTION" ] }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptEvaluationOptionSchema" } } }, "required": [ "id", "projectID", "name", "description", "default", "enabled", "averageCost", "prompt", "settings", "systemTag", "logInjectionSettings", "type", "options" ] }, "TranscriptEvaluationOptionSchema": { "type": "object", "properties": { "value": { "type": "string", "maxLength": 100, "minLength": 1 }, "prompt": { "type": "string", "maxLength": 10000, "minLength": 1 }, "included": { "type": "boolean" }, "color": { "type": "string" } }, "additionalProperties": false, "required": [ "value", "prompt", "included", "color" ] }, "TranscriptEvaluationResponse": { "oneOf": [ { "$ref": "#/components/schemas/BooleanTranscriptEvaluation" }, { "$ref": "#/components/schemas/NumberTranscriptEvaluation" }, { "$ref": "#/components/schemas/StringTranscriptEvaluation" }, { "$ref": "#/components/schemas/OptionTranscriptEvaluation" } ] }, "EstimateTranscriptEvaluationResponse": { "type": "object", "properties": { "totalCost": { "type": "number" }, "breakdown": { "type": "object", "properties": { "transcriptCount": { "type": "number" }, "evaluations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "cost": { "type": "number" } }, "required": [ "id", "cost" ] } } }, "required": [ "transcriptCount", "evaluations" ] } }, "additionalProperties": false, "required": [ "totalCost", "breakdown" ] }, "TranscriptFilter": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "op": { "type": "string", "enum": [ "gt", "gte", "lt", "lte" ], "x-enumNames": [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL" ] }, "value": { "type": "number" } }, "required": [ "id", "op", "value" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "type": "string", "enum": [ "eq", "neq" ], "x-enumNames": [ "EQUALS", "NOT_EQUALS" ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, { "type": "boolean" } ] } }, "required": [ "id", "op", "value" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "type": "string", "enum": [ "between" ], "x-enumNames": [ "BETWEEN" ] }, "value": { "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "number" } ] }, "maxItems": 2, "minItems": 2 } }, "required": [ "id", "op", "value" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "type": "string", "enum": [ "in", "nin" ], "x-enumNames": [ "IN", "NOT_IN" ] }, "value": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "id", "op", "value" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "type": "string", "enum": [ "contains" ], "x-enumNames": [ "CONTAINS" ] }, "value": { "type": "string" } }, "required": [ "id", "op", "value" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "type": "string", "enum": [ "exists", "not_exists" ], "x-enumNames": [ "EXISTS", "NOT_EXISTS" ] } }, "required": [ "id", "op" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "op": { "type": "string", "enum": [ "json_contains" ], "x-enumNames": [ "JSONB_ARRAY_CONTAINS" ] }, "value": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "id", "op", "value" ] } ] }, "TranscriptFilterArray": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptFilter" } }, "VersionTag": { "description": "@deprecated use versionID instead", "type": "string", "deprecated": true, "enum": [ "development", "staging", "production" ], "x-enumNames": [ "DEVELOPMENT", "STAGING", "PRODUCTION" ] }, "QueueTranscriptEvaluationsWarning": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "quota_exceeded" ], "x-enumNames": [ "QUOTA_EXCEEDED" ] }, "message": { "type": "string" }, "skippedTranscriptIDs": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "message", "skippedTranscriptIDs" ] }, "CreateBooleanTranscriptEvaluation": { "description": "Create a binary evaluation.", "type": "object", "properties": { "projectID": { "description": "ID of the target Voiceflow project.", "type": "string", "maxLength": 24, "minLength": 24 }, "name": { "description": "Name of the evaluation.", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "description": "Description of the evaluation.", "type": "string", "maxLength": 250, "nullable": true }, "enabled": { "description": "When enabled, evaluations will be run on every new transcript.", "type": "boolean" }, "prompt": { "description": "This prompt describes how the LLM should apply this evaluation.", "type": "string", "maxLength": 10000, "minLength": 1 }, "settings": { "description": "The model settings passed when invoking this evaluation.", "allOf": [ { "$ref": "#/components/schemas/TranscriptEvaluationSettings" } ] }, "type": { "description": "The type of binary evaluations.", "type": "string", "enum": [ "boolean" ], "x-enumNames": [ "BOOLEAN" ] }, "truePrompt": { "description": "This prompt describes which transcripts should evaluate as 'true'.", "type": "string", "maxLength": 10000, "minLength": 1 }, "falsePrompt": { "description": "This prompt describes which transcripts should evaluate as 'false'.", "type": "string", "maxLength": 10000, "minLength": 1 } }, "additionalProperties": false, "required": [ "projectID", "name", "enabled", "prompt", "type", "truePrompt", "falsePrompt" ] }, "CreateNumberTranscriptEvaluation": { "description": "Create a rating evaluation.", "type": "object", "properties": { "projectID": { "description": "ID of the target Voiceflow project.", "type": "string", "maxLength": 24, "minLength": 24 }, "name": { "description": "Name of the evaluation.", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "description": "Description of the evaluation.", "type": "string", "maxLength": 250, "nullable": true }, "enabled": { "description": "When enabled, evaluations will be run on every new transcript.", "type": "boolean" }, "prompt": { "description": "This prompt describes how the LLM should apply this evaluation.", "type": "string", "maxLength": 10000, "minLength": 1 }, "settings": { "description": "The model settings passed when invoking this evaluation.", "allOf": [ { "$ref": "#/components/schemas/TranscriptEvaluationSettings" } ] }, "type": { "description": "The type of rating evaluations.", "type": "string", "enum": [ "number" ], "x-enumNames": [ "NUMBER" ] }, "minimumValue": { "description": "The lowest rating that can be applied.", "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "minimumPrompt": { "description": "This prompt describes which transcripts should receive lower ratings.", "type": "string", "maxLength": 10000, "minLength": 1 }, "maximumValue": { "description": "The highest rating that can be applied.", "type": "integer", "maximum": 9007199254740991, "minimum": -9007199254740991 }, "maximumPrompt": { "description": "This prompt describes which transcripts should receive higher ratings.", "type": "string", "maxLength": 10000, "minLength": 1 } }, "additionalProperties": false, "required": [ "projectID", "name", "enabled", "prompt", "type", "minimumValue", "minimumPrompt", "maximumValue", "maximumPrompt" ] }, "CreateStringTranscriptEvaluation": { "description": "Create a text evaluation.", "type": "object", "properties": { "projectID": { "description": "ID of the target Voiceflow project.", "type": "string", "maxLength": 24, "minLength": 24 }, "name": { "description": "Name of the evaluation.", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "description": "Description of the evaluation.", "type": "string", "maxLength": 250, "nullable": true }, "enabled": { "description": "When enabled, evaluations will be run on every new transcript.", "type": "boolean" }, "prompt": { "description": "This prompt describes how the LLM should apply this evaluation.", "type": "string", "maxLength": 10000, "minLength": 1 }, "settings": { "description": "The model settings passed when invoking this evaluation.", "allOf": [ { "$ref": "#/components/schemas/TranscriptEvaluationSettings" } ] }, "type": { "description": "The type of text evaluations.", "type": "string", "enum": [ "string" ], "x-enumNames": [ "STRING" ] } }, "additionalProperties": false, "required": [ "projectID", "name", "enabled", "prompt", "type" ] }, "CreateOptionTranscriptEvaluation": { "description": "Create a options evaluation.", "type": "object", "properties": { "projectID": { "description": "ID of the target Voiceflow project.", "type": "string", "maxLength": 24, "minLength": 24 }, "name": { "description": "Name of the evaluation.", "type": "string", "maxLength": 100, "minLength": 1 }, "description": { "description": "Description of the evaluation.", "type": "string", "maxLength": 250, "nullable": true }, "enabled": { "description": "When enabled, evaluations will be run on every new transcript.", "type": "boolean" }, "prompt": { "description": "This prompt describes how the LLM should apply this evaluation.", "type": "string", "maxLength": 10000, "minLength": 1 }, "settings": { "description": "The model settings passed when invoking this evaluation.", "allOf": [ { "$ref": "#/components/schemas/TranscriptEvaluationSettings" } ] }, "type": { "description": "The type of options evaluations.", "type": "string", "enum": [ "option" ], "x-enumNames": [ "OPTION" ] }, "options": { "description": "The options that should be evaluated for.", "type": "array", "items": { "$ref": "#/components/schemas/TranscriptEvaluationOptionSchema" }, "maxItems": 20, "minItems": 1 } }, "additionalProperties": false, "required": [ "projectID", "name", "enabled", "prompt", "type", "options" ] }, "CreateTranscriptEvaluationRequest": { "oneOf": [ { "$ref": "#/components/schemas/CreateBooleanTranscriptEvaluation" }, { "$ref": "#/components/schemas/CreateNumberTranscriptEvaluation" }, { "$ref": "#/components/schemas/CreateStringTranscriptEvaluation" }, { "$ref": "#/components/schemas/CreateOptionTranscriptEvaluation" } ] }, "TranscriptPropertyResponse": { "type": "object", "properties": { "id": { "type": "string" }, "projectID": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "default": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date" }, "updatedAt": { "type": "string", "format": "date" } }, "additionalProperties": false, "required": [ "id", "projectID", "name", "type", "default", "createdAt", "updatedAt" ] }, "TranscriptPropertyType": { "description": "The type of value held by this property.", "type": "string", "enum": [ "boolean", "number", "string" ], "x-enumNames": [ "BOOLEAN", "NUMBER", "STRING" ] }, "TranscriptPropertyValueResponse": { "type": "object", "properties": { "propertyID": { "type": "string" }, "transcriptID": { "type": "string" }, "value": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true }, "createdAt": { "type": "string", "format": "date" }, "updatedAt": { "type": "string", "format": "date" } }, "required": [ "propertyID", "transcriptID", "value", "metadata", "createdAt", "updatedAt" ] }, "TranscriptLogResponse": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "trace", "action", "end" ], "x-enumNames": [ "TRACE", "ACTION", "END" ] }, "data": { "$ref": "#/components/schemas/__schema0" }, "createdAt": { "type": "string", "format": "date" }, "updatedAt": { "type": "string", "format": "date" } }, "required": [ "type", "data", "createdAt", "updatedAt" ] }, "TranscriptPropertyWithValue": { "type": "object", "properties": { "value": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": {}, "nullable": true }, "createdAt": { "type": "string", "format": "date" }, "updatedAt": { "type": "string", "format": "date" }, "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "default": { "type": "boolean" } }, "required": [ "value", "metadata", "createdAt", "updatedAt", "id", "name", "type", "default" ] }, "TranscriptEvaluationWithResult": { "oneOf": [ { "$ref": "#/components/schemas/BooleanTranscriptEvaluationWithResult" }, { "$ref": "#/components/schemas/NumberTranscriptEvaluationWithResult" }, { "$ref": "#/components/schemas/StringTranscriptEvaluationWithResult" }, { "$ref": "#/components/schemas/OptionTranscriptEvaluationWithResult" } ] }, "BooleanTranscriptEvaluationWithResult": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] }, "reason": { "type": "string" }, "cost": { "type": "number" }, "createdAt": { "type": "string", "format": "date" }, "updatedAt": { "type": "string", "format": "date" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "default": { "type": "boolean" }, "type": { "type": "string", "enum": [ "boolean" ], "x-enumNames": [ "BOOLEAN" ] } }, "additionalProperties": false, "required": [ "value", "reason", "cost", "createdAt", "updatedAt", "id", "name", "description", "default", "type" ] }, "NumberTranscriptEvaluationWithResult": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] }, "reason": { "type": "string" }, "cost": { "type": "number" }, "createdAt": { "type": "string", "format": "date" }, "updatedAt": { "type": "string", "format": "date" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "default": { "type": "boolean" }, "type": { "type": "string", "enum": [ "number" ], "x-enumNames": [ "NUMBER" ] }, "maximumValue": { "type": "number" }, "minimumValue": { "type": "number" } }, "additionalProperties": false, "required": [ "value", "reason", "cost", "createdAt", "updatedAt", "id", "name", "description", "default", "type", "maximumValue", "minimumValue" ] }, "StringTranscriptEvaluationWithResult": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] }, "reason": { "type": "string" }, "cost": { "type": "number" }, "createdAt": { "type": "string", "format": "date" }, "updatedAt": { "type": "string", "format": "date" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "default": { "type": "boolean" }, "type": { "type": "string", "enum": [ "string" ], "x-enumNames": [ "STRING" ] } }, "additionalProperties": false, "required": [ "value", "reason", "cost", "createdAt", "updatedAt", "id", "name", "description", "default", "type" ] }, "OptionTranscriptEvaluationWithResult": { "type": "object", "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] }, "reason": { "type": "string" }, "cost": { "type": "number" }, "createdAt": { "type": "string", "format": "date" }, "updatedAt": { "type": "string", "format": "date" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "default": { "type": "boolean" }, "type": { "type": "string", "enum": [ "option" ], "x-enumNames": [ "OPTION" ] }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptEvaluationOptionSchema" } } }, "additionalProperties": false, "required": [ "value", "reason", "cost", "createdAt", "updatedAt", "id", "name", "description", "default", "type", "options" ] }, "SearchProjectTranscriptsResponseItem": { "type": "object", "properties": { "id": { "type": "string" }, "userID": { "type": "string" }, "sessionID": { "type": "string" }, "projectID": { "type": "string" }, "environmentID": { "type": "string" }, "projectEnvironmentID": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date" }, "updatedAt": { "type": "string", "format": "date" }, "expiresAt": { "type": "string", "format": "date", "nullable": true }, "endedAt": { "type": "string", "format": "date", "nullable": true }, "recordingURL": { "type": "string", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptPropertyWithValue" } }, "evaluations": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptEvaluationWithResult" } }, "matchCount": { "description": "Number of logs matching the `search` term. Absent when no `search` was given.", "type": "integer", "maximum": 9007199254740991, "minimum": 0 }, "matchSnippet": { "description": "Excerpt of the earliest matching log, centred on the hit. Absent when no `search` was given, null when the log text could not be recovered.", "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "id", "userID", "sessionID", "projectID", "environmentID", "createdAt", "updatedAt", "expiresAt", "endedAt", "recordingURL", "properties", "evaluations" ] }, "SearchTranscriptsRequest": { "type": "object", "properties": { "filters": { "description": "Filter transcripts based on properties and evaluation results.", "allOf": [ { "$ref": "#/components/schemas/TranscriptFilterArray" } ], "maxItems": 50 }, "endDate": { "description": "Select transcripts that were started before a specific date.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "sessionID": { "description": "Select transcripts by sessionID.", "type": "string" }, "search": { "description": "Select transcripts containing these keywords in a user or agent message.", "type": "string", "maxLength": 256, "minLength": 1 }, "startDate": { "description": "Select transcripts that were started after a specific date.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedAfter": { "description": "Select transcripts that were last updated at or after a specific date.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "updatedBefore": { "description": "Select transcripts that were last updated at or before a specific date.", "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "environmentID": { "description": "@deprecated use versionID and projectEnvironmentIDOrAlias instead", "anyOf": [ { "type": "string" }, { "minItems": 1, "maxItems": 2, "type": "array", "items": { "$ref": "#/components/schemas/VersionTag" } } ], "deprecated": true }, "versionID": { "type": "string" }, "projectEnvironmentIDOrAlias": { "type": "string" } }, "additionalProperties": false }, "TranscriptWithLogsResponse": { "type": "object", "properties": { "id": { "type": "string" }, "userID": { "type": "string" }, "sessionID": { "type": "string" }, "projectID": { "type": "string" }, "environmentID": { "type": "string" }, "projectEnvironmentID": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date" }, "updatedAt": { "type": "string", "format": "date" }, "expiresAt": { "type": "string", "format": "date", "nullable": true }, "endedAt": { "type": "string", "format": "date", "nullable": true }, "recordingURL": { "type": "string", "nullable": true }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptPropertyWithValue" } }, "evaluations": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptEvaluationWithResult" } }, "history": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date" } }, "required": [ "id", "createdAt" ] } }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/TranscriptLogResponse" } } }, "additionalProperties": false, "required": [ "id", "userID", "sessionID", "projectID", "environmentID", "createdAt", "updatedAt", "expiresAt", "endedAt", "recordingURL", "properties", "evaluations", "history", "logs" ] } }, "securitySchemes": { "auth": { "type": "apiKey", "in": "header", "name": "authorization", "description": "Voiceflow API key" } } }, "tags": [] }