Prompts

Get a prompt

Returns a single prompt. The prompt must belong to a monitor inside the active project.

GET /api/v1/prompts/{prompt}

Path parameters

Name Type Required Description
prompt integer Required

The numeric ID of the prompt.

Query parameters

Name Type Required Description
include string Optional

A comma-separated list of related resources to include in the response. Allowed values: monitor, monitor.project, monitor.project.organization.

Response

The prompt object

Field Type Description
id integer

The unique ID of the prompt.

monitor_id integer

The ID of the monitor that owns this prompt.

prompt string

The question text the monitor asks each engine on every run.

is_active boolean

Whether the prompt will run on each daily run of its monitor.

created_at datetime

When the prompt was created.

updated_at datetime

When the prompt was last updated.