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

# website.status

> Retrieves a website's current title, publish status, live URL, screenshot, and visibility. Use [website.listCheckpoints](https://open.manus.ai/docs/v2/website.listCheckpoints) to browse version history, or [website.publish](https://open.manus.ai/docs/v2/website.publish) to deploy changes. See the [Website](https://open.manus.ai/docs/v2/website) guide. When called with `task_id`, also returns the sandbox `preview_url` and `sandbox_status`.

<sup>Questions or issues? Contact us at [api-support@manus.ai](mailto:api-support@manus.ai).</sup>

> [!TIP]
>
> **Auth:** API Key or OAuth token. No OAuth scope is required. The user must own the website or have read access to its source task; see [Website access](https://open.manus.ai/docs/v2/website.md#website-access).


## OpenAPI

````yaml GET /v2/website.status
openapi: 3.1.0
info:
  title: Manus OpenAPI v2
  description: >-
    API for integrating Manus into your workflow. All responses are wrapped with
    {"ok": true, "request_id": "...", ...} for success and {"ok": false,
    "request_id": "...", "error": {"code": "...", "message": "..."}} for errors.
  version: 2.0.0
servers:
  - url: https://api.manus.ai
security:
  - ApiKeyAuth: []
paths:
  /v2/website.status:
    get:
      summary: GetWebsiteStatus
      description: >-
        Retrieves a website's current title, publish status, live URL,
        screenshot, and visibility. Use
        [website.listCheckpoints](https://open.manus.ai/docs/v2/website.listCheckpoints)
        to browse version history, or
        [website.publish](https://open.manus.ai/docs/v2/website.publish) to
        deploy changes. See the [Website](https://open.manus.ai/docs/v2/website)
        guide. When called with `task_id`, also returns the sandbox
        `preview_url` and `sandbox_status`.
      operationId: openapi.v2.OpenapiV2Service.GetWebsiteStatus
      parameters:
        - name: x-manus-api-key
          in: header
          required: false
          schema:
            type: string
          description: >-
            API key for direct authentication. Provide either this or
            `Authorization`, not both. See
            [Authentication](https://open.manus.ai/docs/v2/authentication).
        - name: Authorization
          in: header
          required: false
          schema:
            type: string
            example: Bearer {access_token}
          description: >-
            OAuth2 access token in `Bearer {token}` format. No OAuth scope is
            required. Provide either this or `x-manus-api-key`, not both. See
            the [Open App](https://open.manus.ai/docs/v2/open-app) guide.
        - name: task_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            Session UID. Mutually exclusive with `website_id` — exactly one must
            be provided. The session must contain exactly one website.
        - name: website_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            Unique website ID. Mutually exclusive with `task_id` — exactly one
            must be provided. Obtain from the response of `website.status` or
            `website.publish`.
      responses:
        '200':
          description: Web status retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    example: true
                    description: Whether the request was successful.
                  request_id:
                    type: string
                    description: Unique identifier for this API request.
                  website_id:
                    type: string
                    description: Unique website ID.
                  title:
                    type: string
                    description: >-
                      Current display title of the website. For historical
                      websites without a stored title, this falls back to the
                      internal project name. Always present.
                  publish_status:
                    type: string
                    enum:
                      - unpublished
                      - publishing
                      - published
                      - failed
                    description: >-
                      Deployment state.


                      - `unpublished` — never published or taken down. Call
                      `website.publish` to bring it online.

                      - `publishing` — deployment in progress. Poll again.

                      - `published` — live; `site_urls` is reachable.

                      - `failed` — the last deployment failed.
                  site_urls:
                    type: array
                    items:
                      type: string
                    description: >-
                      Public URLs where the live site can be reached, ordered
                      from default to most specific: the space URL
                      (`https://{space_id}.manus.space`, always present when
                      published), an optional sub-domain URL
                      (`https://{sub_domain}.manus.space`), and any active
                      custom domains bound by the owner. All entries include the
                      `https://` scheme. Returned as an empty array unless
                      `publish_status` is `published`.
                  version_id:
                    type: string
                    description: >-
                      **Optional.** Checkpoint `version_id` currently deployed.
                      Present only when the site has been published.
                  screenshot_url:
                    type: string
                    description: >-
                      **Optional.** The screenshot shown on the website card, as
                      a signed temporary URL. Fetch the image when you need it
                      instead of storing the address. Omitted when no screenshot
                      is available.
                  status_updated_at:
                    type: integer
                    format: int64
                    description: >-
                      **Optional.** Last time the publish status changed (Unix
                      seconds). Present only when the site has been published.
                  visibility:
                    type: string
                    enum:
                      - public
                      - team
                      - private
                    description: |-
                      Who can access the published site.

                      - `public` — anyone.
                      - `team` — current team members only.
                      - `private` — owner and invited collaborators only.
                  auto_publish:
                    type: boolean
                    description: >-
                      Whether newly created checkpoints are published
                      automatically. Always present; false means disabled.
                  preview_url:
                    type: string
                    description: >-
                      **Optional.** Live preview URL served by the task's cloud
                      sandbox. Present only when the request uses `task_id` and
                      the task has an active preview binding for this website.
                      The URL stays listed while the sandbox sleeps, but it does
                      not respond until the sandbox is `running`. This is a
                      temporary address independent of `site_urls`: do not store
                      or share it.
                  sandbox_status:
                    type: string
                    description: >-
                      **Optional.** Current state of the task's cloud sandbox.
                      Present only when the request uses `task_id`.


                      - `running` — the sandbox is up. The site inside it may
                      still be starting.

                      - `paused` — asleep; `preview_url` does not respond. To
                      bring it back, send a message with
                      [task.sendMessage](https://open.manus.ai/docs/v2/task.sendMessage);
                      the agent runs and resumes the sandbox. This requires
                      permission to send messages to the task and consumes
                      credits.

                      - `resuming`, `starting`, `creating`, `resetting`,
                      `migrating` — in progress; poll again with an upper bound.

                      - `pausing`, `stopping` — going to sleep; ends in
                      `paused`.

                      - `failed`, `reset_failed`, `deleted`, `deleting` — the
                      sandbox will not recover on its own; stop polling and
                      check the task in the Manus app.

                      - `not_created` — the task has no cloud sandbox, for
                      example a task that runs on a local device.

                      - `unknown` — the state could not be read right now. Read
                      it again later.


                      Reading this field never creates, wakes, or extends a
                      sandbox.
        4XX:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
components:
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response format returned when a request fails.
      properties:
        ok:
          type: boolean
          example: false
          description: Always false for error responses.
        request_id:
          type: string
          description: >-
            Unique identifier for this API request, useful for debugging with
            support.
        error:
          type: object
          description: Error details.
          properties:
            code:
              type: string
              description: >-
                Machine-readable error code (e.g., "invalid_argument",
                "not_found", "permission_denied", "rate_limited").
            message:
              type: string
              description: Human-readable error description explaining what went wrong.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-manus-api-key

````

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