screenplay_writing_voice_analyze
Check readiness, quote, start, or finalize Writing Voice analysis. Start consumes credits; analysis does not save a Voice.
When to use
- Design a Voice from direction or infer it from supplied samples using the native quoted analysis lifecycle.
When not to use
- Use screenplay_writing_voice_query to inspect saved content or screenplay_writing_voice to save/select it.
Examples
- “Quote an infer analysis from these samples, then start the accepted request with the same billing IDs.”
Anti-examples
- Automatically save an analysis result as the project's selected Voice.
Backend capabilities
screenplay_writing_voice.analyze
Input schema
screenplay_writing_voice_analyze input
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": [
"operation",
"project_id"
],
"properties": {
"operation": {
"type": "string",
"enum": [
"analysis_readiness",
"analysis_quote",
"analysis_start",
"analysis_finalize"
]
},
"project_id": {
"type": "integer"
},
"description": {
"type": "string",
"maxLength": 12000
},
"analysis_mode": {
"type": "string",
"enum": [
"design",
"infer"
]
},
"samples": {
"type": "array",
"maxItems": 3,
"items": {
"type": "object",
"required": [
"sample_id",
"label",
"excerpt"
],
"properties": {
"sample_id": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"excerpt": {
"type": "string",
"minLength": 1,
"maxLength": 30000
}
},
"additionalProperties": false
}
},
"billing_quote_id": {
"type": "string",
"format": "uuid"
},
"billing_request_id": {
"type": "string",
"format": "uuid"
},
"job_id": {
"type": "string",
"minLength": 1
}
},
"allOf": [
{
"if": {
"properties": {
"operation": {
"const": "analysis_start"
}
}
},
"then": {
"required": [
"billing_quote_id",
"billing_request_id"
]
}
},
{
"if": {
"properties": {
"operation": {
"enum": [
"analysis_quote",
"analysis_start"
]
}
}
},
"then": {
"required": [
"analysis_mode"
],
"allOf": [
{
"if": {
"properties": {
"analysis_mode": {
"const": "design"
}
}
},
"then": {
"required": [
"description"
],
"properties": {
"description": {
"minLength": 1,
"pattern": "\\S"
}
}
}
},
{
"if": {
"properties": {
"analysis_mode": {
"const": "infer"
}
}
},
"then": {
"required": [
"samples"
],
"properties": {
"samples": {
"minItems": 1
}
}
}
}
]
}
},
{
"if": {
"properties": {
"operation": {
"const": "analysis_finalize"
}
}
},
"then": {
"required": [
"job_id"
]
}
}
],
"additionalProperties": false
}Output schema
screenplay_writing_voice_analyze output
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": [
"operation",
"project_id",
"writing_voice_updated_at"
],
"properties": {
"operation": {
"type": "string",
"enum": [
"analysis_readiness",
"analysis_quote",
"analysis_start",
"analysis_finalize"
]
},
"project_id": {
"type": "integer"
},
"mode": {
"type": [
"string",
"null"
]
},
"revision": {
"type": "integer",
"minimum": 0
},
"writing_voice_updated_at": {
"type": [
"string",
"null"
]
},
"exists": {
"type": "boolean"
},
"label": {
"type": [
"string",
"null"
]
},
"sample_count": {
"type": "integer",
"minimum": 0,
"maximum": 3
},
"selection": {
"type": "object",
"additionalProperties": true
},
"preset_summaries": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"preset": {
"type": "object",
"additionalProperties": true
},
"async": {
"type": "boolean"
},
"job_id": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"readiness": {
"type": "object",
"additionalProperties": true
},
"proposal_summaries": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"estimated_credits": {
"type": "integer",
"minimum": 0
},
"credits_charged": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"billing_pending": {
"type": "boolean"
},
"billing_status": {
"type": "string"
},
"billing_operation_id": {
"type": "string",
"format": "uuid"
},
"quote": {
"type": "object",
"additionalProperties": true
},
"reserved_credits": {
"type": "integer",
"minimum": 0
},
"credits_skipped_reason": {
"type": "string"
},
"resource_links": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"next_actions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
},
"additionalProperties": true
}← All toolsv1 · workflow_runner