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

Read, write, delete, and bulk import/export relationship tuples

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

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

This API exposes 5 operations across 5 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.

5 operations 5 paths 27 schemas 5 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 Relationships 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 5

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

Relationships 5

Read, write, delete, and bulk import/export relationship tuples

POST
/v1/relationships/delete
DeleteRelationships atomically bulk deletes all relationships matching the provided filter. If no relationships match, none will be deleted and the operation will succeed. An optional set of precondi…
PermissionsService_DeleteRelationships body → 200default
POST
/v1/relationships/exportbulk
ExportBulkRelationships is the fastest path available to exporting relationships from the server. It is resumable, and will return results in an order determined by the server.
PermissionsService_ExportBulkRelationships body → 200default
POST
/v1/relationships/importbulk
ImportBulkRelationships is a faster path to writing a large number of relationships at once. It is both batched and streaming. For maximum performance, the caller should attempt to write relationship…
PermissionsService_ImportBulkRelationships body → 200default
POST
/v1/relationships/read
ReadRelationships reads a set of the relationships matching one or more filters.
PermissionsService_ReadRelationships body → 200default
POST
/v1/relationships/write
WriteRelationships atomically writes and/or deletes a set of specified relationships. An optional set of preconditions can be provided that must be satisfied for the operation to commit.
PermissionsService_WriteRelationships body → 200default

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are RelationshipFilter (5 properties), DeleteRelationshipsRequest (5 properties), Relationship (5 properties), ReadRelationshipsRequest (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
ReadRelationshipsRequest
object
ReadRelationshipsRequest specifies one or more filters used to read matching relationships within the system.
4 properties
ReadRelationshipsResponse
object
ReadRelationshipsResponse contains a Relationship found that matches the specified relationship filter(s). A instance of this response message will be streamed…
3 properties
DeletionProgress
string
- DELETIONPROGRESSCOMPLETE: DELETIONPROGRESSCOMPLETE indicates that all remaining relationships matching the filter were deleted. Will be returned even if no r…
Precondition
object
Precondition specifies how and the existence or absence of certain relationships as expressed through the accompanying filter should affect whether or not the…
2 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
ImportBulkRelationshipsRequest
object
ImportBulkRelationshipsRequest represents one batch of the streaming ImportBulkRelationships API. The maximum size is only limited by the backing datastore, an…
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
v1.Cursor
object
Cursor is used to provide resumption of listing between calls to APIs such as LookupResources.
1 property
ImportBulkRelationshipsResponse
object
ImportBulkRelationshipsResponse is returned on successful completion of the bulk load stream, and contains the total number of relationships loaded.
1 property
WriteRelationshipsResponse
object
1 property
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
Precondition.Operation
string
WriteRelationshipsRequest
object
WriteRelationshipsRequest contains a list of Relationship mutations that should be applied to the service. If the optionalpreconditions parameter is included,…
3 properties
DeleteRelationshipsResponse
object
3 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
ExportBulkRelationshipsResponse
object
ExportBulkRelationshipsResponse is one page in a stream of relationship groups that meet the criteria specified by the originating request. The server will con…
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
DeleteRelationshipsRequest
object
DeleteRelationshipsRequest specifies which Relationships should be deleted, requesting the delete of ALL relationships that match the specified filters. If the…
5 properties
ExportBulkRelationshipsRequest
object
ExportBulkRelationshipsRequest represents a resumable request for all relationships from the server.
4 properties
RelationshipUpdate.Operation
string
SubjectReference
object
2 properties
RelationshipUpdate
object
RelationshipUpdate is used for mutating a single relationship within the service. CREATE will create the relationship only if it doesn't exist, and error other…
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

authzed-relationships-api-openapi.yml Raw ↑

Other APIs Authzed publishes across the network.

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

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