Bynn Intelligence API Keys API

openapi: 3.2.0
info:
  title: BYNN API Keys API
  description: 'The BYNN API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website’s client-side code). JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects. To make the API as explorable as possible, accounts have test mode and live mode API keys. There is no “switch” for changing between modes, just use the appropriate key to perform a live or test transaction. Requests made with test-mode credentials never hit live networks and incur no cost. **AUTHENTICATION:** Use your **Private API Key**, which looks like `private_xxxxxxxxxxxxxxxxxxxxxxxx` (or `private_sandbox_xxxxxxxxxxxxxxxxxxxxxxxx` for a sandbox key), as the username in HTTP Basic auth with an empty password, or send it as `Authorization: Bearer `. Your keys are at https://dashboard.bynn.com/integration.'
  termsOfService: https://bynn.com/terms
  contact:
    name: BYNN Development Team
    email: hello@bynn.com
    url: https://docs.bynn.com
  license:
    name: BYNN Documentation
    url: https://docs.bynn.com
  version: '1.0'
servers:
- url: https://api.bynn.com/v1
tags:
- name: API Keys
  description: Operations about api_keys
paths:
  /api_keys/public:
    get:
      summary: Get the organization public API key
      description: 'Returns the PUBLIC API key for the organization identified by the PRIVATE API

        key used to authenticate this request.


        This lets a server-side integration that holds only the private key obtain the

        matching public key — which is required to create client-side verification

        sessions (e.g. `POST /v1/sessions`) — without logging in to the dashboard.


        The returned public key matches the mode (test vs live) of the private key used

        to authenticate: a test private key returns the test public key, a live private

        key returns the live public key.


        ### Response

        - `public_key` — the organization''s public API key string (e.g. `public_...`)

        - `is_test` — whether this is a test-mode key


        ### Errors

        - `401 authentication_error` — missing, malformed, or revoked private key.

        - `404 not_found` — the organization has no public key of the matching mode.'
      security:
      - PrivateKey: []
      responses:
        '200':
          description: Get the organization public API key
      tags:
      - API Keys
      operationId: getApiKeysPublic
components:
  securitySchemes:
    PrivateKey:
      type: apiKey
      name: Authorization
      in: header
      description: Enter your PRIVATE KEY token prefixed with `Bearer `, e.g. `Bearer your_token_here`
    PublicKey:
      type: apiKey
      name: Authorization
      in: header
      description: Enter your PUBLIC KEY token prefixed with `Bearer `, e.g. `Bearer your_token_here`