Nash

Nash Miscellaneous API

Miscellaneous

GitHub OpenAPI

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/nash/refs/heads/main/authentication/nash-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/nash/refs/heads/main/rate-limits/nash-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/nash/refs/heads/main/openapi/nash-miscellaneous-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/nash/refs/heads/main/asyncapi/nash-webhooks-asyncapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/nash/refs/heads/main/asyncapi/nash-webhooks.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/nash/refs/heads/main/errors/nash-error-codes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/nash/refs/heads/main/conventions/nash-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/nash/refs/heads/main/conventions/nash-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/nash/refs/heads/main/data-model/nash-data-model.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/nash/refs/heads/main/sandbox/nash-sandbox.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/nash/refs/heads/main/agentic-access/nash-agentic-access.yml

OpenAPI Specification

nash-miscellaneous-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Nash AI Functions Miscellaneous API
  version: 1.0.0
  description: LLM-backed domain tools
servers:
- url: https://api.sandbox.usenash.com
  description: Sandbox API
- url: https://api.sandbox.ap-southeast-2.usenash.com
  description: Sandbox API (Australia)
- url: https://api.usenash.com
  description: Production API
- url: https://api.ap-southeast-2.usenash.com
  description: Production API (Australia)
tags:
- name: Miscellaneous
  description: Miscellaneous
paths:
  /v1/health-check:
    get:
      tags:
      - Miscellaneous
      summary: Server Health Check
      description: Returns the current server status. Use this to verify API connectivity and availability.
      operationId: public_health_check_endpoint_v1_health_check_get
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NashValidationError'
components:
  schemas:
    NashValidationError:
      title: NashValidationError
      required:
      - error
      - response_status
      - RequestID
      type: object
      properties:
        error:
          $ref: '#/components/schemas/NashErrorDetails'
        response_status:
          title: Response Status
          type: string
        RequestID:
          title: Requestid
          type: string
    NashErrorDetails:
      title: NashErrorDetails
      required:
      - code
      - message
      type: object
      properties:
        code:
          title: Code
          type: string
        message:
          title: Message
          type: string
        details:
          title: Details
          anyOf:
          - type: object
            additionalProperties: true
          - type: 'null'
          default: null
    HealthCheckResponse:
      title: HealthCheckResponse
      enum:
      - 'TRUE'
      - 'FALSE'
      type: string
  securitySchemes:
    Token:
      type: http
      scheme: bearer
      bearerFormat: JWT, API Key