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

Authzed Experimental API

Experimental and preview endpoints subject to change

Authzed Experimental API is one of 6 APIs that Authzed publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Experimental. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 10 operations across 10 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://grpc.authzed.com, https://app.authzed.com.

10 operations 10 paths 49 schemas 10 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://grpc.authzed.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Authzed Experimental API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — SpiceDB preshared-key. Pass as Authorization: Bearer

Paths & Operations 10

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

Experimental 10

Experimental and preview endpoints subject to change

POST
/v1/experimental/countrelationships
EXPERIMENTAL: CountRelationships returns the count of relationships for pre-registered filter.
ExperimentalService_ExperimentalCountRelationships body → 200default
POST
/v1/experimental/diffschema
DEPRECATED: Promoted to DiffSchema in the stable API.
ExperimentalService_ExperimentalDiffSchema body → 200default
POST
/v1/experimental/permissions/bulkcheckpermission
DEPRECATED: Promoted to CheckBulkPermission in the stable API.
ExperimentalService_BulkCheckPermission body → 200default
POST
/v1/experimental/permissions/computable
DEPRECATED: Promoted to ComputablePermissions in the stable API.
ExperimentalService_ExperimentalComputablePermissions body → 200default
POST
/v1/experimental/permissions/dependent
DEPRECATED: Promoted to DependentRelations in the stable API.
ExperimentalService_ExperimentalDependentRelations body → 200default
POST
/v1/experimental/reflectschema
DEPRECATED: Promoted to ReflectSchema in the stable API.
ExperimentalService_ExperimentalReflectSchema body → 200default
POST
/v1/experimental/registerrelationshipcounter
EXPERIMENTAL: RegisterRelationshipCounter registers a new filter for counting relationships. A filter must be registered before a count can be requested.
ExperimentalService_ExperimentalRegisterRelationshipCounter body → 200default
POST
/v1/experimental/relationships/bulkexport
DEPRECATED: Promoted to ExportBulkRelationships in the stable API.
ExperimentalService_BulkExportRelationships body → 200default
POST
/v1/experimental/relationships/bulkimport
DEPRECATED: Promoted to ImportBulkRelationships in the stable API.
ExperimentalService_BulkImportRelationships body → 200default
POST
/v1/experimental/unregisterrelationshipcounter
EXPERIMENTAL: UnregisterRelationshipCounter unregisters an existing filter for counting relationships.
ExperimentalService_ExperimentalUnregisterRelationshipCounter body → 200default

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are ExpSchemaDiff (19 properties), RelationshipFilter (5 properties), ExpTypeReference (5 properties), Relationship (5 properties). Each schema is shown below with its type and property counts.

Any
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
ExperimentalCountRelationshipsResponse
object
2 properties
ExpTypeReference
object
ExpTypeReference is the representation of a type reference in the schema.
5 properties
ExperimentalRegisterRelationshipCounterResponse
object
ExperimentalComputablePermissionsRequest
object
4 properties
ExperimentalDependentRelationsResponse
object
2 properties
BulkImportRelationshipsResponse
object
BulkImportRelationshipsResponse is returned on successful completion of the bulk load stream, and contains the total number of relationships loaded.
1 property
ExpCaveatParameter
object
ExpCaveatParameter is the representation of a parameter in a caveat.
3 properties
Status
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
ExpSchemaDiff
object
ExpSchemaDiff is the representation of a diff between two schemas.
19 properties
v1.Cursor
object
Cursor is used to provide resumption of listing between calls to APIs such as LookupResources.
1 property
SubjectFilter
object
SubjectFilter specifies a filter on the subject of a relationship. subjecttype is required and all other fields are optional, and will not impose any additiona…
3 properties
BulkExportRelationshipsRequest
object
BulkExportRelationshipsRequest represents a resumable request for all relationships from the server.
4 properties
BulkCheckPermissionRequest
object
NOTE: Deprecated now that BulkCheckPermission has been promoted to the stable API as "CheckBulkPermission".
2 properties
PartialCaveatInfo
object
1 property
CheckPermissionResponse.Permissionship
string
- PERMISSIONSHIPUNSPECIFIED: PERMISSIONSHIPUNSPECIFIED is the default value and should not be used or relied upon. Servers should not return this value. - PERM…
ExperimentalRegisterRelationshipCounterRequest
object
2 properties
BulkCheckPermissionResponseItem
object
2 properties
Relationship
object
Relationship specifies how a resource relates to a subject. Relationships form the data for the graph over which all permissions questions are answered.
5 properties
ExperimentalReflectSchemaRequest
object
2 properties
ExpCaveat
object
ExpCaveat is the representation of a caveat in the schema.
4 properties
ExperimentalUnregisterRelationshipCounterRequest
object
1 property
ExperimentalDependentRelationsRequest
object
3 properties
ExperimentalDiffSchemaResponse
object
2 properties
ExpSchemaFilter
object
ExpSchemaFilter is a filter that can be applied to the schema on reflection.
4 properties
BulkCheckPermissionRequestItem
object
4 properties
ExpRelation
object
ExpRelation is the representation of a relation in the schema.
4 properties
ExpRelationReference
object
ExpRelationReference is a reference to a relation or permission in the schema.
3 properties
ExperimentalCountRelationshipsRequest
object
1 property
BulkImportRelationshipsRequest
object
BulkImportRelationshipsRequest represents one batch of the streaming BulkImportRelationships API. The maximum size is only limited by the backing datastore, an…
1 property
BulkCheckPermissionResponse
object
2 properties
ExperimentalReflectSchemaResponse
object
3 properties
ReadCounterValue
object
2 properties
RelationFilter
object
1 property
ContextualizedCaveat
object
ContextualizedCaveat represents a reference to a caveat to be used by caveated relationships. The context consists of key-value pairs that will be injected at…
2 properties
Consistency
object
Consistency will define how a request is handled by the backend. By defining a consistency requirement, and a token at which those requirements should be appli…
4 properties
ExperimentalUnregisterRelationshipCounterResponse
object
ExpCaveatParameterTypeChange
object
2 properties
ExpPermission
object
ExpPermission is the representation of a permission in the schema.
3 properties
ExperimentalComputablePermissionsResponse
object
2 properties
ObjectReference
object
ObjectReference is used to refer to a specific object in the system.
2 properties
ZedToken
object
ZedToken represents a point in time, or a "revision" in SpiceDB. It is used to provide causality metadata between Write and read requests (Check, ReadRelations…
1 property
RelationshipFilter
object
RelationshipFilter is a collection of filters which when applied to a relationship will return relationships that have exactly matching fields. All fields are…
5 properties
SubjectReference
object
2 properties
BulkExportRelationshipsResponse
object
BulkExportRelationshipsResponse is one page in a stream of relationship groups that meet the criteria specified by the originating request. The server will con…
2 properties
BulkCheckPermissionPair
object
3 properties
ExpDefinition
object
ExpDefinition is the representation of a definition in the schema.
4 properties
ExpRelationSubjectTypeChange
object
2 properties
ExperimentalDiffSchemaRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

authzed-experimental-api-openapi.yml Raw ↑

Other APIs Authzed publishes across the network.

Authzed Cloud API
Authzed Permissions API
Authzed Relationships API
Authzed Schema API
Authzed Watch API
Where this information came from

This is an independent, third-party profile of Authzed Experimental 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.