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

Nimbleway Agents API

The Agents API from Nimbleway — 7 operation(s) for agents.

Nimbleway Agents API is one of 11 APIs that Nimbleway 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 7 operations across 7 paths, and defines 17 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://sdk.nimbleway.com.

7 operations 7 paths 17 schemas 3 GET4 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://sdk.nimbleway.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nimbleway Agents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 7

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

Agents 7
POST
/v1/agents/run
Agent Run
body → 200400402404429500
POST
/v1/agents/async
Agent Async
body → 200400402404429500
POST
/v1/agents/batch
Agent Batch
body → 200400402429500
POST
/v1/agents/generations
Generate Agent
body → 201402422429500
GET
/v1/agents/generations/{generation_id}
Get Generation
1 param → 200402422429500
GET
/v1/agents
List Agents
4 params → 200
GET
/v1/agents/{agent_name}
Get Agent Details
1 param → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are AgentResponse (7 properties), AgentVersionMetadata (6 properties), CreateAgentGenerationRequest (6 properties), AgentGenerationResponse (6 properties). Each schema is shown below with its type and property counts.

AsyncResponse
object
2 properties 2 required
AgentParams
object
Agent input parameters. At least one agent-specific key-value pair is required (e.g., keyword, productid). Refer to the specific agent's documentation.
4 properties
Error400
object
4 properties 2 required
AgentVersionMetadata
object
The metadata of the agent version
6 properties
AgentBatchBody
object
Request body for executing a batch of agent requests
2 properties 2 required
AgentPayload
object
Request body model for the /agent/run endpoint
4 properties 2 required
AgentAsyncPayload
object
Request body model for the /agent/run endpoint
4 properties 2 required
Error429
object
2 properties 2 required
AgentGenerationResponse
object
6 properties 2 required
CreateAgentRefinementRequest
object
2 properties 2 required
CreateAgentGenerationRequest
object
6 properties 2 required
AgentResponse
object
7 properties 6 required
BatchResponse
object
Response when a batch of extract tasks is created successfully.
3 properties
AgentBatchInputsPayload
object
Request body model for the /agent/run endpoint
3 properties 2 required
Error402
object
2 properties 2 required
AsyncOptions
object
5 properties
Error500
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nimbleway-agents-api-openapi.yml Raw ↑

Other APIs Nimbleway publishes across the network.

Nimbleway Crawl API
Nimbleway Domain Knowledge API
Nimbleway Extract API
Nimbleway Fast SERP API
Nimbleway Jobs API
Nimbleway Map API
Nimbleway Media API
Nimbleway Search API
Nimbleway SERP API
Nimbleway Tasks API