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

# The plan for one input, without running it

> Send the body you would send to the run. Nothing runs, nothing is charged or set aside. Show a person the steps and your input, then send `plan` back in Pramaan-Plan when you run.



## OpenAPI

````yaml /specs/platform.json post /v1/outcomes/{id}/estimate
openapi: 3.1.0
info:
  title: Pramaan API
  version: 1.0.0
  description: Provider-neutral capabilities behind one API. Prices are in micro-USD.
servers:
  - url: https://api.pramaan.dev
security: []
paths:
  /v1/outcomes/{id}/estimate:
    post:
      tags:
        - outcomes
      summary: The plan for one input, without running it
      description: >-
        Send the body you would send to the run. Nothing runs, nothing is
        charged or set aside. Show a person the steps and your input, then send
        `plan` back in Pramaan-Plan when you run.
      operationId: estimateOutcome
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: The plan
          content:
            application/json:
              schema:
                type: object
                properties:
                  outcome:
                    type: string
                  version:
                    type: integer
                  plan:
                    type: string
                    description: >-
                      Names this input, these options, these steps and their
                      prices, for this organisation and member. Good for 15
                      minutes.
                  ready:
                    type: boolean
                    description: false while an input or connection need is open.
                  can_run:
                    type: boolean
                  connect_url:
                    type: string
                    description: >-
                      Link to the dashboard connection picker when an account is
                      missing.
                  message:
                    type: string
                    description: Why a read-only key cannot run this work.
                  reason:
                    type: string
                    enum:
                      - balance
                      - daily_cap
                      - member_limit
                      - connection_required
                      - read_only
                  price_typical_micro:
                    type: integer
                    description: >-
                      Sum of active steps' capability medians times their
                      planned maximum call counts, each capped at its step's
                      bound, then kept between price_min_micro and
                      price_max_micro. Each paid step needs at least 20
                      successful paid calls among its last 200 within 30 days
                      across all callers; otherwise omitted. Cached for 5
                      minutes. Historical guidance only; does not change the
                      hold.
                  price_min_micro:
                    type: integer
                    description: >-
                      The least a run that finishes its required steps costs,
                      micro-USD: a required step whose request is known when the
                      plan is made counts at what its cheapest source asks, any
                      other required step at its limit.
                  price_max_micro:
                    type: integer
                    description: What a run sets aside, micro-USD.
                  balance_micro:
                    type: integer
                  seconds:
                    type: object
                    properties:
                      typical:
                        type: number
                      max:
                        type: number
                    required:
                      - typical
                      - max
                  requires_approval:
                    type: boolean
                  steps:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        label:
                          type: string
                        capability:
                          type: string
                        effect_class:
                          type: string
                        required:
                          type: boolean
                        max_calls:
                          type: integer
                        requires_approval:
                          type: boolean
                        price_max_micro:
                          type: integer
                        status:
                          type: string
                          enum:
                            - will_run
                            - skipped
                        reason:
                          type: string
                        slot:
                          type: string
                          description: The connection slot needed for this step.
                        connect_url:
                          type: string
                          description: Link to connect the account this step needs.
                      required:
                        - id
                        - label
                        - capability
                        - effect_class
                        - required
                        - max_calls
                        - requires_approval
                        - price_max_micro
                        - status
                  needs:
                    type: array
                    items:
                      type: object
                      properties:
                        kind:
                          type: string
                          enum:
                            - input
                            - connection
                            - approval
                        detail:
                          type: string
                        step:
                          type: string
                      required:
                        - kind
                        - detail
                required:
                  - outcome
                  - version
                  - plan
                  - ready
                  - can_run
                  - price_min_micro
                  - price_max_micro
                  - balance_micro
                  - seconds
                  - requires_approval
                  - steps
                  - needs
        default:
          description: Error (see the error guide for codes)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - addendum_required
                - invalid_request
                - unauthorized
                - forbidden
                - spend_cap_reached
                - not_found
                - job_not_found
                - conflict
                - connection_required
                - rate_limited
                - internal
                - upstream_unavailable
                - upstream_timeout
            message:
              type: string
              maxLength: 200
            next:
              type: string
              maxLength: 200
            request_id:
              type: string
            retryable:
              type: boolean
            effect:
              type: string
              enum:
                - none
              description: >-
                Present when nothing was sent, charged or created: every source
                refused before acting, or the request was refused before
                anything ran (validation, approval, balance, limits). Absent
                when anything may have happened: check before retrying an
                action.
            slot:
              type: string
            required_micro:
              type: integer
              description: >-
                With `spend_cap_reached`: the most the request can cost,
                micro-USD.
            reason:
              type: string
              enum:
                - balance
                - daily_cap
                - member_limit
                - approval_required
              description: >-
                With `spend_cap_reached`: not enough credit, the daily spend
                cap, or the spending limit of the member the call acts as. With
                `forbidden`: `approval_required`, the call needs an approver
                (send `Pramaan-Approved-By`).
            plan:
              type: string
              description: >-
                With `approval_required` on an outcome: the plan to show a
                person, then send in `Pramaan-Plan`.
            needs:
              type: array
              items:
                type: object
                properties:
                  kind:
                    type: string
                    enum:
                      - approval
                  step:
                    type: string
                  detail:
                    type: string
                required:
                  - kind
                  - detail
              description: >-
                With `approval_required` on an outcome: the steps that ask a
                person to approve.
          required:
            - code
            - message
            - next
            - request_id
            - retryable
      required:
        - error
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: 'API key: `sk_live_…`'

````

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