Generate a prompt
Generates a specific prompt with the provided payload.
POST
/prompt/
{uuid}Authorization
api-key<token>
This is a required API key. It must be included in the header of all requests in the format: api-key: value.
In: header
Request Body
application/jsonRequiredmessagestring
The message to be processed
structured_dataobject
A valid JSON Schema 7 object
Path Parameters
uuidRequiredstring
UUID of the prompt to execute
Format:
"uuid"curl -X POST "https://api.systemprompt.io/v1/prompt/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
-H "api-key: <apikey>" \
-H "Content-Type: application/json" \
-d '{
"message": "Please analyze this text and provide feedback."
}'Prompt executed successfully
{
"success": true,
"data": {
"static": "{{war_and_peace_content}}",
"dynamic": "{{message}}",
"state": "{{conversation.history}}",
"output_schema": {},
"parsed_tokens": [
"message"
],
"token_counts": {
"static": 10,
"dynamic": 10,
"state": 10
},
"prompt": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"instruction": {
"static": "You are a world class journalist. Analyse the research and create an amazing blog, use the content for information {{referenced_content}}",
"state": "{{conversation.history}}",
"dynamic": "{{message}}"
},
"input": {
"name": "ResearchAnalysis",
"description": "This is a schema that accepts structured data or messages",
"type": "structured_data",
"reference": [
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"link": "/v1/input/123e4567-e89b-12d3-a456-426614174000",
"type": "input"
}
],
"schema": {
"type": "object",
"properties": {
"$schema": {
"type": "string",
"description": "The JSON Schema version",
"default": "http://json-schema.org/draft-07/schema#"
},
"type": {
"type": "string",
"enum": [
"object"
]
},
"properties": {
"name": {
"type": "string"
}
}
},
"required": [
"name"
],
"additionalProperties": {
"type": "boolean"
}
}
},
"output": {
"name": "AIGeneratedOutput",
"description": "This is a schema that accepts structured data or messages",
"type": "structured_data",
"reference": [
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"link": "/v1/output/123e4567-e89b-12d3-a456-426614174000",
"type": "output"
}
],
"schema": {
"type": "object",
"properties": {
"$schema": {
"type": "string",
"description": "The JSON Schema version",
"default": "http://json-schema.org/draft-07/schema#"
},
"type": {
"type": "string",
"enum": [
"object"
]
},
"properties": {
"name": {
"type": "string"
}
}
},
"required": [
"name"
],
"additionalProperties": {
"type": "boolean"
}
}
},
"metadata": {
"title": "Research Analysis",
"description": "A schema for analysing research data for blogs",
"created": "2023-04-01T12:00:00Z",
"updated": "2023-04-01T12:00:00Z",
"version": 1,
"status": "published",
"tag": [
"SystemPrompt",
"Blog",
"Conversation",
"Text Output"
],
"log_message": "Created a new research analysis",
"author": "admin"
},
"_link": "string"
}
},
"warnings": [
"string"
]
}