GET /v1/runs/{runId}

The full persisted run (status, messages, usage); 404 covers cross-tenant ids and another client's runs.

**Scoped to the calling API-key client:** only a run this client started is reachable — any of its keys, rotations included. Another client's run in the same tenant, a run started before clients were recorded, and another tenant's run are all the same 404 as an unknown id.

Request

Path & query

NameInTypeRequired
runIdpathuuidrequired

Example

shell
curl https://api.askamy.co.za/v1/runs/{runId} \
  -H "X-Api-Key: $AMY_API_KEY"

Responses

StatusDescriptionBody
200OKRunDetailDto
401UnauthorizedProblemDetails
404Not FoundProblemDetails

Schemas

AmyUsage

FieldTypeRequired
inputTokensinteger required
outputTokensinteger required
totalTokensinteger required
reportedCostnumber | nulloptional
reportedCostCurrencystring | nulloptional
cachedInputTokensinteger | nulloptional
cacheWriteTokensinteger | nulloptional
reasoningTokensinteger | nulloptional
uncachedInputTokensinteger optional

PendingApprovalDto

FieldTypeRequired
approvalIduuid required
toolNamestring required
argsJsonstring | nullrequired
requestedAtdate-time required
expiresAtdate-time | nullrequired
approvableScopesstring[] required
requestingAgentSlugstring | nulloptional
delegatedGatedToolsstring[] | nulloptional

PendingQuestionDto

FieldTypeRequired
questionIduuid required
askingAgentSlugstring required
questionstring required
optionsQuestionOptionDto[] required
recommendedIndexinteger | nullrequired
allowMultipleboolean required
allowFreeTextboolean required
askedAtdate-time required
answerQuestionAnswerDto | nulloptional

ProblemDetails

FieldTypeRequired
typestring | nulloptional
titlestring | nulloptional
statusinteger | nulloptional
detailstring | nulloptional
instancestring | nulloptional

QuestionAnswerDto

FieldTypeRequired
chosenIndicesinteger[] required
freeTextstring | nullrequired
declinedboolean required
answeredAtdate-time required

QuestionOptionDto

FieldTypeRequired
labelstring required
reasonstring required

RunAgentUsageDto

FieldTypeRequired
agentSlugstring required
inputTokensinteger required
outputTokensinteger required
totalTokensinteger required

RunAttachmentDto

FieldTypeRequired
runIduuid required
iduuid required
fileIduuid required
kindstring required
filenamestring required
contentTypestring required
sizeBytesinteger required
sourceUrlstring | nulloptional

RunConversationContextDto

FieldTypeRequired
conversationIduuid required
titlestring | nullrequired
positioninteger required
runCountinteger required
previousRunIduuid | nullrequired
nextRunIduuid | nullrequired

RunDetailDto

FieldTypeRequired
iduuid required
statusstring required
agentSlugstring required
endUserRefstring | nullrequired
conversationIduuid | nullrequired
createdAtdate-time required
startedAtdate-time | nullrequired
completedAtdate-time | nullrequired
usageAmyUsage required
credentialScopeUsedstring | nullrequired
messagesRunMessageDto[] required
iterationsRunIterationDto[] required
pendingApprovalsPendingApprovalDto[] required
conversationRunConversationContextDto | nulloptional
agentUsageRunAgentUsageDto[] | nulloptional
attachmentsRunAttachmentDto[] | nulloptional
errorCodestring | nulloptional
failureReasonstring | nulloptional
workspaceRunWorkspaceDto | nulloptional
tasksRunTaskDto[] | nulloptional
taskWaitRunTaskWaitDto | nulloptional
taskWakesUsedinteger optional
cappedToolFamiliesstring[] | nulloptional
pendingQuestionPendingQuestionDto | nulloptional
retriesUsedinteger optional
retryCapinteger optional
retryableboolean optional
toolWarningsToolWarning[] optional

RunIterationDto

FieldTypeRequired
iduuid required
sequenceinteger required
modelIdstring required
finishReasonstring | nullrequired
inputTokensinteger required
outputTokensinteger required
durationMsinteger required
agentSlugstring | nulloptional
parentToolCallIdstring | nulloptional

RunMessageDto

FieldTypeRequired
sequenceinteger required
iterationIduuid | nullrequired
rolestring required
kindstring required
textstring | nullrequired
toolNamestring | nullrequired
toolCallIdstring | nullrequired
argumentsJsonstring | nullrequired
resultJsonstring | nullrequired
isErrorboolean required
createdAtdate-time required
agentSlugstring | nulloptional
parentToolCallIdstring | nulloptional

RunTaskDto

FieldTypeRequired
iduuid required
labelstring required
agentSlugstring required
statusstring required
runIduuid | nullrequired
deadlinedate-time required
resultDigeststring | nullrequired
errorCodestring | nullrequired
failureReasonstring | nullrequired
createdAtdate-time required
startedAtdate-time | nullrequired
completedAtdate-time | nullrequired

RunTaskWaitDto

FieldTypeRequired
modestring required
startedAtdate-time required
deadlinedate-time required

RunWorkspaceDto

FieldTypeRequired
iduuid required
slugstring required
namestring required

ToolWarning

FieldTypeRequired
codestring required
toolsstring[] required
messagestring required
serverstring | nulloptional