agents

Update Agent

Update agent metadata.

instructions (the persona) is routed to the MARITIME_INSTRUCTIONS env var and takes effect at the agent's next restart — the runtime entrypoint rewrites the persona block in AGENTS.md when the content changes. "" clears it; null leaves it unchanged.

put/api/agents/{agent_id}

Request

Base URL
https://api.maritime.sh (the document declares no server; this is the origin it was published from)
URL
https://api.maritime.sh/api/agents/{agent_id}
Auth
HTTP bearer

Path parameters

agent_idstring required

Request body

namestring nullable

descriptionstring nullable

instructionsstring nullable

frameworkstring nullable

tierstring nullable

githubRepostring nullable

autoPairboolean nullable

exposedPortinteger nullable

healthCheckPathstring nullable

hasWebUiboolean nullable

publicPlayboolean nullable

Response

Successful Response

idstring required

namestring required

descriptionstring nullable

instructionsstring nullable

externalIdstring nullable

frameworkstring required

tierstring required

statusstring required

githubRepostring nullable

autoPairboolean

exposedPortinteger nullable

healthCheckPathstring nullable

hasWebUiboolean

templateIdstring nullable

publicPlayboolean

publicWebboolean

publicUrlstring nullable

visibility'private' | 'public'

webUrlstring nullable

desktopEnabledboolean

invocationCountinteger required

totalComputeSecondsinteger

memMbinteger nullable

vcpusnumber nullable

idleTtlSecondsinteger nullable

diskMbinteger nullable

computeMinutesLimitnumber nullable

sleepPolicystring

lastStartedAtstring date-time nullable

lastActiveAtstring date-time nullable

statusChangedAtstring date-time nullable

derivedImageTagstring nullable

browserbaseConfiguredboolean

projectIdstring nullable

projectRolestring nullable

createdAtstring date-time required

updatedAtstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.