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

Elementum Agents API

Manage AI agents

Elementum Agents API is one of 18 APIs that Elementum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.0.1, at version 0.0.1.

Requests are made against a single base URL, /v1.

3 operations 2 paths 10 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
0.0.1
Base URL
https://api.elementum.io/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Elementum Agents API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (ClientCredentials) using the clientCredentials flow.

Paths & Operations 3

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

Agents 3

Manage AI agents

GET
/apps/{alias}/agents
List agents under an app
listAgents 6 params → 200400401403404422429500
POST
/apps/{alias}/agents
Create an agent under an app
createAgent 1 param body → 201400401403404422429500
PUT
/apps/{alias}/agents/{id}
Update an agent by ID
updateAgent 2 params body → 200400401403404422429500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are AgentSubtypeUpdateInput (9 properties), AgentSubtypeCreateInput (9 properties), Agent (7 properties), PagingState (4 properties). Each schema is shown below with its type and property counts.

PagingState
object
4 properties
PassthroughObject
object
Free-form JSON object forwarded to/from the downstream service.
AgentBundleCreateRequest
object
Body for POST /v1/apps/{alias}/agents.
3 properties 1 required
AgentBundleUpdateRequest
object
Body for PUT /v1/apps/{alias}/agents/{id}.
3 properties 1 required
AgentUpdateInput
object
Discriminator wrapper. Exactly one subtype field must be populated.
1 property
AgentPagedList
object
3 properties
AgentSubtypeCreateInput
object
Agent creation input. Less common fields (voiceConfig, agentAuthentication, runAs, startingActions, skillAccessConfig, systemToolsConfig, a2aStreaming, a2aReco…
9 properties
AgentCreateInput
object
Discriminator wrapper. Exactly one subtype field must be populated.
1 property
AgentSubtypeUpdateInput
object
Agent update input. Only fields you wish to change need to be included; omitted fields keep their current value. Less common fields (voiceConfig, agentAuthenti…
9 properties
Agent
object
An agent returned by the agents list endpoint (summary projection).
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elementum-agents-api-openapi.yml Raw ↑

Other APIs Elementum publishes across the network.

Elementum Access Token API
Elementum Apps API
Elementum Attachments API
Elementum Automations API
Elementum Comments API
Elementum Domains API
Elementum Elements API
Elementum Flows API
Elementum Groups API
Elementum Records API
Elementum Related-items API
Elementum Search Tables API