> ## 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 automation

> Reads one automation, in the organization that owns it.

Use this tool when you need to:
- Load an automation's prompt, schedule and agent profile before changing it with patchAutomation
- Check whether an automation is active, when it runs next and how its latest run went

Examples:
- GET /automations/{automationID}

Hints:
- automationID is the automation's uuid (422 when not a uuid).
- Answers every field patchAutomation writes, under the same name (name, prompt, schedule, agent_profile_id, status), beside id, project_id, next_due_at, last_run_status (pending, task_created or failed; null while it has not fired), created_at and updated_at.
- agent_profile_id is null when its tasks follow the project's defaults. A deleted automation, or one of an archived project, is 404.
- Use listAutomationRuns instead for its runs and the tasks they created.
- Any owner, admin or member of the automation's organization: an automation the caller cannot see is 404, a viewer or billing member is refused with 403 org_role_insufficient, a suspended organization with 403 org_suspended, and an agent host's grant with 403 agent_host_route_not_allowed; 503 when the membership check is unavailable.



## OpenAPI

````yaml api-reference/openapi.json GET /automations/{automationID}
openapi: 3.1.0
info:
  title: Aether API
  version: 0.1.0
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /automations/{automationID}:
    get:
      tags:
        - automations
      summary: Get automation
      description: >-
        Reads one automation, in the organization that owns it.


        Use this tool when you need to:

        - Load an automation's prompt, schedule and agent profile before
        changing it with patchAutomation

        - Check whether an automation is active, when it runs next and how its
        latest run went


        Examples:

        - GET /automations/{automationID}


        Hints:

        - automationID is the automation's uuid (422 when not a uuid).

        - Answers every field patchAutomation writes, under the same name (name,
        prompt, schedule, agent_profile_id, status), beside id, project_id,
        next_due_at, last_run_status (pending, task_created or failed; null
        while it has not fired), created_at and updated_at.

        - agent_profile_id is null when its tasks follow the project's defaults.
        A deleted automation, or one of an archived project, is 404.

        - Use listAutomationRuns instead for its runs and the tasks they
        created.

        - Any owner, admin or member of the automation's organization: an
        automation the caller cannot see is 404, a viewer or billing member is
        refused with 403 org_role_insufficient, a suspended organization with
        403 org_suspended, and an agent host's grant with 403
        agent_host_route_not_allowed; 503 when the membership check is
        unavailable.
      operationId: getAutomation
      parameters:
        - in: path
          name: automationID
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Automation'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationsErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/AutomationsErrorResponse'
                  - $ref: '#/components/schemas/OrgAuthorizationErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationsErrorResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationsErrorResponse'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationsErrorResponse'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationsErrorResponse'
          description: Service Unavailable
