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

# Recommend a model to ship

> Picks one of 2 to 8 candidate models by weighing accuracy, reliability, latency and cost. A deterministic pick is always computed; when your organization's platform allowance is available, a small model call may refine it and write the rationale (`source: "model"`). Otherwise `source` is `heuristic`.

**Auth:** session. **Permission:** member of the project's organization.



## OpenAPI

````yaml /api-reference/openapi.json post /projects/{projectId}/cost-calculator/recommend
openapi: 3.1.0
info:
  title: CorePillar API
  version: 1.0.0
  description: >-
    REST API for AgentHub and ModelHub. Ingestion endpoints authenticate with a
    project tracing key; all other endpoints use the signed-in user's browser
    session.
servers:
  - url: https://pillarforge.corepillar.ai/api/v1
    description: AgentHub
security: []
tags:
  - name: Ingestion
    description: 'Send traces with a tracing key: JSON ingest and OpenTelemetry (OTLP).'
  - name: Traces
    description: Read traces and spans.
  - name: Evaluations
    description: Evaluate traces with evaluator collections.
  - name: Evaluators
    description: Built-in and custom evaluators.
  - name: Evaluator collections
    description: Ordered groups of evaluators.
  - name: Organizations
    description: Organizations you belong to.
  - name: Members
    description: Organization members, invites and roles.
  - name: Projects
    description: Projects inside an organization.
  - name: SSO
    description: Okta SSO configuration.
  - name: Tracing keys
    description: Create, list and revoke project tracing keys.
  - name: Cost calculator
    description: Estimate, generate and execute scenario runs.
  - name: Synthetic
    description: Synthetic agent and data setup from source material.
  - name: Chat
    description: ModelHub chat. Served at https://modelhub.corepillar.ai/api/v1.
  - name: Auth
    description: Sign-in helpers.
  - name: E2E
    description: Internal end-to-end encryption key directory.
paths:
  /projects/{projectId}/cost-calculator/recommend:
    post:
      tags:
        - Cost calculator
      summary: Recommend a model to ship
      description: >-
        Picks one of 2 to 8 candidate models by weighing accuracy, reliability,
        latency and cost. A deterministic pick is always computed; when your
        organization's platform allowance is available, a small model call may
        refine it and write the rationale (`source: "model"`). Otherwise
        `source` is `heuristic`.


        **Auth:** session. **Permission:** member of the project's organization.
      operationId: recommendModel
      parameters:
        - name: projectId
          in: path
          required: true
          description: Project id.
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - candidates
              properties:
                run_id:
                  type:
                    - string
                    - 'null'
                  format: uuid
                monthly_requests:
                  type: number
                  exclusiveMinimum: 0
                  maximum: 1000000000000
                  default: 1
                candidates:
                  type: array
                  minItems: 2
                  maxItems: 8
                  items:
                    $ref: '#/components/schemas/RecommendCandidate'
      responses:
        '200':
          description: Recommendation.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    properties:
                      winner_model_id:
                        type: string
                      winner_label:
                        type: string
                      rationale:
                        type: string
                      source:
                        type: string
                        enum:
                          - model
                          - heuristic
        '400':
          description: >-
            Invalid body (`VALIDATION_ERROR`, with up to 5 issues in
            `details.issues`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Not signed in (`UNAUTHORIZED`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: >-
            Not a member of the organization, or missing the required permission
            (`FORBIDDEN`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Project not found or not visible to you (`PROJECT_NOT_FOUND`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '500':
          description: Unexpected server error (`INTERNAL_ERROR`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - session: []
components:
  schemas:
    RecommendCandidate:
      type: object
      required:
        - model_id
        - label
        - accuracy_pct
        - latency_ms
        - cost_per_request_usd
        - pass_count
        - scenario_count
      properties:
        model_id:
          type: string
          minLength: 1
          maxLength: 200
        label:
          type: string
          minLength: 1
          maxLength: 120
        accuracy_pct:
          type: number
          minimum: 0
          maximum: 100
        latency_ms:
          type: number
          minimum: 0
        cost_per_request_usd:
          type: number
          minimum: 0
        pass_count:
          type: integer
          minimum: 0
        scenario_count:
          type: integer
          minimum: 0
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable machine-readable code. Branch on this, not on `message`.
              examples:
                - VALIDATION_ERROR
            message:
              type: string
              description: Human-readable description. May change.
            details:
              type: object
              additionalProperties: true
              description: Extra context; often empty.
  securitySchemes:
    session:
      type: apiKey
      in: cookie
      name: session
      description: >-
        The session cookie set when you sign in to AgentHub or ModelHub in a
        browser. The cookie name shown here is illustrative. There are no API
        tokens for these endpoints.

````

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