> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orgo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get suspension

> Read a computer’s status and its current suspension.

Returns a computer's status and its current suspension: whether its memory is still being saved, where it lives, and how far a copy has got. Poll it after a [suspend](https://docs.orgo.ai/api-reference/computers/suspend.md) or [resume](https://docs.orgo.ai/api-reference/computers/resume.md) that returned `202`, until `status` reads `suspended` or `running`. It needs write access to the workspace: a Can chat member gets `403`.

## Path parameters

**id** `string` *required*

Computer UUID or `instance_id`. Both resolve to the same computer.

## Query parameters

**after** `string`

`resume` asks Orgo to check a `running` computer against its host once more after a resume, so its connection details are up to date.

## Response

**id** `string`

Computer identifier (UUID).

**status** `string`

The computer's status, as [Get computer](https://docs.orgo.ai/api-reference/computers/get.md) reports it. While it is `suspending` or `resuming`, each read also checks its host, so a finished save or resume shows here.

**suspension** `object | null`

The computer's current or most recent suspension. `null` when none is recorded.

**properties**

**state** `string`

`capturing`, `uploading`, `stored`, `resuming`, `resumed`, `failed`, or `abandoned`.

**kind** `string`

`ram` (memory and disk saved) or `disk_only`.

**bytes\_done** `integer | null`

Bytes saved so far.

**bytes\_total** `integer | null`

Bytes to save.

**progress** `number | null`

From `0` to `1`. `1` once the copy is stored. `null` when the size is not known yet.

**local\_only** `boolean`

`true` when saving the copy failed and the computer's memory is kept on its host only. It can still be resumed there.

**failed** `boolean`

`true` when `state` is `failed`.

**where** `string`

`host` or `storage`. A computer in storage has left its host and wakes on Resume or Start.

**saving** `boolean`

`true` while the copy is still being saved to storage. The computer can be resumed or deleted meanwhile.

**region** `string | null`

The storage region of the copy, or `null`.

**suspended\_at** `string | null`

ISO 8601 timestamp.

**stored\_at** `string | null`

ISO 8601 timestamp.

**resume\_started\_at** `string | null`

ISO 8601 timestamp.

**resumed\_at** `string | null`

ISO 8601 timestamp.

**updated\_at** `string | null`

ISO 8601 timestamp.

**instance\_details** `object | null`

The computer's placement and connection record, without its credentials.

**url** `string | null`

The computer's API address on its fleet host. See [Get computer](https://docs.orgo.ai/api-reference/computers/get.md).

## Example

```bash cURL theme={null}
curl https://www.orgo.ai/api/computers/$COMPUTER_ID/suspension \
  -H "Authorization: Bearer $ORGO_API_KEY"
```

```python Python theme={null}
import requests

response = requests.get(
    f"https://www.orgo.ai/api/computers/{computer_id}/suspension",
    headers={"Authorization": f"Bearer {api_key}"}
)

data = response.json()
print(data["status"], data["suspension"])
```

```javascript JavaScript theme={null}
const response = await fetch(`https://www.orgo.ai/api/computers/${computerId}/suspension`, {
  headers: { 'Authorization': `Bearer ${apiKey}` }
});

