Get task status
const url = 'https://api.gopromptless.ai/v1/triggers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.gopromptless.ai/v1/triggers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>'Read the current status and conversation of a task submitted through POST /v1/triggers. The messages array holds the persisted conversation (latest 100, oldest-first) for tasks submitted over the API or MCP and for tasks created through MCP request_changes, and comes back empty for other sources. Reading the conversation does not consume it.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Identifier of the task, as returned by POST /v1/triggers.
Responses
Section titled “Responses”The task’s current status and conversation.
The current status of a task and its persisted conversation.
object
The task’s id.
The task’s current status. The status string can change over time, so branch on finished to detect completion.
True when the task has completed or been skipped.
ISO 8601 time the task was submitted.
The task’s origin.
A one-line summary of the submitted request.
A note that explains how the task ended. Read it after finished is true.
How the task ended. Null until the task finishes, and for tasks from sources other than the API or MCP. Promptless may add values later.
The suggestions this task produced. Each entry is a per-task summary, a lighter shape than the Suggestion lifecycle feed.
A per-task summary of a suggestion the task produced. This is a lighter shape than the Suggestion lifecycle feed.
object
Stable identifier for the suggestion.
Short summary of the documentation change.
Longer explanation of the change.
The docs pull request’s state (open, draft, merged, or closed), or null before a docs PR exists.
Identifier of the collection the suggestion targets.
Link to the documentation pull request, or null before a docs PR exists.
The git branch in the documentation repository.
ISO 8601 time the suggestion was created.
Human- or LLM-readable advice for polling the task and interpreting its outcome. Callers detect completion with finished.
The persisted conversation, latest 100, oldest-first. Empty for task sources that do not support messages.
A single message in a task’s conversation.
object
Stable, immutable identifier for the message. Deduplicate on it.
Identifier of the task this message belongs to.
The message’s order within the task.
Who wrote the message.
object
The customer’s email when available, otherwise null.
ISO 8601 time the message was created.
The message text.
Example
{ "trigger_event_id": "550e8400-e29b-41d4-a716-446655440000", "outcome": "suggestions_created", "suggestions": [ { "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "status": "open" } ], "messages": [ { "id": "b1e2c3d4-5678-90ab-cdef-1234567890ab", "trigger_event_id": "550e8400-e29b-41d4-a716-446655440000", "sequence": 1, "author": { "type": "promptless" } } ]}The API key is missing, invalid, or revoked.
Error body returned when an API trigger request is rejected.
object
Stable machine-readable error code.
Human-readable explanation of the error.
Example
{ "error": "authentication_failed", "message": "Authentication failed."}No task with this id exists for the organization (task_not_found).
Error body returned when an API trigger request is rejected.
object
Stable machine-readable error code.
Human-readable explanation of the error.
Example
{ "error": "authentication_failed", "message": "Authentication failed."}The trigger_event_id path parameter is not a valid UUID.
Validation error body returned when the request fails schema validation.
object
object
Examplegenerated
{ "detail": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ]}The read store is temporarily unavailable (runtime_store_unavailable).
Error body returned when an API trigger request is rejected.
object
Stable machine-readable error code.
Human-readable explanation of the error.
Example
{ "error": "authentication_failed", "message": "Authentication failed."}