ENentire
Project Agents

Replace an agent as a new version

Changed on

Every field, as for a create, with environment_id. Send preset null with a custom agent's fields to customize a preset agent under the same id.

put/api/v1/{forge}/{project}/agents/{id}

Request

  • Base URL
    https://entire.io (the document declares no server; this is the origin it was published from)
  • URL
    https://entire.io/api/v1/{forge}/{project}/agents/{id}
  • Auth
    none declared. Required headers: If-Match

Path parameters

forge'gh' | 'et' required
projectstring required
idstring required

Headers

If-Matchstring required

The JSON etag of the last read or write.

Request body

presetstring nullable

Run an Entire preset as it is now; omit or send null for a custom agent.

namestring

Required without a preset.

descriptionstring
is_enabledboolean
harness'claude' | 'codex'
modelstring nullable
reasoning_effort'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'ultra' nullable
timeout_msinteger
instructionsstring
repository_idsstring[] required
environment_idstring required

Response

The new version

idstring required
project_idstring required
versioninteger required
etagstring required

Write token: send it unchanged as If-Match to replace or archive.

created_atstring required
updated_atstring required
archived_atstring nullable required
namestring required
descriptionstring required
harnessstring required
modelstring nullable required
reasoning_effortstring nullable required
timeout_msinteger required
instructionsstring required
is_enabledboolean required

Whether its trigger runs it. A paused agent still runs when asked to.

environment_idstring required
repository_idsstring[] required
stale_repository_idsstring[] required

Changes

  • f4a534501f84Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • e8893f80c9f2Revision changes
    • info

      added the new optional request property //

    • info

      added the required property // to the response with the status