Sign in
Sessions

End a session

Ends an active session.

post/sessions/{session_id}/end

Path parameters

session_idstring required

Unique identifier for the session (prefixed with sess_).

Response

OK

idstring required

Unique identifier for the session, prefixed with sess_.

objectstring required

Always session.

statusstring required

Session status: queued, running, idle, completing, completed, or failed.

created_atstring date-time required

ISO 8601 timestamp of when the resource was created.

updated_atstring date-time required

ISO 8601 timestamp of when the resource was last updated.

request_idstring required

Unique identifier for the API request. Include this when contacting support.

Changes

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