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

# Check account health

> An end-to-end check of one account: whether Instagram has paused the connection and
why, how fast it sends and how much is waiting, which errors Instagram has returned
lately, and whether any live automation is set up in a way that can't fire. The
answer to "why did nobody get the DM?".

A queue is not a fault. inDM spaces sends on purpose so Instagram keeps trusting
the account; `messages_waiting` drains at `send_speed_per_hour`.

Needs a `read` or `full` key.




## OpenAPI

````yaml get /accounts/{account_id}/health
openapi: 3.1.0
info:
  title: inDM API
  version: 1.0.0
  summary: >-
    Build, launch and read Instagram comment-to-DM automations from your own
    code.
  description: >
    The inDM API gives your code the same reach as the inDM app: list the posts
    and reels

    inDM has synced, pull in new ones, build automations on them, set them live
    and read

    how they are doing.


    Every request is authenticated with an API key created in **Settings → API
    keys**.

    Keys belong to one workspace and carry a scope, `read` or `full`. Keys are
    server-side

    secrets: the API sends no CORS headers, so a browser can't call it directly.


    Nothing sends through this API. No DM, broadcast or public reply leaves
    Instagram by

    this path, and every automation it creates starts as a `draft`. Setting one
    `live` is

    the only call that changes what people on Instagram receive.
  contact:
    name: inDM support
    email: support@indm.social
    url: https://docs.indm.social
servers:
  - url: https://api.indm.social/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Workspace
    description: The workspace and API key behind a request.
  - name: Accounts
    description: Connected Instagram accounts, their health, and content refreshes.
  - name: Media
    description: Posts and reels inDM has synced from Instagram.
  - name: Automations
    description: Comment-to-DM automations. Created as drafts; set live when you're ready.
