Files
sdk/docs/AgentCodingStartIn.md

19 KiB

AgentCodingStartIn

Properties

Name Type Description Notes
After Pointer to string After names a previous run's session, and starts this one from where that one stopped instead of from the repository's default. It is how a follow-up instruction — "now add tests for it" — builds on work already done rather than beginning again on a fresh clone: the follow-up resumes the earlier run's sandbox and works in its tree, files, installs and all, while that sandbox is kept; one reaped by then is cloned again from the earlier branch. The follow-up writes the SAME branch the earlier run did, on top of its commits, so one piece of work is one branch and one pull request however many instructions it takes. It pushes without force, so it only ever adds to that branch. When the earlier run was on another repository, or kept its work local, there is no branch to carry on and the follow-up writes a new one. Branch names the branch instead. A caller who already knows the branch may pass Base directly. Base wins if both are given. [optional]
AgentRef Pointer to string AgentRef names a configured agent to run as, which is how an org pins a harness, a model and a prompt to a name. Empty runs the default agent. [optional]
Base Pointer to string Base is the branch to start from. Empty takes the repository's default. The run never writes here — it writes the agent branch it answers with. [optional]
Branch Pointer to string Branch names the branch the run writes, as `agent/<name>`: pass the name alone, or with the prefix. Runs write only under `agent/`, never to Base or to the default branch, so the name is letters, digits, `.`, `_` and `-`. Empty takes `agent/` and the first part of the run's session id, or the earlier run's branch when After names one. A branch that already exists on the repository is carried on, not replaced: the run starts from it and adds commits, and its pull request is the one it already has. [optional]
Desktop Pointer to bool Desktop asks for a run with a SCREEN — an image carrying an X server — for a task that has to drive a browser or another windowed program. False, the default, is a headless checkout, which is what writing code needs. [optional]
Effort Pointer to string Effort is how hard that model reasons: low, medium or high. Empty takes the model's own default. Taken by the dev and codex harnesses, like Model. [optional]
Issue Pointer to string Issue is the issue this run resolves: its number on Repo (`464` or `#464`), or `owner/name#464` for an issue in another repository. Its pull request says `Closes <issue>`, so merging the work closes the issue. Empty, or 0, is a run no issue asked for. [optional]
Mode Pointer to string Mode is what the run may do to the repository: `build` edits, commits and pushes its branch; `plan` reads the repository and answers with a plan, writing nothing — its sandbox is handed a credential that can only read and no push step runs, and the plan arrives as the run's final status. `setup` is a plan put to one question: its agent explores the checkout, installs and checks what it finds, and ends with the codebase's environment, which is kept as the proposal at /v1/environment/{repo} until someone saves it. Empty is `build`. A plan or a setup runs in our sandbox only: a claimed machine clones and pushes with its own credential, so one routed to a machine is refused. [optional]
Model Pointer to string Model is the model the run's agent thinks with, by the id GET /v1/models lists. Empty takes the platform's coding model. The dev and codex harnesses take it; the others do not think with a model we name, so naming one for them is refused. [optional]
Project Pointer to string Project scopes the run to one board's work when the org keeps more than one. Empty is the org's default. [optional]
Prompt Pointer to string Prompt is the task, in the words you would use with a colleague who has the checkout open. It is the whole instruction: there is no second field for context, and a prompt that names files and the outcome it wants gets a run that does not have to guess either. [optional]
Pull Pointer to bool Pull is whether the run opens a pull request for what it pushed. Unset, it pushes the branch and opens none: a pull request is the step after the work, taken when it is ready, and a run resumed with `after` adds to the same branch. True opens one when the run changed something. [optional]
Reply Pointer to AgentReply Reply is WHERE THE RUN NARRATES ITSELF, when the surface that started it has somewhere for it to talk. Empty means nobody is listening and the run simply does not narrate — which is the app surface's case, because /v1/agent/coding hands back a session id and the session stream is a better progress feed than any message could be. IT IS NOT A FIELD A MODEL FILLS IN. A run asked for in a conversation is dispatched with the address that conversation is happening at, written over whatever arrived here (apps/agents/replyto.go). A model naming a channel is a model naming a channel it was not spoken to in, so the value it chose is discarded rather than argued with — which is the same rule that left the org and the subject off this type entirely. [optional]
Repo Pointer to string Repo is what to work on: a repository's name, `owner/name` in the caller's own org, or the site a repository serves (`hanzo.ai`), as the person said it. The engine resolves it against the org's own repositories — a name that matches none is refused with the nearest ones — and finds the clone URL and the push credential from the org itself, so this says WHICH repository and never how to reach it. A repository on GitHub is named by GitHub's address, `github.com/owner/name` — or `owner/name` when the owner is not the org's own — and runs there directly: it is admitted when the caller's own connected GitHub may push to it, or when the caller administers the org and the org's installation holds it, and refused otherwise. A repository the caller can read and not push to — a public repository, or one their GitHub reads — is cloned read-only: the run works, commits in its workspace, and pushes nothing; its change is kept as the run's artifacts. Empty runs in an empty workspace: a fresh git repository in the sandbox, with nothing cloned and nothing pushed. [optional]
TargetId Pointer to string TargetID routes the run to a registered machine the org has claimed instead of to a sandbox in our cluster. Empty runs it here, which is the usual case. [optional]
Task Pointer to string Task is Prompt under the name a caller asking for work tends to reach for. The two are one field: Prompt wins when both are given. [optional]
TimeoutSeconds Pointer to int64 TimeoutSeconds bounds the whole run. Unset takes the default budget; a run that hits the bound is stopped and reports what it had done by then. [optional]
Tool Pointer to string Tool is which harness runs the prompt — dev claude

