agentRunnerSession

Start a follow-up agent run session

Changed on

Starts a follow-up session on the run.

post/agent_runners/{agent_runner_id}/sessions

Request

  • Base URL
    https://api.netlify.com/api/v1
  • URL
    https://api.netlify.com/api/v1/agent_runners/{agent_runner_id}/sessions
  • Auth
    OAuth 2
    Implicit: https://app.netlify.com/authorize

Query parameters

promptstring

Use the request body instead.

agentstring

Use the request body instead.

modelstring

Use the request body instead.

file_keysstring[]

Use the request body instead.

Request body

promptstring

What the agent should do. Required.

agentstring
modelstring

Model for the agent to use. Omit to let Netlify choose.

mode'normal' | 'ask'

normal (the default) changes code; ask answers questions without changing code.

Response

OK

idstring
agent_runner_idstring
dev_server_idstring
statestring

One of new, running, await_input, interrupted, error, done or cancelled.

created_atstring dateTime
updated_atstring dateTime
done_atstring dateTime
paused_atstring dateTime

When the session paused waiting on an interaction. Null once it resumes.

titlestring
promptstring
resultstring

The agent's summary of what it did.

result_diffstring
commit_shastring
deploy_idstring
deploy_urlstring

URL of the session's deploy preview.

durationinteger
interactionsobject

Questions and requests from the agent, keyed by reference ID. A pending one pauses the session in await_input until it's answered or skipped.

attached_file_keysstring[]
result_zip_file_namestring
is_publishedboolean

Changes

  • 4ee761b12c37Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status