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

# Estimate a scheduled agent's credit cost

> What this scheduled Agent is expected to spend while it is on: runs a day (the runs its schedule lets run, inside its daily windows) times credits a run (the mean of its own recent billed runs, or a typical scheduled agent's run with none in 30 days), as credits a day and over 30 days, against the workspace's monthly credits. Read it before turning a scheduled Agent on: from 25% (`needs_confirmation`), enabling it needs `confirm_estimated_cost: true`. A scheduled Agent bills every run its schedule starts, even one that finds nothing. `estimate` is null for a triggered agent, a chat agent, an agent with no schedule, and a scheduled Workflow (CHAINED_ACTIONS), which bills per ticket it finds.



## OpenAPI

````yaml https://api.neoagent.io/public-api/openapi.json get /public-api/agents/{agent_id}/cost-estimate
openapi: 3.1.0
info:
  description: >-
    Neo's public contract for the dashboard ChatAgent, partner integrations, and
    MSP automation. Every response is wrapped in a `{data, meta}` envelope;
    errors use `{error: {code, message, details?}, meta: {request_id}}`.
    Authenticate with a `Bearer neo_sk_<env>_<secret>` API key (service account)
    or a Microsoft Entra ID JWT (dashboard user). Signed-URL endpoints (end-user
    feedback links) take a `signature` query parameter instead.
  title: Neo Public API
  version: 1.0.0
servers:
  - url: https://api.neoagent.io
security: []
tags:
  - description: Service metadata — health, OpenAPI.
    name: Meta
  - description: Agents and workflows — read, version history, delete, stats.
    name: Agents
  - description: Agent/workflow execution history, sub-resources, retry/cancel.
    name: Executions
  - description: >-
      Every tool call the tenant's agents made in the last 30 days, within the
      caller's workflow access.
    name: Audit Log
  - description: PSA webhook events and their workflow-match results.
    name: Callbacks
  - description: Technician-in-the-loop approval requests.
    name: TIL requests
  - description: RMM script executions triggered by agents.
    name: RMM scripts
  - description: Dispatch-agent field-update decisions.
    name: Dispatch
  - description: The authenticated tenant.
    name: Tenant
  - description: Agent-builder schema catalogs (raw JSON payloads).
    name: Schemas
  - description: Escalate to the Neo team (HubSpot ticket).
    name: Escalation
  - description: Tenant settings.
    name: Settings
  - description: Tenant API-key management (dashboard JWT only).
    name: API keys
  - description: End-user feedback links (signed-URL auth).
    name: Feedback
  - description: End-client companies (CRUD + bulk-update).
    name: End companies
  - description: Channels — bind a CONVERSATIONAL agent to a transport (Teams or Slack).
    name: Channels
  - description: PSA/RMM/M365 integration status and connection management.
    name: Integrations
  - description: Technician roster (controls TIL routing and paging).
    name: Technicians
  - description: Future runs queued for TRIGGERED agents.
    name: Scheduled work
  - description: Subscription state and customer-facing credit usage (no provider $).
    name: Billing
  - description: Inbox messages and announcements.
    name: Inbox & Comms
  - description: Tenant-authored agent skills (CRUD) and the built-in skill catalog.
    name: Skills
paths:
  /public-api/agents/{agent_id}/cost-estimate:
    get:
      tags:
        - Agents
      summary: Estimate a scheduled agent's credit cost
      description: >-
        What this scheduled Agent is expected to spend while it is on: runs a
        day (the runs its schedule lets run, inside its daily windows) times
        credits a run (the mean of its own recent billed runs, or a typical
        scheduled agent's run with none in 30 days), as credits a day and over
        30 days, against the workspace's monthly credits. Read it before turning
        a scheduled Agent on: from 25% (`needs_confirmation`), enabling it needs
        `confirm_estimated_cost: true`. A scheduled Agent bills every run its
        schedule starts, even one that finds nothing. `estimate` is null for a
        triggered agent, a chat agent, an agent with no schedule, and a
        scheduled Workflow (CHAINED_ACTIONS), which bills per ticket it finds.
      operationId: public_api.agents_cost_estimate_get
      parameters:
        - in: path
          name: agent_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AgentCostEstimateResponse'
                  meta:
                    $ref: '#/components/schemas/SuccessMeta'
                required:
                  - data
                  - meta
                type: object
          description: Success.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Bad request — malformed input.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Unauthenticated — missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Forbidden — authenticated but not allowed.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Not found.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Conflict — the resource is in a state that blocks this operation.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Request validation failed.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Rate limited — see Retry-After.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Internal server error.
      security:
        - bearerAuth: []
components:
  schemas:
    AgentCostEstimateResponse:
      description: >-
        `estimate` is null when the agent is not a scheduled Agent, or has no
        schedule. A scheduled

        Workflow (CHAINED_ACTIONS) is never estimated: it bills per ticket it
        finds, which its schedule

        does not tell.
      properties:
        estimate:
          anyOf:
            - $ref: '#/components/schemas/AgentCostEstimate'
            - type: 'null'
      required:
        - estimate
      title: AgentCostEstimateResponse
      type: object
    SuccessMeta:
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        request_id:
          format: uuid
          type: string
        timings_ms:
          additionalProperties:
            type: number
          type: object
        warnings:
          description: >-
            Non-fatal warnings about the created/updated resource (e.g. an
            unhealthy PSA callback).
          items:
            type: string
          type: array
      required:
        - request_id
        - timings_ms
      type: object
    ErrorEnvelope:
      properties:
        error:
          properties:
            code:
              description: Stable machine-readable error code.
              type: string
            details:
              additionalProperties: true
              type: object
            message:
              type: string
          required:
            - code
            - message
          type: object
        meta:
          properties:
            request_id:
              format: uuid
              type:
                - string
                - 'null'
          type: object
      required:
        - error
        - meta
      type: object
    AgentCostEstimate:
      description: >-
        What a scheduled agent is expected to spend while it is on, in credits.


        `runs_per_day` counts the runs its schedule lets run, inside its daily
        windows. `credits_per_run`

        is the mean of the agent's own recent runs (`credits_per_run_basis`
        AGENT_HISTORY, over

        `sampled_runs` runs) or, with no billed run in the last 30 days, a
        typical scheduled agent's

        run (TYPICAL, with `sampled_runs` 0). `estimated_monthly_credits` is 30
        days at the daily rate before it is rounded, and

        `share_of_monthly_allowance` compares it with the workspace's monthly
        credits, including top-ups

        and reserve. `needs_confirmation` is true from 25%: turning the agent
        on, or giving an enabled

        agent a schedule that runs more often, then needs
        `confirm_estimated_cost: true`.
      properties:
        credits_per_run:
          title: Credits Per Run
          type: number
        credits_per_run_basis:
          enum:
            - AGENT_HISTORY
            - TYPICAL
          title: Credits Per Run Basis
          type: string
        estimated_daily_credits:
          title: Estimated Daily Credits
          type: integer
        estimated_monthly_credits:
          title: Estimated Monthly Credits
          type: integer
        monthly_credit_allowance:
          title: Monthly Credit Allowance
          type: integer
        needs_confirmation:
          title: Needs Confirmation
          type: boolean
        runs_per_day:
          title: Runs Per Day
          type: number
        sampled_runs:
          title: Sampled Runs
          type: integer
        share_of_monthly_allowance:
          title: Share Of Monthly Allowance
          type: number
      required:
        - runs_per_day
        - credits_per_run
        - credits_per_run_basis
        - sampled_runs
        - estimated_daily_credits
        - estimated_monthly_credits
        - monthly_credit_allowance
        - share_of_monthly_allowance
        - needs_confirmation
      title: AgentCostEstimate
      type: object
    Pagination:
      properties:
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
      required:
        - next_cursor
        - has_more
      type: object
  securitySchemes:
    bearerAuth:
      description: >-
        `Authorization: Bearer <token>` where `<token>` is either a
        `neo_sk_<env>_<secret>` API key (service account) or a Microsoft Entra
        ID access token (dashboard user).
      scheme: bearer
      type: http

````

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