Methods

NewAgentCodingStartIn

func NewAgentCodingStartIn() *AgentCodingStartIn

NewAgentCodingStartIn instantiates a new AgentCodingStartIn object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewAgentCodingStartInWithDefaults

func NewAgentCodingStartInWithDefaults() *AgentCodingStartIn

NewAgentCodingStartInWithDefaults instantiates a new AgentCodingStartIn object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetAfter

func (o *AgentCodingStartIn) GetAfter() string

GetAfter returns the After field if non-nil, zero value otherwise.

GetAfterOk

func (o *AgentCodingStartIn) GetAfterOk() (*string, bool)

GetAfterOk returns a tuple with the After field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAfter

func (o *AgentCodingStartIn) SetAfter(v string)

SetAfter sets After field to given value.

HasAfter

func (o *AgentCodingStartIn) HasAfter() bool

HasAfter returns a boolean if a field has been set.

GetAgentRef

func (o *AgentCodingStartIn) GetAgentRef() string

GetAgentRef returns the AgentRef field if non-nil, zero value otherwise.

GetAgentRefOk

func (o *AgentCodingStartIn) GetAgentRefOk() (*string, bool)

GetAgentRefOk returns a tuple with the AgentRef field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAgentRef

func (o *AgentCodingStartIn) SetAgentRef(v string)

SetAgentRef sets AgentRef field to given value.

HasAgentRef

func (o *AgentCodingStartIn) HasAgentRef() bool

HasAgentRef returns a boolean if a field has been set.

GetBase

func (o *AgentCodingStartIn) GetBase() string

GetBase returns the Base field if non-nil, zero value otherwise.

GetBaseOk

func (o *AgentCodingStartIn) GetBaseOk() (*string, bool)

GetBaseOk returns a tuple with the Base field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetBase

func (o *AgentCodingStartIn) SetBase(v string)

SetBase sets Base field to given value.

HasBase

func (o *AgentCodingStartIn) HasBase() bool

HasBase returns a boolean if a field has been set.

GetBranch

func (o *AgentCodingStartIn) GetBranch() string

GetBranch returns the Branch field if non-nil, zero value otherwise.

GetBranchOk

