> ## Documentation Index
> Fetch the complete documentation index at: https://docs.01advertising.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Build and version information

> Identifies the running build — package name and version, git commit, and build time. The runtime is never reported (ADR-0039).



## OpenAPI

````yaml /api/openapi.json get /version
openapi: 3.1.0
info:
  title: 01Advertising Platform API
  version: 0.1.0
  description: >-
    HTTP API of the 01Advertising Platform: organizations, workspaces, API keys,
    audit logs, and the integrations that connect workspaces to advertising
    systems.


    ## Base URL and versions


    Production is `https://api.01ads.com`. Business endpoints live under `/v1`;
    `/health`, `/version`, and `/openapi.json` are unversioned. Before 1.0,
    breaking changes are made in place under `/v1` and shipped together with the
    Portal and CLI; from 1.0 on, a breaking change becomes a `/v2` sibling.
    Operation ids and schema names are stable identifiers. Local development
    runs at `http://127.0.0.1:3000` (`make api`).


    ## Authentication


    Three ways in, declared as security schemes and on every operation: a
    **session cookie** (browsers, set by the sign-in routes), the same session
    as **`Authorization: Bearer`** (the CLI and scripts), or an
    organization-bound **API key** as `x-api-key` (integrations and automation).
    Operations that declare no security requirement are public; operations that
    list only the two session schemes refuse API keys — administrative and
    account changes stay with people.


    ## Errors


    Every non-2xx answer is `application/problem+json` (RFC 9457): `type`,
    `title`, `status`, `detail`, `instance`, and `requestId`; validation
    failures add `errors: [{ path, message }]`. Browser flows answer 302 with no
    body.


    ## Collections, rate limits, and system administration


    Collections are returned whole; `GET /v1/organizations/{orgSlug}/audit-logs`
    is cursor-paginated (`cursor`, `limit`, `nextCursor`). Sign-in emails and
    sign-ups are limited per client address and per email, invitations created
    through an API key per key, and the public connect flow per address and per
    token: a limited request answers 429 with `Retry-After` in seconds.


    Guides, playbooks, and the embedding walkthrough:
    https://docs.01advertising.com.
  termsOfService: https://www.01advertising.com/legal/terms/
  contact:
    name: 01Advertising API support
    email: support@01advertising.com
    url: https://docs.01advertising.com
  license:
    name: Proprietary
    url: https://www.01advertising.com/legal/terms/
servers:
  - url: https://api.01ads.com
    description: Production
security:
  - bearerAuth: []
  - apiKey: []
tags:
  - name: account
    description: The caller's own profile, sign-up, and the invitations addressed to them
    externalDocs:
      url: https://docs.01advertising.com/guides/account
      description: Account guide
  - name: auth
    description: Sign-in methods, magic links, provider sign-in, sessions, and sign-out
    externalDocs:
      url: https://docs.01advertising.com/guides/auth
      description: Authentication guide
  - name: organizations
    description: Organization membership and invitation management
    externalDocs:
      url: https://docs.01advertising.com/guides/organizations
      description: Organizations guide
  - name: workspaces
    description: 'Workspaces: isolated partitions within an organization'
    externalDocs:
      url: https://docs.01advertising.com/guides/workspaces
      description: Workspaces guide
  - name: api-keys
    description: Programmatic access credentials
    externalDocs:
      url: https://docs.01advertising.com/guides/api-keys
      description: API keys guide
  - name: audit
    description: Organization audit trail (cursor-paginated)
    externalDocs:
      url: https://docs.01advertising.com/guides/audit-logs
      description: Audit log guide
  - name: integrations
    description: Workspace integrations with external advertising systems
    externalDocs:
      url: https://docs.01advertising.com/guides/integrations
      description: Integrations guide
  - name: connect
    description: >-
      The public connect flow a client uses to authorize an integration (no
      session)
    externalDocs:
      url: https://docs.01advertising.com/guides/integrations-embedding
      description: Embedding the connect flow
  - name: infra
    description: Health, build information, and this document
    externalDocs:
      url: https://docs.01advertising.com/guides/api-conventions
      description: API conventions
externalDocs:
  url: https://docs.01advertising.com
  description: Developer documentation
paths:
  /version:
    get:
      tags:
        - infra
      summary: Build and version information
      description: >-
        Identifies the running build — package name and version, git commit, and
        build time. The runtime is never reported (ADR-0039).
      operationId: getVersion
      responses:
        '200':
          description: Version details of the running service
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionResponse'
      security: []
components:
  schemas:
    VersionResponse:
      type: object
      properties:
        name:
          type: string
          examples:
            - '@01advertising/api'
        version:
          type: string
          description: Semantic version from package.json
          examples:
            - 0.1.0
        commit:
          type:
            - string
            - 'null'
          description: Git commit SHA of the build, when known
        builtAt:
          type:
            - string
            - 'null'
          description: Build time (ISO 8601), when known
      required:
        - name
        - version
        - commit
        - builtAt
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Session token as `Authorization: Bearer` (the CLI and scripts).'
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Organization-bound API key; accepted on /v1 routes other than
        /v1/auth/*.

````