Skip to main content

Prompts

Manage analysis prompts (templates for extracting insights).

List Prompts​

GET /v1/prompts

Returns all prompts available to the organization.

curl https://scribesight.com/api/v1/prompts \
-H "Authorization: Bearer sk_live_xxx"

Get Prompt​

GET /v1/prompts/{promptId}

Returns a specific prompt.


Create Prompt​

POST /v1/prompts

Creates a custom prompt.

Request Body​

FieldTypeRequiredDescription
namestringYesPrompt name
descriptionstringNoWhat this prompt extracts
templatestringYesPrompt template with placeholders
output_schemaobjectNoJSON schema for structured output
curl -X POST https://scribesight.com/api/v1/prompts \
-H "Authorization: Bearer sk_live_xxx" \
-H "Content-Type: application/json" \
-d '{
"name": "Support Ticket Triage",
"description": "Categorize support calls and extract key details",
"template": "Analyze the following support call transcript and extract:\\n1. Issue category\\n2. Urgency level\\n3. Key details\\n\\nTranscript:\\n{{transcript}}"
}'

Update Prompt​

PATCH /v1/prompts/{promptId}

Updates a prompt. Only custom prompts can be modified.


Delete Prompt​

DELETE /v1/prompts/{promptId}

Deletes a custom prompt. System prompts cannot be deleted.