Get Prompt

Retrieve a prompt and optionally personalize it with dynamic variables. Perfect for fetching the prompt you want to use right before sending it to your AI.

Dynamic Variables: Use handlebars-style placeholders like {{userName}} in your prompt, then pass query parameters to fill them in.

Example: Calling /prompts/abc-123?userName=Alice&productName=Premium will replace {{userName}} with “Alice” and {{productName}} with “Premium” in the returned prompt.

GET /prompts/{id}

cURL

cURL

curl --request GET \
  --url https://www.greenflash.ai/api/v1/prompts/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "composedPrompt": "You are a helpful assistant for Premium. Greet Alice warmly.",
  "prompt": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalPromptId": "support-v1",
    "name": "Customer Support Prompt",
    "description": "Standard customer support  prompt",
    "source": "customer",
    "productId": "123e4567-e89b-12d3-a456-426614174001",
    "archivedAt": null,
    "createdAt": "2025-10-01T12:00:00Z",
    "updatedAt": "2025-10-01T12:00:00Z",
    "components": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174002",
        "type": "system",
        "source": "customer",
        "name": "Base Instructions",
        "content": "You are a helpful assistant for {{productName}}. Greet {{userName}} warmly.",
        "isDynamic": false,
        "createdAt": "2025-10-01T12:00:00Z",
        "updatedAt": "2025-10-01T12:00:00Z"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

The prompt identifier. Can be: internal prompt ID (UUID), or externalPromptId (your custom ID).

Response

200

application/json

Prompt retrieved successfully

composedPrompt · string · required

The prompt with variables interpolated from query parameters.

prompt · object · required

The full prompt object with components.

Show child attributes