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

# Execute a run (streaming)

> Executes a run, optionally across several models at once, streaming newline-delimited JSON progress:

- `{"type":"batch_started","batchId","models":[...]}`
- `{"type":"scenario_started" | "scenario_done" | "scenario_failed", ...}`
- `{"type":"model_done","runId","modelIdentifier","status","passCount","totalCount", ...}`
- `{"type":"done","result":{...}}`
- `{"type":"error","message"}`
- `{"type":"ping"}` heartbeat every 10 seconds

Can run for up to 800 seconds.

**Auth:** session. **Permission:** `run_agents` or `manage_agents`.



## OpenAPI

````yaml /api-reference/openapi.json post /projects/{projectId}/cost-calculator/runs/{runId}/execute/stream
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/runs/{runId}/execute/stream:
    post:
      tags:
        - Cost calculator
      summary: Execute a run (streaming)
      description: >-
        Executes a run, optionally across several models at once, streaming
        newline-delimited JSON progress:


        - `{"type":"batch_started","batchId","models":[...]}`

        - `{"type":"scenario_started" | "scenario_done" | "scenario_failed",
        ...}`

        -
        `{"type":"model_done","runId","modelIdentifier","status","passCount","totalCount",
        ...}`

        - `{"type":"done","result":{...}}`

        - `{"type":"error","message"}`

        - `{"type":"ping"}` heartbeat every 10 seconds


        Can run for up to 800 seconds.


        **Auth:** session. **Permission:** `run_agents` or `manage_agents`.
      operationId: executeCostRunStream
      parameters:
        - name: projectId
          in: path
          required: true
          description: Project id.
          schema:
            type: string
            format: uuid
        - name: runId
          in: path
          required: true
          description: Cost Calculator run id.
          schema:
            type: string
            format: uuid
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                model_config_ids:
                  type: array
                  maxItems: 20
                  items:
                    type: string
                    format: uuid
                  default: []
                  description: >-
                    Models to run the scenarios on. Empty runs the run's own
                    model.
                org_slug:
                  type: string
                  maxLength: 200
                project_slug:
                  type: string
                  maxLength: 200
      responses:
        '200':
          description: Event stream.
          content:
            application/x-ndjson:
              schema:
                type: string
                description: One JSON object per line.
        '400':
          description: Validation failed. `error.code` is `VALIDATION_ERROR`.
          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'
      security:
        - session: []
components:
  schemas:
    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.