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

Element5 Object Store API

Object Store related APIs

Element5 Object Store API is one of 3 APIs that Element5 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Object Store. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 2.2.0.

Requests are made against 2 base URLs: https://api-qa.e5.ai, https://api.e5.ai.

2 operations 2 paths 5 schemas 1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.2.0
Base URL
https://api.e5.ai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Element5 Object Store API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key provided by Element5 to authenticate and authorize the Element5 APIs

Paths & Operations 2

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

Object Store 2

Object Store related APIs

GET
/store/v1/file-object/{object-id}
Fetch the file object
getFileObject 1 param → 200302401403404
PUT
/store/v1/file-object
Upload a file object
uploadFileObject body → 201400401403413

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are AuthError (2 properties), FileUploadSuccessResponse (2 properties), FileUploadBadRequestError (2 properties), AuthorizationError (2 properties). Each schema is shown below with its type and property counts.

FileUploadPayloadTooLargeError
object
File upload Payload Too Large Error Response
2 properties
AuthorizationError
object
2 properties
FileUploadBadRequestError
object
File upload Bad Request Error Response
2 properties
FileUploadSuccessResponse
object
File upload Success Response
2 properties
AuthError
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

element5-object-store-api-openapi.yml Raw ↑

Other APIs Element5 publishes across the network.

Element5 Authorization API
Element5 Eligibility API