Chats

Update chat goal

Sets the objective of a Codex chat, or pauses and resumes it. Other agents return goal: null; give them a goal by sending a message with goal_mode: true. The replica must be active.

patch/v1/replica/{id}/chats/{chat_id}/goal

Request

  • Base URL
    https://api.replicas.dev
  • URL
    https://api.replicas.dev/v1/replica/{id}/chats/{chat_id}/goal
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Replica ID

chat_idstring required

Chat ID

Headers

X-Replicas-Api-Version'2026-10-07'

API version. 2026-10-07 returns snake_case responses. See versioning.

Request body

objectivestring
status'active' | 'paused'

Response

Updated goal

Changes

No recorded changes to this operation across all 1 revision of this API.