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

Nash Annotate API is one of 30 APIs that Nash publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Annotate. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, an AsyncAPI specification, and rate-limit docs.

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

Requests are made against 4 base URLs: https://api.sandbox.usenash.com, https://api.sandbox.ap-southeast-2.usenash.com, https://api.usenash.com, https://api.ap-southeast-2.usenash.com.

2 operations 2 paths 5 schemas 2 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.usenash.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nash Annotate API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT, API Key) (Token).

Paths & Operations 2

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

Annotate 2

Annotate

POST
/v1/flags
Create Flag
create_flag_v1_flags_post body → 422
POST
/v1/notes
Create Note
create_note_v1_notes_post body → 422

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are CreateFlagInputSerializer (6 properties), CreateNoteInputSerializer (3 properties), NashValidationError (3 properties), NashErrorDetails (3 properties). Each schema is shown below with its type and property counts.

CreateFlagInputSerializer
object
Expected payload for the create flag endpoint.
6 properties 1 required
NashErrorDetails
object
3 properties 2 required
FlagStatus
string
NashValidationError
object
3 properties 3 required
CreateNoteInputSerializer
object
Expected payload for the create note endpoint.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nash-annotate-api-openapi.yml Raw ↑

Other APIs Nash publishes across the network.

Nash AI Functions API
Nash Batch Job API
Nash Contracts API
Nash Couriers API
Nash Delivery Windows API
Nash Dispatch Strategies API
Nash Feedback API
Nash Fleet API
Nash Job API
Nash Messaging API
Nash Miscellaneous API
Nash Notifications API