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 Schema API

Manage SpiceDB schema definitions, diff schemas, and reflect schema metadata

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

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

This API exposes 6 operations across 6 paths, and defines 27 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.

6 operations 6 paths 27 schemas 6 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 Schema 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 6

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

Schema 6

Manage SpiceDB schema definitions, diff schemas, and reflect schema metadata

POST
/v1/schema/diffschema
DiffSchema returns the difference between the specified schema and the current schema stored in SpiceDB.
SchemaService_DiffSchema body → 200default
POST
/v1/schema/permissions/computable
ComputablePermissions returns the set of permissions that compute based off a relation in the current schema. For example, if the schema has a relation viewer and a permission view defined as permiss…
SchemaService_ComputablePermissions body → 200default
POST
/v1/schema/permissions/dependent
DependentRelations returns the set of relations and permissions that used to compute a permission, recursively, in the current schema. It is the inverse of the ComputablePermissions API.
SchemaService_DependentRelations body → 200default
POST
/v1/schema/read
Read returns the current Object Definitions for a Permissions System.
SchemaService_ReadSchema body → 200default
POST
/v1/schema/reflectschema
ReflectSchema reflects the current schema stored in SpiceDB, returning a structural form of the schema for use by client tooling.
SchemaService_ReflectSchema body → 200default
POST
/v1/schema/write
Write overwrites the current Object Definitions for a Permissions System.
SchemaService_WriteSchema body → 200default

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are ReflectionSchemaDiff (19 properties), ReflectionTypeReference (5 properties), ReflectionSchemaFilter (4 properties), ReflectionRelation (4 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
ReflectionRelation
object
ReflectionRelation is the representation of a relation in the schema.
4 properties
ReflectSchemaRequest
object
2 properties
ReflectionCaveat
object
ReflectionCaveat is the representation of a caveat in the schema.
4 properties
ReflectionDefinition
object
ReflectionDefinition is the representation of a definition in the schema.
4 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
ReflectionCaveatParameter
object
ReflectionCaveatParameter is the representation of a parameter in a caveat.
3 properties
ReflectionPermission
object
ReflectionPermission is the representation of a permission in the schema.
3 properties
ReflectionSchemaDiff
object
ReflectionSchemaDiff is the representation of a diff between two schemas.
19 properties
WriteSchemaResponse
object
WriteSchemaResponse is the resulting data after having written a Schema to a Permissions System.
1 property
DiffSchemaResponse
object
2 properties
ReadSchemaRequest
object
ReadSchemaRequest returns the schema from the database.
ReflectionRelationSubjectTypeChange
object
2 properties
ReflectionSchemaFilter
object
ReflectionSchemaFilter is a filter that can be applied to the schema on reflection.
4 properties
ComputablePermissionsResponse
object
2 properties
ReflectSchemaResponse
object
3 properties
WriteSchemaRequest
object
WriteSchemaRequest is the required data used to "upsert" the Schema of a Permissions System.
1 property
DependentRelationsRequest
object
3 properties
ReadSchemaResponse
object
ReadSchemaResponse is the resulting data after having read the Object Definitions from a Schema.
2 properties
DependentRelationsResponse
object
2 properties
ReflectionRelationReference
object
ReflectionRelationReference is a reference to a relation or permission in the schema.
3 properties
ReflectionCaveatParameterTypeChange
object
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
ComputablePermissionsRequest
object
4 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
ReflectionTypeReference
object
ReflectionTypeReference is the representation of a type reference in the schema.
5 properties
DiffSchemaRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

authzed-schema-api-openapi.yml Raw ↑

Other APIs Authzed publishes across the network.

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

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