Dimensions · OpenAPI Overlay 1.0.0

Dimensions Authentication API — API Evangelist enhancements

5 actions 5 updates documentation
Generated by API Evangelist Written by API Evangelist tooling for Dimensions's API. It is a proposal applied on top of the contract, not a document Dimensions publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

descriptionexternalDocscontactx-token-lifetime-secondsx-alternate-paths400401429

Targets 5

$.info
$.servers[0]
$.paths['/auth'].post
$.paths['/auth'].post.responses
$.components.securitySchemes.jwt

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: Dimensions Authentication API — API Evangelist enhancements
  version: 1.0.0
x-provenance:
  generated: '2026-09-06'
  method: generated
  source: >-
    https://docs.dimensions.ai/dsl/api.html, https://docs.dimensions.ai/dsl/faq.html,
    https://docs.dimensions.ai/dsl/usagepolicy.html
  extends: openapi/dimensions-authentication-api-openapi.yml
  note: >-
    Captures documented facts the published contract omits — token lifetime, the
    documented error statuses, the alternate .json path, and the multi-tenant host
    rule. Nothing here is invented; every action cites a docs page. The original
    OpenAPI is never mutated.
actions:
- target: $.info
  update:
    contact:
      name: Dimensions API Support
      email: supportapi@dimensions.ai
    externalDocs:
      description: Dimensions DSL API Access documentation
      url: https://docs.dimensions.ai/dsl/api.html
- target: $.servers[0]
  update:
    description: >-
      Standard Dimensions instance. Custom instances use https://<tenant>.dimensions.ai
      and a key issued there returns 401 against app.dimensions.ai.
- target: $.paths['/auth'].post
  update:
    description: >-
      Exchanges a Dimensions API key for a query token. The token is a JWT valid for
      approximately two hours and must be re-obtained when it expires; there is no
      refresh token. The same request also answers at /auth.json.
    x-token-lifetime-seconds: 7200
    x-alternate-paths:
    - /auth.json
    externalDocs:
      description: Querying the API
      url: https://docs.dimensions.ai/dsl/api.html
- target: $.paths['/auth'].post.responses
  update:
    '400':
      description: Semantic/Query Error — the request body is not valid.
    '401':
      description: Authentication failure — the API key is invalid.
    '429':
      description: >-
        Rate limit exceeded. 30 requests per IP address per minute. No Retry-After
        or X-RateLimit-* header is returned.
    '500':
      description: Evaluation/Data/Timeout Error — the request could not be evaluated.
- target: $.components.securitySchemes.jwt
  update:
    description: >-
      Authorization header carrying the literal keyword JWT followed by the token
      returned by POST /auth, e.g. `Authorization: JWT eyJ...`. The keyword is JWT,
      not Bearer.

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/dimensions-authentication-api-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.