Give the agent a note

POST /v1/conversations/{conversation_id}/notes

Information from your own systems for the agent to use — a payment that went through, an order that shipped. The caller does not hear it, and it reaches the agent as information, never as instructions: it cannot change what the agent is for. With respond, the agent answers at once. Needs calls:control.

Parameters

Name	In	Type	Required	Description
`conversation_id`	path	string (uuid)	Yes

Body

Sent as JSON. A field this operation does not take is refused, so a typo fails loudly.

Field	Type	Required	Description
`respond`	boolean	No	Whether the agent answers it at once, rather than using it on its next turn.
`text`	string	Yes	Information for the agent from your own systems. It reaches the agent as information, never as instructions, and the caller does not hear it.

Answer

202 with ConversationCommandObject.

Errors

Every error is a problem document with a stable code.

Status	When
`401`	The key is missing, mistyped, unknown, revoked or expired.
`403`	The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something.
`404`	This key reaches no such conversation.
`409`	The call has not been answered, has ended, or is not a call.
`422`	Validation Error
`429`	Too many requests for this key or its organization; see `Retry-After`.
`500`	Something went wrong on our side. Quote the `request_id` to support.

Examples

Give the agent a note

#!/bin/sh
# Give the agent a note. The caller does not hear it.
curl -sS --fail-with-body -X POST "https://api.aigently.ai/v1/conversations/5b7d9f1b-3d5f-4b7d-a9f1-b3d5f7b9dbfd/notes" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY" \
  --json '{
  "text": "The deposit for booking 4471 has been paid.",
  "respond": false
}'

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.