components:
  schemas:
    Automation:
      additionalProperties: false
      properties:
        agent_profile_id:
          format: uuid
          type:
            - string
            - 'null'
        created_at:
          format: date-time
          type: string
        id:
          format: uuid
          type: string
        last_run_status:
          enum:
            - pending
            - task_created
            - failed
          type:
            - string
            - 'null'
        name:
          maxLength: 100
          minLength: 1
          type: string
        next_due_at:
          format: date-time
          type: string
        project_id:
          format: uuid
          type: string
        prompt:
          minLength: 1
          type: string
        schedule:
          discriminator:
            mapping:
              daily: '#/components/schemas/AutomationDailySchedule'
              interval: '#/components/schemas/AutomationIntervalSchedule'
              weekly: '#/components/schemas/AutomationWeeklySchedule'
            propertyName: kind
          oneOf:
            - $ref: '#/components/schemas/AutomationIntervalSchedule'
            - $ref: '#/components/schemas/AutomationDailySchedule'
            - $ref: '#/components/schemas/AutomationWeeklySchedule'
        status:
          enum:
            - active
            - paused
          type: string
        updated_at:
          format: date-time
          type: string
      required:
        - id
        - project_id
        - name
        - prompt
        - status
        - schedule
        - next_due_at
        - agent_profile_id
        - last_run_status
        - created_at
        - updated_at
      type: object
    AutomationsErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - account_deleting
            - aether_inference_unavailable
            - aether_inference_unserved
            - agent_connector_not_found
            - agent_default_project_archived
            - agent_profile_changed
            - agent_profile_harness_fixed
            - bad_gateway
            - bad_request
            - conflict
            - connection_agent_only
            - connection_harness_mismatch
            - connection_not_held
            - control_forbidden
            - default_skill_required
            - fallback_is_own_connection
            - fallback_required_with_pin
            - fallback_requires_pin
            - forbidden
            - gateway_timeout
            - gone
            - integration_auth_unexpected
            - integration_not_in_directory
            - integration_shape_changed
            - internal_error
            - mcp_connection_github_not_connected
            - mcp_connection_oauth_not_accepted
            - mcp_connection_org_not_offered
            - mcp_connection_secret_invalid
            - mcp_connection_server_changed
            - mcp_connection_static_secret_not_accepted
            - mcp_credential_policy_not_applicable
            - mcp_credential_policy_org_unavailable
            - mcp_credential_policy_required
            - mcp_oauth_app_auth_method_unsupported
            - mcp_oauth_app_invalid
            - mcp_oauth_app_issuer_invalid
            - mcp_oauth_app_required
            - mcp_oauth_not_advertised
            - mcp_oauth_pkce_unsupported
            - mcp_oauth_registration_failed
            - mcp_repo_config_invalid
            - mcp_server_address_refused
            - mcp_server_aether_managed
            - mcp_server_api_key_not_applicable
            - mcp_server_args_invalid
            - mcp_server_auth_discovery_failed
            - mcp_server_auth_unsupported
            - mcp_server_directory_managed
            - mcp_server_directory_moved
            - mcp_server_display_name_invalid
            - mcp_server_env_invalid
            - mcp_server_headers_invalid
            - mcp_server_key_invalid
            - mcp_server_key_reserved
            - mcp_server_key_taken
            - mcp_server_kind_change_refused
            - mcp_server_not_from_directory
            - mcp_server_not_mcp
            - mcp_server_package_invalid
            - mcp_server_plugin_bundled
            - mcp_server_plugin_off
            - mcp_server_response_too_large
            - mcp_server_return_to_invalid
            - mcp_server_runtime_invalid
            - mcp_server_switched_off
            - mcp_server_unreachable
            - mcp_server_url_invalid
            - mcp_server_version_unpinned
            - method_not_allowed
            - not_acceptable
            - not_found
            - not_implemented
            - org_role_insufficient
            - org_suspended
            - payment_required
            - plugin_moved
            - plugin_name_taken
            - plugin_request_invalid
            - plugin_server_key_reserved
            - plugin_server_key_taken
            - plugin_server_probe_failed
            - plugin_server_required
            - plugin_skill_invalid
            - plugin_source_address_refused
            - plugin_source_empty
            - plugin_source_invalid
            - plugin_source_not_found
            - plugin_source_not_public
            - plugin_source_too_large
            - plugin_source_unreachable
            - plugin_source_unsupported
            - plugin_switched_off
            - plugin_undeliverable
            - precondition_failed
            - rate_limited
            - request_canceled
            - request_timeout
            - request_too_large
            - service_unavailable
            - skill_slug_reserved
            - unauthenticated
            - unsupported_media_type
            - validation_failed
          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
    AutomationDailySchedule:
      additionalProperties: false
      properties:
        daily_minute_of_day:
          format: int32
          maximum: 1439
          minimum: 0
          type: integer
        kind:
          enum:
            - daily
          type: string
        timezone:
          minLength: 1
          type: string
      required:
        - kind
        - timezone
        - daily_minute_of_day
      type: object
    AutomationIntervalSchedule:
      additionalProperties: false
      properties:
        interval_minutes:
          format: int32
          minimum: 1
          type: integer
        kind:
          enum:
            - interval
          type: string
        timezone:
          minLength: 1
          type: string
      required:
        - kind
        - timezone
        - interval_minutes
      type: object
    AutomationWeeklySchedule:
      additionalProperties: false
      properties:
        kind:
          enum:
            - weekly
          type: string
        timezone:
          minLength: 1
          type: string
        weekly_day:
          format: int32
          maximum: 6
          minimum: 0
          type: integer
        weekly_minute_of_day:
          format: int32
          maximum: 1439
          minimum: 0
          type: integer
      required:
        - kind
        - timezone
        - weekly_day
        - weekly_minute_of_day
      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.