Sign in

v1

latestOpenAPI 3.1.02026-07-26269227514.8 KB
sessions

Archive Session

Archive session and put it to sleep if currently running

post/v3/organizations/{org_id}/sessions/{devin_id}/archive

Path parameters

org_idstring nullable required
Example:org-abc123def456

Organization ID (prefix: org-)

devin_idstring nullable required
Example:devin-abc123def456

Devin session ID (prefix: devin-)

Response

Successful Response

acus_consumednumber required
category'bug_fixing' | 'ci_cd_and_devops' | 'code_quality_and_security' | 'code_review' | 'code_review_and_analysis' | 'data_and_automation' | 'documentation_and_content' | 'feature_development' | 'migrations_and_upgrades' | 'other' | 'production_investigation' | 'refactoring_and_optimization' | 'research_and_exploration' | 'security' | 'unit_test_generation' nullable

The session's assigned use-case category, if categorisation has run. Only populated on get/list endpoints.

child_session_idsstring[] nullable
created_atinteger required
is_archivedboolean
org_idstring required
origin'webapp' | 'slack' | 'teams' | 'api' | 'linear' | 'jira' | 'automation' | 'cli' | 'desktop' | 'code_scan' | 'other' nullable

The origin from which the session was created.

parent_session_idstring nullable
playbook_idstring nullable
service_user_idstring nullable
session_idstring required
status'new' | 'claimed' | 'running' | 'exit' | 'error' | 'suspended' | 'resuming' required
status_detail'working' | 'waiting_for_user' | 'waiting_for_approval' | 'finished' | 'inactivity' | 'user_request' | 'usage_limit_exceeded' | 'out_of_credits' | 'out_of_quota' | 'no_quota_allocation' | 'payment_declined' | 'org_usage_limit_exceeded' | 'total_session_limit_exceeded' | 'error' nullable

Additional detail about the session's current status. When status is 'running': 'working' (actively working), 'waiting_for_user' (needs user input), 'waiting_for_approval' (awaiting action approval in safe mode), or 'finished' (task complete). When status is 'suspended': the reason for suspension such as 'inactivity', 'user_request', 'usage_limit_exceeded', 'out_of_credits', 'out_of_quota', 'no_quota_allocation', 'payment_declined', 'org_usage_limit_exceeded', 'total_session_limit_exceeded', or 'error'. Only populated on get/list endpoints.

structured_outputobject nullable

Validated structured output from the session. Only populated on get/list endpoints.

subcategorystring nullable

The session's assigned subcategory display name. 'Other' when a category is set but no subcategory was assigned or resolved. Only populated on get/list endpoints.

tagsstring[] required
titlestring nullable
updated_atinteger required
urlstring required
user_idstring nullable