Skip to main content
GET
Retrieve Prompt

Authorizations

PersoPlatform-APIKey
string
header
required

Path Parameters

prompt_id
string
required

Response

name
string
required
Maximum string length: 100
prompt_id
string
required
read-only
system_prompt
string
required

Instructions sent to the LLM at the start of every conversation using this prompt.

description
string
require_document
boolean

When require_document is True, the System prompt must include '{context}' string to be replaced with the document search result in the prompt.require_document 가 True 인 경우, 시스템 프롬프트는 '{context}' 문자열을 포함해야 하며, 해당 문자열은 프롬프트에서 문서 검색 결과로 대체됩니다.

intro_message
string

First message the AI speaks when a session opens (optional).