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

# Evaluate environment decision

> Evaluates a decision using the release deployed to a specific environment.



## OpenAPI

````yaml /openapi/brms.json post /api/projects/{projectId}/environments/{environmentId}/evaluate/{*}
openapi: 3.0.3
info:
  title: GoRules BRMS
  version: local
servers: []
security: []
tags:
  - name: AI
    description: >-
      AI-powered assistant for interactive conversations and decision logic
      generation
  - name: Audit log
    description: Track and export organisation activity logs for compliance and monitoring
  - name: Branches
    description: >-
      Manage feature branches for collaborative decision development with
      commits and merging
  - name: Change requests
    description: Review and approve changes before merging or deploying to environments
  - name: Cloud
    description: Cloud-specific endpoints for organisation and client management
  - name: Decision
    description: Evaluate and simulate decision graphs with trace and performance data
  - name: Deployment workflows
    description: Manage deployment workflow runs and job approvals
  - name: Deployments
    description: Configure cloud storage providers for release deployments
  - name: Document
    description: Manage decision documents, versions, and file operations within projects
  - name: Environment
    description: >-
      Configure deployment environments with approval workflows and access
      tokens
  - name: Group
    description: Manage permission groups for project-level access control
  - name: Infrastructure
    description: Health check and infrastructure status endpoints
  - name: Integration
    description: Configure external integrations for HTTP requests and data sources
  - name: Invitation
    description: Manage organisation invitations for new members
  - name: Member
    description: Manage project membership and group assignments
  - name: Organisation
    description: Manage organisation settings, preferences, and licensing
  - name: Personal access token
    description: Create and manage personal access tokens for API authentication
  - name: Profile
    description: Manage current user profile settings
  - name: Project
    description: Create and manage projects with approval workflows
  - name: Release
    description: >-
      Package, version, and deploy decision documents. Learn more about
      [Releases](https://gorules.io/developers/brms/multi-environment)
  - name: Roles
    description: Define custom roles with permissions for organisation-wide access control
  - name: Security
    description: Manage project access tokens for API authentication
  - name: Templates
    description: Browse and apply project templates for quick onboarding
  - name: Test events
    description: Manage test events for decision evaluation and testing
  - name: User
    description: Manage organisation users, invitations, and service accounts
paths:
  /api/projects/{projectId}/environments/{environmentId}/evaluate/{*}:
    post:
      tags:
        - Decision
      summary: Evaluate environment decision
      description: >-
        Evaluates a decision using the release deployed to a specific
        environment.
      operationId: evaluateEnvironmentDecision
      parameters:
        - schema:
            type: string
          in: path
          name: projectId
          required: true
          description: ProjectId or projectKey
        - schema:
            type: string
          in: path
          name: environmentId
          required: true
          description: EnvironmentId or environmentKey
        - schema:
            type: string
          in: path
          name: '*'
          required: true
          description: Decision document key
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                context:
                  type: object
                  nullable: true
                  additionalProperties: true
                  default: {}
                  description: Evaluation context
                  example:
                    cart:
                      total: 1500
                    customer:
                      country: US
                      tier: gold
                trace:
                  type: boolean
                  default: false
                  description: Include decision trace in response
      responses:
        '200':
          description: Successful environment decision evaluation result
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    description: The computed result from the decision evaluation
                  performance:
                    type: string
                    description: Total execution time of the decision
                  trace:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier of the trace node
                        name:
                          type: string
                          description: Name of the decision node
                        input:
                          description: Input data passed to this node
                        output:
                          description: Output data produced by this node
                        traceData:
                          description: Additional trace metadata for the node
                        performance:
                          type: string
                          description: Execution time for this node
                      required:
                        - id
                        - name
                    description: >-
                      Detailed trace of each node execution when trace is
                      enabled
                additionalProperties: true
                description: Successful environment decision evaluation result
        '400':
          description: Evaluation failed due to invalid environment or missing release
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Error message describing the simulation failure
                  data:
                    description: Additional error details from the decision engine
                description: >-
                  Evaluation failed due to invalid environment or missing
                  release
      security:
        - projectAccessToken: []
components:
  securitySchemes:
    projectAccessToken:
      type: apiKey
      in: header
      name: X-Access-Token
      description: Project access token is obtained within project settings

````