Search + K

Command Palette

Search for a command to run...

Sign In

createAgentRunner

POST /agent_runners
Copy endpoint
https://api.netlify.com/api/v1

Parameters

query Query Parameters

Name Type
site_id required
string
deploy_id
string
branch
string
prompt
string
agent
string
model
string
parent_agent_runner_id
string
dev_server_image
string
file_keys
string[]

Responses

200 application/json

OK

interface AgentRunner {
id?: string;
site_id?: string;
parent_agent_runner_id?: string;
state?: string;
created_at?: string;
updated_at?: string;
done_at?: string;
title?: string;
branch?: string;
result_branch?: string;
pr_url?: string;
pr_branch?: string;
pr_state?: string;
pr_number?: number;
pr_is_being_created?: boolean;
pr_error?: string;
current_task?: string;
result_diff?: string;
sha?: string;
merge_commit_sha?: string;
merge_commit_error?: string;
merge_commit_is_being_created?: boolean;
base_deploy_id?: string;
attached_file_keys?: string[];
active_session_created_at?: string;
latest_session_deploy_id?: string;
latest_session_deploy_url?: string;
user?: AgentRunnerUser
interface AgentRunnerUser {
id?: string;
full_name?: string;
email?: string;
avatar_url?: string;
}
;
}
default application/json

error

interface Error {
code?: number;
message: string;
}

Client Errors

404

Not Found

unknown
422

Unprocessable Entity

unknown