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

Evermuse ingestion API

Send data to Evermuse

Evermuse ingestion API is published by Evermuse on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ingestion. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 3 operations across 3 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.evermuse.com.

3 operations 3 paths 11 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.evermuse.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Evermuse ingestion API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (IngestApiKey).

  • IngestApiKey — Your API key, sent as the x-api-key header. Create one in Settings API Keys with api:write permission. Format: emsk...

Paths & Operations 3

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

ingestion 3

Send data to Evermuse

POST
/api/v1/ingest
/ingest
ingestRecords 2 params body → 202400401403413429500
GET
/api/v1/ingest/batches
/ingest/batches
listBatches 2 params → 200401403500
GET
/api/v1/ingest/batches/{batchId}
/ingest/batches/{batchId}
getBatchStatus 1 param → 200401403404500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are IngestRecord (13 properties), IngestBatchStatus (13 properties), Attachment (8 properties), Participant (5 properties). Each schema is shown below with its type and property counts.

IngestBatchListResponse
object
2 properties 2 required
Pii
object
Optional metadata about personal information in this record. Providing this helps Evermuse handle your data with the right privacy safeguards.
5 properties
IngestAcceptedResponse
object
5 properties 4 required
Participant
object
5 properties 2 required
Attachment
object
8 properties 1 required
ErrorResponse
object
4 properties 2 required
IngestRequest
The request body accepts two shapes: - An array of record objects (up to 1,000) - An object with a records key containing an array
IngestBatchStatus
object
13 properties 6 required
IngestRecordError
object
3 properties 3 required
IngestRecord
object
13 properties 8 required
PiiEntity
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

evermuse-ingestion-api-openapi.yml Raw ↑