Tools and downloads

The OpenAPI file, the Postman collection and the GraphQL schema for the Coevera API, your space's own OpenAPI document, and how to use them in Postman and Insomnia.

You can call the API from any HTTP client. These files save typing: they describe every operation, and the Postman collection is ready to send once you fill in your credentials.

The downloads

The REST reference's Downloads page offers the OpenAPI file and the Postman collection, and the GraphQL overview the schema as SDL, all built from the same pinned contract as the reference itself:

File	What it holds	Use it in
OpenAPI 3.1 (JSON)	Every REST operation, with the Coevera hosts as `{region}` and `{space_id}` server variables, the Basic security scheme, and the errors the API really returns	Insomnia, code generators, linters, AI tools
Postman collection and environment	Every REST operation, in folders by entity family, with Basic auth from the environment. The environment, Coevera, has the variables `region`, `space_id`, `key` and `secret`; `key` and `secret` ship empty.	Postman, Insomnia
GraphQL schema (SDL)	The public GraphQL schema for integrators	Code generation, editor autocomplete, linting

Every build validates the OpenAPI file with Scalar's OpenAPI parser and stops on any error. The collection follows Postman's collection format v2.1.0, and the SDL is printed by graphql-js from the public schema.

These files describe the standard data model. Custom entities appear under one generic path, /entities/{custom_entity_api_name}, and your custom fields are only in your space's own document.

Your space's own documents

Two documents come from the API itself, for your space:

Text

https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/openapi.json
https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public/schema.json

openapi.json is built for your space: its entities carry your custom fields. It needs the same Basic credentials as any API call and answers 401 without them. Its servers list hosts on the former domain; call https://{region}.api.coevera.com instead.
schema.json is the public GraphQL schema as an introspection result, in JSON. It needs no credentials.

The discovery endpoint returns both URLs for a space.

Postman

Download the collection and the environment from the downloads.
In your Postman workspace, click Use resources or import, then Import, and select both files.
Select the Coevera environment and fill in region, space_id, key (the application's User Name) and secret (its Password). key and secret are secret variables; do not share or export the environment with them filled in.
Send any request in the collection: it takes Basic auth from key and secret, and its base URL from region and space_id.

The menu names are those of Postman's import documentation.

Insomnia

In your Insomnia workspace, click Import, choose File, select the OpenAPI file or the Postman collection, click Scan, then Import. Insomnia imports OpenAPI 3.0 and 3.1 and Postman collections v2.0 and v2.1. An imported OpenAPI file opens as a spec: click Generate and choose Requests to get requests you can send. Then set the auth to Basic with the application's User Name and Password, and set the base URL to your region and space. The steps and formats are those of Kong's Insomnia documentation, import an API spec and import and export.

GraphQL clients

Send POST requests to your space's GraphQL endpoint with Basic auth, as in the quickstart. Load the schema from the SDL download or from your space's schema.json for autocomplete.

Limits

Coevera publishes no SDK. Generate a client from the OpenAPI file, or call the API over plain HTTP as the samples on this site do.
This site has no console for sending requests; use Postman, Insomnia or the samples.
The import steps follow the Postman and Insomnia documentation. The files were validated against the formats those apps import, not imported in the apps themselves.