Skip to content
Connect an agent

Keys

Check that one of your agents can work

Runs every rule the agent's next call would meet, on the server, and answers each one and the agent as it stands.

POST/user/agents/{id}/check

TL;DR

QuestionAnswer
What does it do?Check that one of your agents can work.
What does it take?id in the path.
What does it return?Status 200 with a body of type AgentCheck.
What can go wrong?401 not signed in; 403 the origin may not make changes; 404 no such agent of yours; 429 too many requests. Every failure uses the one error envelope.

What it does

Runs every rule the agent's next call would meet, on the server, and answers each one and the agent as it stands.

Path parameters

FieldTypeRequiredDescription
idstringyes

Responses

StatusMeaningBody
200Every check, and the agent.AgentCheck
401Not signed in.ErrorResponse
403The origin may not make changes.ErrorResponse
404No such agent of yours.ErrorResponse
429Too many requests.ErrorResponse

Response body

A 200 answer has the type AgentCheck.

FieldTypeRequiredDescription
agentAgentyes
agent.idstringyes
agent.credential"oauth" | "key"yesHow it signs in: a browser sign-in (OAuth) or an API key in its settings.
agent.namestringyesThe connection's registered agent name, or the key's name.
agent.agentobject | nullyesWhat the agent called itself (clientInfo) when it last opened an MCP session, or null when it never has.
agent.agent.namestringyes
agent.agent.versionstring | nullyes
agent.orgIdstring | nullyes
agent.createdAtintegeryes
agent.lastUsedAtinteger | nullyesIts last call, to within five minutes.
agent.sessionAtinteger | nullyesWhen it last opened an MCP session.
agent.expiresAtinteger | nullyes
agent.status"live" | "ready" | "idle" | "waiting" | "blocked"yeslive: a call in the last 15 minutes. ready: in the last 30 days. idle: earlier. waiting: never used. blocked: its next call would be refused, and blocked says why.
agent.blocked"expired" | "network" | "two_factor" | "membership" | "policy" | nullyes
checksobject[]yesEvery rule its next call would meet, in the order it meets them.
checks[].id"credential" | "expiry" | "network" | "organisation" | "two_factor" | "policy" | "allowance"yes
checks[].okbooleanyes
remainingintegeryesCalls left today on the allowance it spends.
checkedAtintegeryes

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools