Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hex Collections API

The Collections API from Hex — 2 operation(s) for collections.

Hex Collections API is one of 11 APIs that Hex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Collections. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 4 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://app.hex.tech/api.

4 operations 2 paths 16 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://app.hex.tech/api/v1
Authentication
HTTP Bearer
License
UNLICENSED
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 4

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

Collections 4
GET
/v1/collections/{collectionId}
GetCollection 1 param → 200400403500
PATCH
/v1/collections/{collectionId}
EditCollection 1 param body → 200400403500
GET
/v1/collections
ListCollections 4 params → 200400403500
POST
/v1/collections
CreateCollection body → 201400403500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are CollectionApiResource (5 properties), TsoaErrorResponsePayload (3 properties), CollectionApiResourceSharing (3 properties), PaginationApiResource (2 properties). Each schema is shown below with its type and property counts.

PaginationApiResource
object
2 properties 2 required
ListCollectionsSortByEnum
ListCollectionsResponse
object
2 properties 2 required
CollectionApiResource
object
5 properties 3 required
CollectionApiResourceSharing
object
3 properties
ApiPaginationCursor
string
A cursor string used with before and after parameters to paginate through a list of items on the API.
EnumValues_typeofListCollectionsSortByEnum_
string
TsoaErrorResponsePayload
object
3 properties 1 required
GroupId
string
Unique ID for a group. This can be found from the groups page (in Settings).
CollectionAccess
Name
string
TraceId
string
A unique identifier for this API request. The Hex Support team may request this value when debugging an issue.
PageSize
integer
Number of results to fetch per page for paginated requests
UserId
string
Unique ID for a user. This can be found from the users page (in Settings).
CollectionId
string
Unique ID for a collection.
EnumValues_typeofCollectionAccess_
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hex-collections-api-openapi.yml Raw ↑

Other APIs Hex publishes across the network.

Hex Cells API
Hex Context API
Hex Data Connections API
Hex Embedding API
Hex Groups API
Hex Guides API
Hex Projects API
Hex Semantic (projects|models) API
Hex Threads API
Hex Users API