func (o *AgentCodingStartIn) GetBranchOk() (*string, bool)

GetBranchOk returns a tuple with the Branch field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetBranch

func (o *AgentCodingStartIn) SetBranch(v string)

SetBranch sets Branch field to given value.

HasBranch

func (o *AgentCodingStartIn) HasBranch() bool

HasBranch returns a boolean if a field has been set.

GetDesktop

func (o *AgentCodingStartIn) GetDesktop() bool

GetDesktop returns the Desktop field if non-nil, zero value otherwise.

GetDesktopOk

func (o *AgentCodingStartIn) GetDesktopOk() (*bool, bool)

GetDesktopOk returns a tuple with the Desktop field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDesktop

func (o *AgentCodingStartIn) SetDesktop(v bool)

SetDesktop sets Desktop field to given value.

HasDesktop

func (o *AgentCodingStartIn) HasDesktop() bool

HasDesktop returns a boolean if a field has been set.

GetEffort

func (o *AgentCodingStartIn) GetEffort() string

GetEffort returns the Effort field if non-nil, zero value otherwise.

GetEffortOk

func (o *AgentCodingStartIn) GetEffortOk() (*string, bool)

GetEffortOk returns a tuple with the Effort field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEffort

func (o *AgentCodingStartIn) SetEffort(v string)

SetEffort sets Effort field to given value.

HasEffort

func (o *AgentCodingStartIn) HasEffort() bool

HasEffort returns a boolean if a field has been set.

GetIssue

func (o *AgentCodingStartIn) GetIssue() string

GetIssue returns the Issue field if non-nil, zero value otherwise.

GetIssueOk

func (o *AgentCodingStartIn) GetIssueOk() (*string, bool)

GetIssueOk returns a tuple with the Issue field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIssue

func (o *AgentCodingStartIn) SetIssue(v string)

SetIssue sets Issue field to given value.

HasIssue

func (o *AgentCodingStartIn) HasIssue() bool

HasIssue returns a boolean if a field has been set.

GetMode

func (o *AgentCodingStartIn) GetMode() string

GetMode returns the Mode field if non-nil, zero value otherwise.

GetModeOk

func (o *AgentCodingStartIn) GetModeOk() (*string, bool)

GetModeOk returns a tuple with the Mode field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMode

func (o *AgentCodingStartIn) SetMode(v string)

SetMode sets Mode field to given value.

HasMode

func (o *AgentCodingStartIn) HasMode() bool

HasMode returns a boolean if a field has been set.

GetModel

func (o *AgentCodingStartIn) GetModel() string

GetModel returns the Model field if non-nil, zero value otherwise.

GetModelOk

func (o *AgentCodingStartIn) GetModelOk() (*string, bool)

GetModelOk returns a tuple with the Model field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetModel

func (o *AgentCodingStartIn) SetModel(v string)

SetModel sets Model field to given value.

HasModel

func (o *AgentCodingStartIn) HasModel() bool

HasModel returns a boolean if a field has been set.

GetProject

func (o *AgentCodingStartIn) GetProject() string

GetProject returns the Project field if non-nil, zero value otherwise.

GetProjectOk

func (o *AgentCodingStartIn) GetProjectOk() (*string, bool)

GetProjectOk returns a tuple with the Project field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProject

func (o *AgentCodingStartIn) SetProject(v string)

SetProject sets Project field to given value.

HasProject

func (o *AgentCodingStartIn) HasProject() bool

HasProject returns a boolean if a field has been set.

GetPrompt

func (o *AgentCodingStartIn) GetPrompt() string

GetPrompt returns the Prompt field if non-nil, zero value otherwise.

GetPromptOk

func (o *AgentCodingStartIn) GetPromptOk() (*string, bool)

GetPromptOk returns a tuple with the Prompt field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPrompt

func (o *AgentCodingStartIn) SetPrompt(v string)

SetPrompt sets Prompt field to given value.

HasPrompt

func (o *AgentCodingStartIn) HasPrompt() bool

