Prompts
Create a prompt
Creates a new prompt under a monitor in the active project.
/api/v1/prompts
The new prompt joins its monitor on the next scheduled run, provided it was created with is_active set to true. Inactive prompts are skipped by every run until you reactivate them through Update a prompt.
Body parameters
| Name | Type | Required | Description |
|---|---|---|---|
| monitor_id | integer | Required | The numeric ID of the monitor that will own the new prompt. The monitor must belong to the active project. |
| prompt | string | Required | The question the monitor will ask each engine on every run. May be up to 2000 characters. |
| is_active | boolean | Required | When set to |
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. |