paths:
  /accounts/{account_id}/health:
    get:
      tags:
        - Accounts
      summary: Check account health
      description: >
        An end-to-end check of one account: whether Instagram has paused the
        connection and

        why, how fast it sends and how much is waiting, which errors Instagram
        has returned

        lately, and whether any live automation is set up in a way that can't
        fire. The

        answer to "why did nobody get the DM?".


        A queue is not a fault. inDM spaces sends on purpose so Instagram keeps
        trusting

        the account; `messages_waiting` drains at `send_speed_per_hour`.


        Needs a `read` or `full` key.
      operationId: getAccountHealth
      parameters:
        - $ref: '#/components/parameters/AccountId'
      responses:
        '200':
          description: The account's health.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountHealth'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    AccountId:
      name: account_id
      in: path
      required: true
      description: >-
        The account `id` from [List
        accounts](/api-reference/accounts/list-accounts).
      schema:
        type: string
        format: uuid
      example: 6f1c2a9e-3b7d-4e21-9a55-0c8d2f4b7e10
  headers:
    X-Request-Id:
      description: >-
        A unique id for this request. Include it when you write to support and
        we can find the request at once.
      schema:
        type: string
      example: req_8Qm2ZcY4vN7tLp1K
    RateLimit-Limit:
      description: >-
        Requests this key may make per minute, across every route. Sent once the
        key is accepted.
      schema:
        type: integer
      example: 120
    RateLimit-Remaining:
      description: >-
        Requests left in the current one-minute window. `0` when a write is
        refused for the write limit.
      schema:
        type: integer
      example: 117
    RateLimit-Reset:
      description: Seconds until the current window resets.
      schema:
        type: integer
      example: 42
    Retry-After:
      description: Seconds to wait before trying again.
      schema:
        type: integer
      example: 18
  schemas:
    AccountHealth:
      type: object
      required:
        - account_id
        - username
        - status
        - live_automations
        - automations_that_cannot_fire
        - send_speed_per_hour
        - messages_waiting
        - messages_failed_last_24h
        - messages_failed_last_7d
        - instagram_errors_last_7d
      properties:
        account_id:
          type: string
          format: uuid
          example: 6f1c2a9e-3b7d-4e21-9a55-0c8d2f4b7e10
        username:
          type: string
          description: The Instagram handle, without the @.
          example: maya.grows
        status:
          type: string
          enum:
            - connected
            - needs_reconnect
            - disconnected
            - error
          description: >
            `connected` when everything is running. `needs_reconnect` when
            Instagram has

            paused the connection; nothing syncs or sends until it is
            reconnected in the app.
          example: connected
        reason:
          type: string
          description: >-
            A stable slug for why the account isn't connected. Present only when
            it isn't.
          example: token_expired
        dark_since:
          type: string
          format: date-time
          description: When the account stopped working. Present only when it has.
        live_automations:
          type: integer
          description: Automations live on this account now.
          example: 2
        automations_that_cannot_fire:
          type: array
          description: >-
            Names of live automations set up in a way that can never trigger,
            such as one with no keywords. Empty when there are none.
          items:
            type: string
          example: []
        send_speed_per_hour:
          type: integer
          description: >
            How many messages this account sends per hour, at most. inDM spaces
            sends on

            purpose so Instagram keeps trusting the account.
          example: 200
        messages_waiting:
          type: integer
          description: >-
            Messages queued for this account right now. A queue drains at
            `send_speed_per_hour`; it is not a fault.
          example: 4
        messages_failed_last_24h:
          type: integer
          description: Messages Instagram refused in the last 24 hours.
          example: 0
        messages_failed_last_7d:
          type: integer
          description: >-
            Messages Instagram refused in the last 7 days. The true total for
            the window `instagram_errors_last_7d` breaks down.
          example: 1
        instagram_errors_last_7d:
          type: object
          description: >
            What Instagram refused in the last 7 days and how often, keyed by a
            plain-words

            summary of each refusal. The keys are written for people, so show
            them rather

            than branching on them. Read the total from
            `messages_failed_last_7d`. Empty

            when nothing was refused.
          additionalProperties:
            type: integer
          example:
            Instagram refused to message specific people: 1
        last_inbound_received_at:
          type: string
          format: date-time
          description: >-
            When inDM last heard from Instagram about a comment or message on
            this account. A long silence on an active account is worth a look.
          example: '2026-11-05T08:52:40Z'
    Error:
      type: object
      description: Every error has this shape.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - doc_url
          properties:
            type:
              type: string
              description: The family of error. Each maps to one HTTP status.
              enum:
                - invalid_request
                - authentication_error
                - permission_error
                - plan_limit
                - not_found
                - conflict
                - rate_limited
                - api_error
            code:
              type: string
              description: >
                A stable, specific code. Branch on this, never on `message`.
                Every code is

                listed on [Errors](/errors).
              example: dm_message_too_long
            message:
              type: string
              description: >-
                A sentence for a person, saying what happened and what to do
                next. It may change; don't parse it.
            param:
              type: string
              description: >-
                The request field the error is about. Left out when no single
                field is.
              example: dm_message
            doc_url:
              type: string
              format: uri
              description: A link to this code on the [Errors](/errors) page.
              example: https://docs.indm.social/errors#dm_message_too_long
  responses:
    Unauthorized:
      description: The API key is missing, malformed, expired or revoked.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication_error
              code: api_key_expired
              message: >-
                This API key expired on 3 Feb 2027. Create a new one under
                Settings → API keys.
              doc_url: https://docs.indm.social/errors#api_key_expired
    NotFound:
      description: Nothing with that id exists in this key's workspace.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: not_found
              code: media_not_found
              message: >-
                There's no post with that id in this workspace. GET /v1/media
                lists them; refresh the account first if it was just published.
              param: media_id
              doc_url: https://docs.indm.social/errors#media_not_found
    RateLimited:
      description: >-
        This key went past its rate limit. Wait for `Retry-After` seconds, then
        try again.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: rate_limited
              code: rate_limited
              message: >-
                That's more than 120 requests a minute on one key. Wait 18s and
                try again.
              doc_url: https://docs.indm.social/errors#rate_limited
    ServerError:
      description: >
        Something failed on our side. Retrying with backoff is safe for reads.
        The same body

        comes with `503` when inDM briefly can't reach its database.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: api_error
              code: internal_error
              message: >-
                Something went wrong on our end. Try again; if it keeps
                happening, quote request req_8Qm2ZcY4vN7tLp1K to
                support@indm.social.
              doc_url: https://docs.indm.social/errors#internal_error
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: indm_ API key
      description: >
        An API key from **Settings → API keys** in the inDM app, sent as

        `Authorization: Bearer indm_...`. Keys belong to one workspace and carry
        a scope:

        `read` for GET routes and the validate dry run, `full` for everything.
        Keep keys on

        your server; never ship one to a browser or a mobile app.

````

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