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

Nexthink Handoff API API

The Handoff API API from Nexthink — 1 operation(s) for handoff api.

Nexthink Handoff API API is one of 8 APIs that Nexthink publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Handoff API. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://{instance}.api.{region}.nexthink.cloud.

1 operations 1 paths 7 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://instance.api.us.nexthink.cloud
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Nexthink Handoff API API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). It accepts HTTP bearer tokens (jwt) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Handoff API 1
POST
/api/v1/spark/handoff
Hand off a conversation to Spark
handleHandoffRequest 3 params body → 204400401403404500502503

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are HandoffConversationMessageRequest (2 properties), FilePartByContent (2 properties), TextPartDTO (1 property), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

FilePartByContent
object
2 properties 2 required
MessageDTO
object
1 property 1 required
PartDTO
object
1 property 1 required
HandoffConversationMessageRequest
object
2 properties 1 required
ErrorResponse
object
1 property
TextPartDTO
object
1 property 1 required
PartType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nexthink-handoff-api-api-openapi.yml Raw ↑

Other APIs Nexthink publishes across the network.

Nexthink Campaigns API
Nexthink device-deletions API
Nexthink enrichment API
Nexthink Execute API
Nexthink Export API
Nexthink Remote actions API
Nexthink Workflows API