How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenFeature OFREP Core API

**Required**: Core APIs to implement to support OFREP. *This is the minimum set of APIs required for a flag management system to be OFREP compatible.*

OpenFeature OFREP Core API is published by OpenFeature on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include OFREP Core. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 23 schemas. It is described by OpenAPI 3.1.0, at version 0.3.0.

Requests are made against a single base URL, /.

2 operations 2 paths 23 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.3.0
Server
/
Authentication
HTTP Bearer, API Key
License
Apache 2.0
Resource Areas
1

Authentication & Security 2

OpenFeature OFREP Core API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

  • BearerAuth — Optional Bearer token authentication. If supported by the flag management system, clients can authenticate using a Bearer token in the Authorization header fol…
  • ApiKeyAuth — Optional API key authentication. If supported by the flag management system, clients can authenticate by providing an API key in the X-API-Key header.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

OFREP Core 2

Required: Core APIs to implement to support OFREP. This is the minimum set of APIs required for a flag management system to be OFREP compatible.

POST
/ofrep/v1/evaluate/flags/{key}
Evaluate A Single Feature Flag
evaluateFlag 1 param body → 200400404401403429500
POST
/ofrep/v1/evaluate/flags
Bulk Evaluate All Feature Flags
evaluateFlagsBulk 3 params body → 200304400401403429500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are flagNotFound (4 properties), evaluationFailure (4 properties), eventStream (4 properties), bulkEvaluationSuccess (3 properties). Each schema is shown below with its type and property counts.

bulkEvaluationFailure
object
Failure response for bulk evaluation. Returned when the entire bulk evaluation request fails (e.g., invalid context, parse errors). Individual flag failures wi…
2 properties 1 required
evaluationFailure
object
Feature flag evaluation failure response. Returned when a feature flag evaluation fails, such as when the context is invalid, required targeting keys are missi…
4 properties 2 required
bulkEvaluationSuccess
object
Success response for bulk flag evaluation. Contains an array of flag evaluations, where each item can be either a successful evaluation or an evaluation failur…
3 properties 1 required
integerFlag
object
An integer typed flag value.
1 property 1 required
flagMetadataExamples
Example metadata structure for flags
evaluationRequest
object
Request body for single feature flag evaluation. Contains the evaluation context that will be used to evaluate the feature flag.
1 property 1 required
codeDefaultFlag
object
A flag evaluation that defers to the code default value. When a flag evaluation returns this type, it indicates that the provider should use the default value…
serverEvaluationSuccess
metadata
object
Arbitrary metadata object that can contain any additional information about flags or flag sets. This metadata is useful for debugging and telemetry purposes.
floatFlag
object
A float typed flag value.
1 property 1 required
generalErrorResponse
object
General error response for unexpected server errors (500 status). Used when the server encounters an internal error that prevents flag evaluation.
1 property
key
string
The unique identifier (key) of the feature flag. This is used to reference a specific flag in the flag management system.
context
object
Evaluation context containing information used to evaluate feature flags. The context includes a targetingKey (required) along with additional properties such…
1 property 1 required
flagMetadataDescription
Arbitrary metadata for the flag, useful for telemetry and documentary purposes.
stringFlag
object
A string typed flag value.
1 property 1 required
flagNotFound
object
Feature flag not found response. Returned when a requested feature flag key does not exist in the flag management system. This can be an expected response in c…
4 properties 2 required
bulkEvaluationRequest
object
Request body for bulk flag evaluation. Contains a static context that will be used to evaluate all flags.
1 property 1 required
eventStream
object
A real-time change notification connection endpoint. The type field identifies the push mechanism; currently only sse is defined. Providers must ignore entries…
4 properties 1 required
evaluationSuccess
object
Successful feature flag evaluation response. The value property is present for all flag types except codeDefaultFlag, which indicates the provider should use t…
2 required
eventStreamEndpoint
object
Structured endpoint components for deployments that need to override the origin cleanly while preserving the request target. When present, providers construct…
2 properties 1 required
errorDetails
string
A human-readable error description providing additional context about the evaluation failure. Useful for logging, debugging, and monitoring purposes.
booleanFlag
object
A boolean typed flag value. Used for simple on/off feature flags.
1 property 1 required
objectFlag
object
An object typed flag value.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openfeature-ofrep-core-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of OpenFeature OFREP Core API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.