GET /v1/conversations

One end user's conversations for the calling API-key client, most recently active first.

Scoped to the calling API-key CLIENT (any of its keys — a rotated key reads what its predecessor wrote) and to the one endUserRef named, which is required. Only runs started through the /v1 run routes after this surface shipped carry a client, so earlier runs are not returned. A run another client started under the same conversationId is never included.

Request

Path & query

Name	In	Type	Required
endUserRef	query	string	required
page	query	integer	optional
pageSize	query	integer	optional

Example

shell

curl https://api.askamy.co.za/v1/conversations \
  -H "X-Api-Key: $AMY_API_KEY"

Responses

Status	Description	Body
200	OK	PagedResultOfClientConversationSummaryDto
400	Bad Request	HttpValidationProblemDetails
401	Unauthorized	ProblemDetails

Schemas

ClientConversationSummaryDto

Field	Type	Required
conversationId	uuid	required
agentSlug	string	required
title	string \| null	required
status	string	required
startedAt	date-time	required
lastActivityAt	date-time	required
runCount	integer	required

HttpValidationProblemDetails

Field	Type	Required
type	string \| null	optional
title	string \| null	optional
status	integer \| null	optional
detail	string \| null	optional
instance	string \| null	optional
errors	object	optional

PagedResultOfClientConversationSummaryDto

Field	Type	Required
items	ClientConversationSummaryDto[]	required
page	integer	required
pageSize	integer	required
total	integer	required

ProblemDetails

Field	Type	Required
type	string \| null	optional
title	string \| null	optional
status	integer \| null	optional
detail	string \| null	optional
instance	string \| null	optional