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

Hamming AI Experiments API

Create and run experiments and experiment items.

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

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

This API exposes 4 operations across 4 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://app.hamming.ai/api/rest.

4 operations 4 paths 7 schemas 2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://app.hamming.ai/api/rest
Authentication
HTTP Bearer
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — A Hamming API key passed as a Bearer token in the Authorization header. Create a key at hamming.ai/settings.

Paths & Operations 4

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

Experiments 4

Create and run experiments and experiment items.

POST
/experiments
Create an experiment
createExperiment body → 200401
PATCH
/experiments/{experimentId}
Update an experiment
updateExperiment 1 param body → 200401
POST
/experiments/{experimentId}/items
Start an experiment item
startExperimentItem 1 param body → 200401
PATCH
/experiments/{experimentId}/items/{itemId}
End an experiment item
endExperimentItem 2 params body → 200401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ExperimentItem (6 properties), Experiment (5 properties), CreateExperimentRequest (4 properties), StartExperimentItemRequest (3 properties). Each schema is shown below with its type and property counts.

CreateExperimentRequest
object
4 properties 2 required
EndExperimentItemRequest
object
3 properties
Experiment
object
5 properties
ExperimentItem
object
6 properties
Error
object
1 property
UpdateExperimentRequest
object
1 property
StartExperimentItemRequest
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hamming-ai-experiments-api-openapi.yml Raw ↑

Other APIs Hamming AI publishes across the network.

Hamming AI Datasets API
Hamming AI Monitoring API
Hamming AI Prompts API
Hamming AI Scoring API
Hamming AI Voice Testing API