HasPrompt returns a boolean if a field has been set.

GetPull

func (o *AgentCodingStartIn) GetPull() bool

GetPull returns the Pull field if non-nil, zero value otherwise.

GetPullOk

func (o *AgentCodingStartIn) GetPullOk() (*bool, bool)

GetPullOk returns a tuple with the Pull field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPull

func (o *AgentCodingStartIn) SetPull(v bool)

SetPull sets Pull field to given value.

HasPull

func (o *AgentCodingStartIn) HasPull() bool

HasPull returns a boolean if a field has been set.

GetReply

func (o *AgentCodingStartIn) GetReply() AgentReply

GetReply returns the Reply field if non-nil, zero value otherwise.

GetReplyOk

func (o *AgentCodingStartIn) GetReplyOk() (*AgentReply, bool)

GetReplyOk returns a tuple with the Reply field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetReply

func (o *AgentCodingStartIn) SetReply(v AgentReply)

SetReply sets Reply field to given value.

HasReply

func (o *AgentCodingStartIn) HasReply() bool

HasReply returns a boolean if a field has been set.

GetRepo

func (o *AgentCodingStartIn) GetRepo() string

GetRepo returns the Repo field if non-nil, zero value otherwise.

GetRepoOk

func (o *AgentCodingStartIn) GetRepoOk() (*string, bool)

GetRepoOk returns a tuple with the Repo field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRepo

func (o *AgentCodingStartIn) SetRepo(v string)

SetRepo sets Repo field to given value.

HasRepo

func (o *AgentCodingStartIn) HasRepo() bool

HasRepo returns a boolean if a field has been set.

GetTargetId

func (o *AgentCodingStartIn) GetTargetId() string

GetTargetId returns the TargetId field if non-nil, zero value otherwise.

GetTargetIdOk

func (o *AgentCodingStartIn) GetTargetIdOk() (*string, bool)

GetTargetIdOk returns a tuple with the TargetId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTargetId

func (o *AgentCodingStartIn) SetTargetId(v string)

SetTargetId sets TargetId field to given value.

HasTargetId

func (o *AgentCodingStartIn) HasTargetId() bool

HasTargetId returns a boolean if a field has been set.

GetTask

func (o *AgentCodingStartIn) GetTask() string

GetTask returns the Task field if non-nil, zero value otherwise.

GetTaskOk

func (o *AgentCodingStartIn) GetTaskOk() (*string, bool)

GetTaskOk returns a tuple with the Task field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTask

func (o *AgentCodingStartIn) SetTask(v string)

SetTask sets Task field to given value.

HasTask

func (o *AgentCodingStartIn) HasTask() bool

HasTask returns a boolean if a field has been set.

GetTimeoutSeconds

func (o *AgentCodingStartIn) GetTimeoutSeconds() int64

GetTimeoutSeconds returns the TimeoutSeconds field if non-nil, zero value otherwise.

GetTimeoutSecondsOk

func (o *AgentCodingStartIn) GetTimeoutSecondsOk() (*int64, bool)

GetTimeoutSecondsOk returns a tuple with the TimeoutSeconds field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTimeoutSeconds

func (o *AgentCodingStartIn) SetTimeoutSeconds(v int64)

SetTimeoutSeconds sets TimeoutSeconds field to given value.

HasTimeoutSeconds

func (o *AgentCodingStartIn) HasTimeoutSeconds() bool

HasTimeoutSeconds returns a boolean if a field has been set.

GetTool

func (o *AgentCodingStartIn) GetTool() string

GetTool returns the Tool field if non-nil, zero value otherwise.

GetToolOk

func (o *AgentCodingStartIn) GetToolOk() (*string, bool)

GetToolOk returns a tuple with the Tool field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTool

func (o *AgentCodingStartIn) SetTool(v string)

SetTool sets Tool field to given value.

HasTool

func (o *AgentCodingStartIn) HasTool() bool

HasTool returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]