Guest Machines
API referenceChats

Edit a waiting message

PATCH/api/v1/chats/{chat_id}/pending-messages/{message_id}

Change the text of a queued or failed message before a turn takes it in.

A 409 means the chat took the message in meanwhile, or it is steering the turn working now. List the waiting messages to see where things stand.

The turn that takes the message in runs with the credential that last edited it: charged to that user API key, or as that integration for you. Like any run a key or an integration starts, it can't read your private environment variables. If the key stops working, or you withdraw the integration's consent, before the turn starts, the message is listed as failed with the reason.

Required access

Credentials: delegated token, user session, user API key

User API keys use the owner’s current permissions, subject to any key restrictions. Capability scopes below apply to automation account keys and delegated tokens.

Scope: chats:edit

Only the member who started the chat, through their user API key or an integration acting for them: a chat is private to them. Another member's chat answers 404, also to a workspace owner or admin, who may only stop its turn or delete it, signed in to the app, and reads none of it. Automation accounts have no chats.

Authorization

AuthorizationBearer <token>

A user-owned key prefixed gsmc_uk_, bound to one organization. It follows its owner's current membership, role and resource permissions, optionally restricted to read-only access. No X-Org-Id header is needed; a conflicting organization is rejected. Credential creation, personal connection setup and human attestations require a signed-in session. Runs are private to the calling user; sharing an agent grants access to your own personal memory of it, never to the agent's own memory.

In: header

Path Parameters

chat_id*Chat Id
Formatuuid
message_id*Message Id

Header Parameters

X-Org-Id?|

Selects the active organization for a direct user session that has more than one membership. Automation account keys and delegated tokens are each bound to one organization and ignore it.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

New text for a queued or failed message.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/chats/497f6eca-6276-4993-bfeb-53cbbbba6f08/pending-messages/0" \  -H "Authorization: Bearer $GUEST_MACHINES_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "content": "Summarize the open incidents for the EU only."  }'
{  "id": 0,  "status": "failed",  "content": "string",  "client_ref": "string",  "attachment_count": 0,  "failure_message": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

List a chat's waiting messages GET

List the messages sent to a chat that it hasn't taken in yet, in the order it will take them in: messages steering the working turn first, then queued and failed ones in queue order.

Delete a waiting message DELETE

Delete a queued or failed message before a turn takes it in.