Respond to a pending chat elicitation

POST

/api/v1/chat/{chatId}/elicitations

const url = 'https://api.yggy.tech/api/v1/chat/example/elicitations';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"id":"example","action":"accept","content":{"additionalProperty":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.yggy.tech/api/v1/chat/example/elicitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "example", "action": "accept", "content": { "additionalProperty": "example" } }'

Sends the user’s accept, decline or cancel decision on a pending destructive graph change (shown to the client as an MCP elicitation) to the chat session that asked for it.

Authorizations

bearerAuth

Parameters

Path Parameters

chatId

required

string

Request Body

application/json

object

required

The correlator id of the pending elicitation, as sent to the client in the elicitation SSE event

string

>= 1 characters

action

required

The user’s decision on the pending destructive mutation

string

Allowed values: accept decline cancel

content

Form values collected from the user, present only when action is “accept”

object

key

additional properties

Responses

200

Elicitation response delivered to the chat session

application/json

object

success

required

boolean

Example

{
  "success": true
}

401

Unauthorized

application/json

object

success

required

boolean

error

required

object

message

required

string

code

string

Example

{
  "success": false
}

404

Chat session not found or not owned by the caller

application/json

object

success

required

boolean

error

required

object

message

required

string

code

string

Example

{
  "success": false
}

500

The chat session did not accept the elicitation response

application/json

object

success

required

boolean

error

required

object

message

required

string

code

string

Example

{
  "success": false
}