Skip to content

Agent panels and chat

Send a chat message

Ask the agent a question, or ask it to change something. The response has the ID of the job that answers.

POST/v1/monitors/{monitor_id}/agent/chat

Send your API key as Authorization: Bearer. See Authentication. How each option works: Monitors.

Path parameter

monitor_idstring
The ID of a monitor that has an agent.

Request body

messagestringat most 4000 characters
Your question, or the change to make.
panel_idstring
Ask about this panel. See List panels.

Response

202The agent answers in a job. Read the answer with List chat messages.

job_idstring
The ID of the job that answers. See Get a job.
message_idstring
The ID of your message.

Errors

StatusCodeWhen
400invalid_requestThe message is blank.
401unauthorizedThe API key is missing or not valid.
403forbiddenThe API key cannot read monitors (a GET) or change them (the other methods).
404not_foundThe monitor, its agent or the panel is not in your key's project.
409monitor_endedThe monitor has ended. What the agent found stays readable, but nothing can change.
409budget_exhaustedToday's budget for this monitor is spent. It resets at midnight UTC.
409job_in_progressThe agent is still working on the last request. Try again when it finishes.
422invalid_requestA parameter or the body is not valid. error.param names it.
429rate_limitedYour key or account sent too many requests. Wait for the seconds in Retry-After, then try again.

What each error means and what to do: Errors.

Was this page helpful?