> ## Documentation Index > Fetch the complete documentation index at: https://docs.runaether.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get a workspace's disk hydration > Reads from the workspace's provider, now, whether its machine runs before its disk's files have all arrived. A resumed or forked boat machine answers before its files are copied in; until they are, the first read of each file waits for it, so a Git read can outlast its timeout. Use this tool when you need to: - Tell a Git read that timed out because the disk is still arriving from one that is stuck - Decide whether to retry a workspace read that timed out Examples: - GET /workspaces/{workspaceID}/hydration - GET /workspaces/6f1c2a9e-3b7d-4c55-9a2e-0d8b1f4e7c21/hydration Hints: - workspaceID is the workspace's uuid (422 otherwise); a deleted workspace is 404. - hydrating is false for a workspace without a machine and on a provider that reports no hydration. - 502 when the provider cannot be read. - Use getWorkspace instead to read the workspace's state. - Owners, admins and members of the workspace's organization, whichever organization the caller selected; a viewer or billing member is refused with 403 org_role_insufficient, a suspended organization with 403 org_suspended, a workspace in no organization the caller belongs to is 404, and 503 when the membership check is unavailable. An agent host's grant is refused with 403 agent_host_route_not_allowed. ## OpenAPI ````yaml api-reference/openapi.json GET /workspaces/{workspaceID}/hydration openapi: 3.1.0 info: title: Aether API version: 0.1.0 servers: - url: https://api.runaether.dev security: - bearerAuth: [] paths: /workspaces/{workspaceID}/hydration: get: tags: - workspaces summary: Get a workspace's disk hydration description: >- Reads from the workspace's provider, now, whether its machine runs before its disk's files have all arrived. A resumed or forked boat machine answers before its files are copied in; until they are, the first read of each file waits for it, so a Git read can outlast its timeout. Use this tool when you need to: - Tell a Git read that timed out because the disk is still arriving from one that is stuck - Decide whether to retry a workspace read that timed out Examples: - GET /workspaces/{workspaceID}/hydration - GET /workspaces/6f1c2a9e-3b7d-4c55-9a2e-0d8b1f4e7c21/hydration Hints: - workspaceID is the workspace's uuid (422 otherwise); a deleted workspace is 404. - hydrating is false for a workspace without a machine and on a provider that reports no hydration. - 502 when the provider cannot be read. - Use getWorkspace instead to read the workspace's state. - Owners, admins and members of the workspace's organization, whichever organization the caller selected; a viewer or billing member is refused with 403 org_role_insufficient, a suspended organization with 403 org_suspended, a workspace in no organization the caller belongs to is 404, and 503 when the membership check is unavailable. An agent host's grant is refused with 403 agent_host_route_not_allowed. operationId: getWorkspaceHydration parameters: - in: path name: workspaceID required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkspaceHydration' description: OK '401': content: application/json: schema: $ref: '#/components/schemas/WorkspacesErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/OrgAuthorizationErrorResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/WorkspacesErrorResponse' description: Not Found '422': content: application/json: schema: $ref: '#/components/schemas/WorkspacesErrorResponse' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/WorkspacesErrorResponse' description: Internal Server Error '502': content: application/json: schema: $ref: '#/components/schemas/WorkspacesErrorResponse' description: Bad Gateway '503': content: application/json: schema: $ref: '#/components/schemas/WorkspacesErrorResponse' description: Service Unavailable components: schemas: WorkspaceHydration: additionalProperties: false properties: hydrating: type: boolean required: - hydrating type: object WorkspacesErrorResponse: additionalProperties: false properties: code: enum: - account_deleting - bad_gateway - bad_request - conflict - control_forbidden - forbidden - gateway_timeout - gone - internal_error - method_not_allowed - not_acceptable - not_found - not_implemented - org_role_insufficient - org_suspended - payment_required - precondition_failed - preview_auth_command_failed - preview_auth_invalid_output - preview_auth_not_auto - preview_auth_not_declared - preview_auth_output_too_large - preview_auth_rate_limited - preview_auth_timeout - preview_auth_workspace_upgrade_required - rate_limited - request_canceled - request_timeout - request_too_large - service_unavailable - task_creator_deleted - unauthenticated - unsupported_media_type - validation_failed - workspace_not_connectable - workspace_not_resizable - workspace_not_running - workspace_preview_auth_service_not_ready - workspace_startable - workspace_transitional minLength: 1 type: string error: minLength: 1 type: string errors: items: $ref: '#/components/schemas/ErrorDetail' type: array required: - error - code type: object OrgAuthorizationErrorResponse: additionalProperties: false properties: code: enum: - org_membership_required - org_role_insufficient - org_suspended - account_deleting - agent_host_route_not_allowed - credential_kind_not_admitted type: string error: minLength: 1 type: string required: - error - code type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object securitySchemes: bearerAuth: bearerFormat: JWT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.