Agents

post/v1/{platform}/agents/{id}/stop

Request

  • Base URL: https://api.autosheet.com
  • URL: https://api.autosheet.com/v1/{platform}/agents/{id}/stop
  • Auth: none required

Path parameters

platformstring required
idstring required

Response

Ok

idstring required
spreadsheet_idstring required
status'active' | 'idle' required
created_atstring required
last_activity_atstring nullable required
number_of_turnsnumber double required

Total number of turns in this agent's conversation, including the one in progress when the agent is active.

error_messagestring nullable required

The latest turn's error message (failure reason), or null when it has not errored. Always returned — errored turns produce no assistant message, so this is where the failure surfaces.

error_codestring nullable required

The latest turn's gpt-errors code, or null when it has not errored or the failure carried no code. Lets a client branch on the condition instead of matching the message (GPT-4710).

error_paramsRecordStringUnknown

Construct a type with a set of properties K of type T

Changes

No recorded changes to this operation across all 1 revision of this API.