const { status, suspension } = await response.json();
console.log(status, suspension);
```

### Response

```json theme={null}
{
  "id": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "status": "suspended",
  "suspension": {
    "state": "uploading",
    "kind": "ram",
    "bytes_done": 2147483648,
    "bytes_total": 4294967296,
    "progress": 0.5,
    "local_only": false,
    "failed": false,
    "suspended_at": "2026-10-13T09:12:00.000Z",
    "stored_at": null,
    "resume_started_at": null,
    "resumed_at": null,
    "updated_at": "2026-10-13T09:12:40.000Z",
    "where": "host",
    "saving": true,
    "region": "nyc"
  },
  "instance_details": {
    "provider": "metal",
    "id": "a3881618",
    "resolution": "1280x720x24"
  },
  "url": "http://162.43.189.25:8231"
}
```

## Errors

| Status | Body | When |
| - | - | - |
| `401` | `{ "error": "Invalid API key" }` | The Bearer token starts with `sk_` but is not a known Orgo key. |
| `401` | `{ "error": "Authentication required" }` | No `Authorization` header, or a Bearer token that is not an `sk_` key. |
| `402` | `{ "error": "Choose a plan to continue." }` | The computer is a trial computer whose trial has ended. `error` is "Manage this computer’s payment in Account → Usage." when its payment is managed there. |
| `403` | `{ "error": "You do not have access to this workspace." }` | You are not a member of the computer's workspace. |
| `403` | `{ "error": "This workspace is view-only. Ask the owner for write access (workspace_read_only).", "code": "workspace_read_only" }` | You have Can chat access to the workspace. |
| `403` | `{ "error": "This API key cannot access this workspace (workspace_scope_mismatch).", "code": "workspace_scope_mismatch" }` | The API key is scoped to a different workspace. |
| `401`, `403` | `{ "error": "…", "code": "key_permission" }` | The key itself was refused before the read ran, such as a restricted key without Computers read, a key for one computer (`computer_scope`), a computer's own key or its identity token (`computer_key`), or an expired key (`401`, `key_expired`). Listed in [Codes any endpoint can return to a key](https://docs.orgo.ai/api-reference/api-keys/manage.md#codes-any-endpoint-can-return-to-a-key). |
| `404` | `{ "error": "Computer not found (computer_not_found).", "code": "computer_not_found" }` | No computer matches the id. Signed in with a session instead of a key, the body is `{ "error": "Desktop not found" }`. |
| `429` | `{ "error": "Too many API requests this minute (600 a minute on your plan). Try again in 30 seconds.", "code": "rate_limited", "limit": "api_other_per_minute", "retry_after": 30 }` | The workspace owner's plan rate limit for other API calls. `limit` is `api_other_per_minute`. Carries a `Retry-After` header with the seconds to wait. Refused before the request runs. See [Plan rate limits](https://docs.orgo.ai/guides/account-limits.md#plan-rate-limits). |
| `500` | `{ "error": "Failed to read the computer’s suspension" }` | The read failed. |
| `503` | `{ "error": "Service temporarily unavailable. …" }` | Orgo could not verify the credential because of a server-side fault. The response carries `Retry-After: 5`. Retry after that delay. |


## OpenAPI

````yaml GET /computers/{id}/suspension
openapi: 3.1.0
info:
  title: Orgo API
  description: >-
    Launch cloud computers that AI agents can control and interact with. Create
    workspaces, provision computers, and control them programmatically.
  version: 2.0.0
  contact:
    name: Orgo Support
    email: contact@orgo.ai
    url: https://orgo.ai
servers:
  - url: https://www.orgo.ai/api
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Support
    description: >-
      Orgo’s support agent, for programs: ask how to do something in Orgo and
      get an answer with full URLs and copyable commands.
  - name: Account
    description: >-
      Account capacity: how many computers an account may run, and adding or
      giving back more. Residential data: what the account has left for
      residential IPs, and buying more from credits.
  - name: Agent accounts
    description: >-
      Accounts an AI agent makes for itself, and the claim link a person uses to
      take one over.
  - name: Clients
    description: >-
      Run Orgo for your clients from your own app: a workspace and scoped key
      each, billed to you or to them.
  - name: Workspaces
    description: Organize computers into named workspaces
  - name: Computers
    description: Provision and manage virtual computers
  - name: Public URLs
    description: Share an app running on a computer at an https address on orgo.dev.
  - name: Computer Lifecycle
    description: Start, stop, and restart computers
  - name: Computer Actions
    description: Control mouse, keyboard, and execute commands
  - name: Screens
    description: >-
      More than one desktop on a single computer. Each screen is its own X
      server with its own cursor and window manager, so an agent working on one
      cannot disturb another.
  - name: Files
    description: Upload and download files
  - name: Templates
    description: Author, build, and launch reproducible computers from templates
  - name: Chat
    description: Run an agent on a computer through OpenAI-compatible chat completions.
  - name: Workflows
    description: >-
      Routines that run the same way every time: a start, then steps. Make them
      from plain words or lines, check them, run them and follow their runs (in
      preview).
paths:
  /computers/{id}/suspension:
    get:
      tags:
        - Computer Lifecycle
      summary: Get suspension
      description: >-
        Returns the computer's status and its current suspension: whether its
        memory is still being saved (with progress), stored, or coming back.
        Poll it after a `202` from suspend or resume. Each call while it is
        `suspending` or `resuming` also settles the status from its host. Send
        `?after=resume` to check a computer that just came back `running`. It
        needs write access to the workspace: a Can chat member gets `403`
        (`workspace_read_only`).
      operationId: getComputerSuspension
      parameters:
        - name: id
          in: path
          required: true
          description: Computer UUID or instance_id
          schema:
            type: string
        - name: after
          in: query
          required: false
          description: >-
            `resume`: also check a `running` computer that just resumed, so its
            connection details are current.
          schema:
            type: string
            enum:
              - resume
      responses:
        '200':
          description: The status and suspension.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  status:
                    type: string
                    description: The computer's status, as on `GET /computers/{id}`.
                  suspension:
                    oneOf:
                      - $ref: '#/components/schemas/Suspension'
                      - type: 'null'
                    description: The newest suspension, or `null` when none is recorded.
                  instance_details:
                    type:
                      - object
                      - 'null'
                    additionalProperties: true
                    description: The placement record, without credentials.
                  url:
                    type:
                      - string
                      - 'null'
              example:
                id: a3bb189e-8bf9-3888-9912-ace4e6543002
                status: suspending
                suspension:
                  state: uploading
                  kind: ram
                  bytes_done: 1073741824
                  bytes_total: 4294967296
                  progress: 0.25
                  local_only: false
                  failed: false
                  suspended_at: '2026-10-13T09:00:00.000Z'
                  stored_at: null
                  resume_started_at: null
                  resumed_at: null
                  updated_at: '2026-10-13T09:00:20.000Z'
                  where: host
                  saving: false
                  region: null
                instance_details:
                  provider: metal
                url: http://198.51.100.24:8081
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/TrialInactive'
        '403':
          $ref: '#/components/responses/AccessDenied'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          description: The suspension could not be read.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Failed to read the computer’s suspension
components:
  schemas:
    Suspension:
      type: object
      description: >-
        A computer's suspension: where its memory is and how far saving it has
        got. No host, bucket or key.
      properties:
        state:
          type: string
          enum:
            - capturing
            - uploading
            - stored
            - resuming
            - resumed
            - failed
            - abandoned
        kind:
          type: string
          enum:
            - ram
            - disk_only
        bytes_done:
          type:
            - integer
            - 'null'
        bytes_total:
          type:
            - integer
            - 'null'
        progress:
          type:
            - number
            - 'null'
          description: 0 to 1 once the size is known (1 once stored), else `null`.
        local_only:
          type: boolean
          description: >-
            `true` when saving to storage failed and its host kept the memory:
            it resumes only there.
        failed:
          type: boolean
        suspended_at:
          type:
            - string
            - 'null'
          format: date-time
        stored_at:
          type:
            - string
            - 'null'
          format: date-time
        resume_started_at:
          type:
            - string
            - 'null'
          format: date-time
        resumed_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
        where:
          type: string
          enum:
            - host
            - storage
        saving:
          type: boolean
          description: '`true` while its storage copy is still being saved.'
        region:
          type:
            - string
            - 'null'
          description: Region of its storage copy, such as `nyc`.
    Error:
      type: object
      description: >-
        The base error body. Every failure carries `error`; individual endpoints
        add the fields named in the schemas below.
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable message.
          example: Access denied
        code:
          type: string
          description: >-
            Machine-readable reason. Present on the failures that define one,
            absent otherwise.
    RateLimited:
      type: object
      required:
        - error
        - code
        - limit
        - retry_after
      properties:
        error:
          type: string
          description: Which limit, in plain words, and when to try again.
        code:
          type: string
          const: rate_limited
        limit:
          type: string
          enum:
            - computer_create_per_minute
            - computer_create_per_hour
            - computer_create_per_day
            - computer_lifecycle_per_minute
            - computer_lifecycle_per_computer_per_minute
            - computer_control_per_minute
            - computer_control_per_computer_per_minute
            - chat_runs_per_minute
            - chat_runs_concurrent
            - workspace_create_per_hour
            - api_other_per_minute
        retry_after:
          type: integer
          minimum: 1
          description: Seconds to wait.
      example:
        error: >-
          Too many API requests this minute (120 a minute on your plan). Try
          again in 12 seconds.
        code: rate_limited
        limit: api_other_per_minute
        retry_after: 12
  responses:
    Unauthorized:
      description: 'No usable credential. Send `Authorization: Bearer $ORGO_API_KEY`.'
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - type: object
                properties:
                  docs:
                    type: string
                    format: uri
                    description: 'How to sign in: `https://www.orgo.ai/auth.md`.'
          examples:
            invalid-key:
              summary: The key is not one of yours
              value:
                error: Invalid API key
                docs: https://www.orgo.ai/auth.md
            no-credential:
              summary: No key and no session
              value:
                error: Authentication required
                docs: https://www.orgo.ai/auth.md
      headers:
        WWW-Authenticate:
          description: '`Bearer realm="Orgo API"`.'
          schema:
            type: string
    TrialInactive:
      description: >-
        The computer is a free trial computer whose trial is no longer active,
        or it is paid for by its own subscription or dedicated purchase and that
        payment has lapsed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            trial:
              summary: Trial no longer active
              value:
                error: Choose a plan to continue.
            payment:
              summary: The computer's own payment has lapsed
              value:
                error: Manage this computer’s payment in Account → Usage.
    AccessDenied:
      description: >-
        You are not the owner or a member of the computer's workspace, you have
        Can chat access, or the API key is scoped to another workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            no-access:
              summary: Not the owner or a member of the workspace
              value:
                error: You do not have access to this workspace.
            view-only:
              summary: Can chat member, and the request changes something
              value:
                error: >-
                  This workspace is view-only. Ask the owner for write access
                  (workspace_read_only).
                code: workspace_read_only
            scope-mismatch:
              summary: The API key is scoped to another workspace
              value:
                error: >-
                  This API key cannot access this workspace
                  (workspace_scope_mismatch).
                code: workspace_scope_mismatch
    NotFound:
      description: >-
        No computer with this id on your account. With an API key the body
        carries `code: "computer_not_found"`; signed in with a session it is
        `Desktop not found`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            api-key:
              summary: API key
              value:
                error: Computer not found (computer_not_found).
                code: computer_not_found
            session:
              summary: Signed in with a session
              value:
                error: Desktop not found
    RateLimited:
      description: >-
        Over one of the account's plan rate limits (`rate_limited`): `limit`
        names it, and `retry_after` and `Retry-After` say how many seconds to
        wait. Limits are per account, the workspace owner's when the request
        acts on a computer or a workspace, and set by its plan. See [Account
        limits and rate limits](/guides/account-limits#plan-rate-limits).
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimited'
  headers:
    RetryAfter:
      description: Seconds to wait before asking again.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: The tightest limit this request counts against.
      schema:
        type: integer
    RateLimitRemaining:
      description: How many are left of it in this window.
      schema:
        type: integer
    RateLimitReset:
      description: Seconds until its window starts again.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key authentication. Get your key at orgo.ai/workspaces

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.