Skip to content

Create Streaming Prompt

POST
/api/chat/personas/prompt

Create streaming-optimized system prompt

Generates a comprehensive system prompt optimized for streaming responses with the specified persona, stance, and optional additional context.

Args: persona: Persona type ID stance: Stance type ID context: Optional additional context to include

Returns: Dict containing: - system_prompt: The generated streaming-optimized prompt - persona: Persona ID used - stance: Stance ID used - has_context: Whether additional context was included

Example Request: POST /chat/personas/prompt { “persona”: “technical_writer”, “stance”: “concise”, “context”: “Documentation for API endpoints” }

Example Response: { “system_prompt”: “You are a technical writer who excels at creating clear…”, “persona”: “technical_writer”, “stance”: “concise”, “has_context”: true }

StreamingPromptRequest

Request model for streaming prompt creation.

Creates a streaming-optimized system prompt for specified persona and stance combination with optional additional context for customization.

Fields: persona: Persona type ID (e.g., “technical_writer”, “lore_scholar”) stance: Stance type ID (e.g., “concise”, “detailed”, “brainstorming”) context: Optional additional context to include in the prompt

JSON Example: { “persona”: “technical_writer”, “stance”: “concise”, “context”: “API documentation for backend services” }

Used By: - POST /api/chat/personas/prompt - Streaming chat initialization - Custom prompt generation

object
persona
required
Persona

Persona type ID

string
stance
required
Stance

Stance type ID

string
context
Context

Optional additional context

string
""

Successful Response

StreamingPromptResponse

Response model for streaming prompt creation.

Returns streaming-optimized system prompt for specified persona and stance combination with optional additional context for real-time streaming responses.

Fields:

  • system_prompt: Generated streaming-optimized prompt text
  • persona: Persona ID used for prompt generation
  • stance: Stance ID used for prompt generation
  • has_context: Whether additional context was included in prompt

Prompt Generation: The system prompt combines:

  • Base persona description and traits
  • Stance approach and tone
  • Optional additional context (if provided)
  • Streaming optimization for real-time response generation

Usage: POST /api/chat/personas/prompt returns this response model for streaming prompt generation, real-time response setup, and context-aware AI interactions.

JSON Example:

{
  "systemPrompt": "You are a technical writer. Adopt a concise approach. Context: API docs.",
  "persona": "technical_writer",
  "stance": "concise",
  "hasContext": true
}

Note: The systemPrompt field contains a comprehensive prompt string combining persona description, stance approach, and optional context for streaming-optimized responses. The actual prompt is much longer than shown in this example.

object
systemPrompt
required
Systemprompt

Generated streaming-optimized prompt text

string
persona
required
Persona

Persona ID used for prompt generation

string
stance
required
Stance

Stance ID used for prompt generation

string
hasContext
required
Hascontext

Whether additional context was included in prompt

boolean

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object