cues

Replace a cue's definition

Changed on
patch/api/v1/cues/{cueId}

Request

  • Base URL
    http://127.0.0.1:3001
  • URL
    http://127.0.0.1:3001/api/v1/cues/{cueId}
  • Auth
    none declared

Path parameters

cueIdstring required

Cue identifier.

Request body

commandstring

Shell command for a command cue. At most 4096 bytes; cleared when saving agent cues.

namestring required

Short cue name, unique within the project. Trimmed; must be non-empty and at most 64 bytes.

promptstring

Agent instruction for an agent cue. At most 16384 bytes; cleared when saving command cues.

typestring required

Cue kind: command sends to a project- or session-scoped shell terminal; agent sends an authored prompt. Definition body limit: 128 KiB.

Response

OK

Changes

  • 8f160e6183cdRevision changes
    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

    • info

      removed the agent_switch_saga enum value from the response property for the response status

  • 6815f1792150Revision changes
    • breaking

      removed the required property / from the response with the status

    • warning

      removed the request property