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

# Preview the available company and officer research steps and the maximum cost for a source-backed manufacturing cohort.



## OpenAPI

````yaml /console-openapi.json post /v1/console/tables/research/preview
openapi: 3.1.1
info:
  title: Altss Console machine API
  version: '2026-11-21'
  description: >-
    Website presentation of the Altss Console contract. REST and MCP request and
    response shapes follow the deployed Console specification. Website operation
    names, server paths and scoped authorization annotations preserve existing
    documentation links. Read the original at
    https://console.altss.com/openapi.json. Capability discovery is public and
    free. Paid execution requires the approved channel, tenant authorization,
    current data licence, wallet funding and explicit quote acceptance. The
    standard human-approved authorization-code flow is MCP-only. REST uses
    supported service grants or manual credentials. Current discovery does not
    confirm a purchasable A2A operation. Current wallet funding minimums are
    recorded in x-altss-runtime.
  x-altss-source-commit: b1516ec334338a831182c7fa1701438392356774
  x-altss-source-openapi:
    url: https://console.altss.com/openapi.json
    sha256: 1edfc4977ed1dfc44a2d13a8a817d7b7c32b2d16fa985f8b93fe085511af0069
servers:
  - url: https://console.altss.com
security: []
tags:
  - name: Console REST
  - name: Console MCP
  - name: Console authorization
externalDocs:
  url: https://console.altss.com/auth.md
  description: Authoritative Console authorization and human-approval guide
paths:
  /v1/console/tables/research/preview:
    post:
      tags:
        - Console REST
      summary: >-
        Preview the available company and officer research steps and the maximum
        cost for a source-backed manufacturing cohort.
      operationId: previewCompanyResearch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResearchRequest'
      responses:
        '201':
          description: Research preview
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyResearchPlan'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
      security:
        - ConsoleAgentGrant:
            - company.read
        - ConsoleKey: []
components:
  schemas:
    ResearchRequest:
      type: object
      additionalProperties: false
      required:
        - request
      properties:
        request:
          type: string
          minLength: 5
          maxLength: 600
    CompanyResearchPlan:
      type: object
      required:
        - edition
        - source
        - rowCount
        - steps
        - maxMinor
        - planHash
        - unavailable
        - datasetHash
        - currency
      properties:
        edition:
          type: string
        source:
          type: string
        rowCount:
          type: integer
          minimum: 1
          maximum: 500
        datasetHash:
          type: string
        currency:
          type: string
          enum:
            - usd
        maxMinor:
          type: integer
          minimum: 0
        planHash:
          type: string
        unavailable:
          type: array
          items:
            type: string
        steps:
          type: array
          items:
            type: object
            required:
              - capabilityId
              - name
              - priceMinor
              - inputField
            properties:
              capabilityId:
                type: string
              name:
                type: string
              priceMinor:
                type: integer
              inputField:
                type: string
              resultInput:
                type: object
                required:
                  - resultOf
                  - field
                additionalProperties: false
                properties:
                  resultOf:
                    type: string
                  field:
                    type: string
                    enum:
                      - firstOfficerCik
                      - secondOfficerCik
                      - thirdOfficerCik
                      - confirmedOfficerGivenName
                      - confirmedOfficerFamilyName
    Error:
      type: object
      additionalProperties: true
      description: >-
        Read error.code (when error is an object) and the HTTP status. REST
        errors may carry statusCode, message, timestamp and path around error;
        some edge refusals are a flat {"error":"<code>"}.
      properties:
        error:
          oneOf:
            - type: object
              additionalProperties: true
              properties:
                code:
                  type: string
                  examples:
                    - FUNDING_REQUIRED
                message:
                  type: string
                retryable:
                  type: boolean
                chargeState:
                  type: string
                  description: For example none, held, released or unknown.
                details:
                  type: object
                  additionalProperties: true
            - type: string
        statusCode:
          type: integer
        message:
          type: string
        timestamp:
          type: string
        path:
          type: string
  responses:
    Error:
      description: >-
        A refused or failed request. Read error.code and the HTTP status; see
        https://console.altss.com/connect#errors. error.chargeState (when
        present) says whether money moved: none, held, released or unknown.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: >-
        Missing, malformed, unknown, revoked or wrong-channel credential. All
        causes are deliberately identical. Sends WWW-Authenticate: Bearer.
      headers:
        WWW-Authenticate:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ConsoleAgentGrant:
      type: oauth2
      description: >-
        Console-issued bearer credential acquired through the implemented
        user-claimed service_auth grant or its one-time Console-issued JWT
        assertion rotation. These are explicitly named specification extensions,
        not standard authorization-code, client-credentials or device flows.
        Follow the authoritative auth.md guide; extension support is optional to
        clients.
      x-oauth-authorization-server-metadata: https://console.altss.com/.well-known/oauth-authorization-server
      flows:
        x-altss-claim:
          grant_type: urn:workos:agent-auth:grant-type:claim
          tokenUrl: https://console.altss.com/v1/console/agent-auth/token
          scopes:
            company.read: >-
              Read the eligible Console catalog and the organization's purchased
              results; request qualified financial-research quotes and
              explicitly authorized executions, subject to approved channels,
              current terms, data rights, credential limits and confirmed
              funding. This scope does not grant unrestricted private data or
              authorize a purchase.
          identityUrl: https://console.altss.com/v1/console/agent-auth/identity
          documentationUrl: https://console.altss.com/auth.md
          codeChallengeMethods:
            - S256
          description: >-
            Existing custom user-claimed service flow. Registration alone grants
            no access; explicit matching-human approval, original verifier and
            exact resource are required.
        x-jwt-bearer:
          grant_type: urn:ietf:params:oauth:grant-type:jwt-bearer
          tokenUrl: https://console.altss.com/v1/console/agent-auth/token
          scopes:
            company.read: >-
              Read the eligible Console catalog and the organization's purchased
              results; request qualified financial-research quotes and
              explicitly authorized executions, subject to approved channels,
              current terms, data rights, credential limits and confirmed
              funding. This scope does not grant unrestricted private data or
              authorize a purchase.
          documentationUrl: https://console.altss.com/auth.md
          description: >-
            Only the short-lived assertion issued by this Console is accepted,
            once, with its original verifier and resource. It rotates the same
            principal and does not trust external assertions or implement
            refresh_token.
    ConsoleKey:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: >-
        Existing manually created Console credential. It must already grant
        company.read and the operation's API or MCP channel. The empty OpenAPI
        security requirement array for this non-OAuth scheme is not a scope
        exemption. Auth0 account tokens are not accepted.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.