Cast AI Onboarding API

openapi: 3.2.0
info:
  title: AI Enabler Onboarding API
  version: 0.0.1
  description: Provides an API for AI Enabler onboarding.
servers:
- url: https://api.cast.ai/
  description: US endpoint
- url: https://api.eu.cast.ai/
  description: EU endpoint
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: OnboardingAPI
  description: Provides an API for AI Enabler onboarding.
paths:
  /ai-optimizer/v1beta/organizations/{organizationId}/models-cache-script:
    get:
      tags:
      - OnboardingAPI
      summary: Get the models cache setup script
      description: 'Get the models cache setup script that can be used to configure models cache storage.


        The returned script can be run to set up storage buckets and service accounts for models cache.

        The script is idempotent and can be run multiple times.

        The script content depends on the provider type specified in the request.'
      operationId: OnboardingAPI_GetModelsCacheScript
      parameters:
      - name: organizationId
        in: path
        description: The ID of the Organization.
        required: true
        schema:
          type: string
      - name: provider
        in: query
        description: The storage provider type.
        schema:
          enum:
          - MODELS_CACHE_PROVIDER_UNSPECIFIED
          - GCS
          - S3
          type: string
          format: enum
      responses:
        '200':
          description: OK
          content:
            '*/*': {}
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /ai-optimizer/v1beta/organizations/{organizationId}/models-caches:
    post:
      tags:
      - OnboardingAPI
      summary: Register models cache storage configuration for a cloud provider location
      description: Register models cache storage configuration for a cluster.
      operationId: OnboardingAPI_RegisterModelsCache
      parameters:
      - name: organizationId
        in: path
        description: The ID of the Organization.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterModelsCacheRequest'
        required: true
      responses:
        '200':
          description: OK
          content: {}
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /ai-optimizer/v1beta/organizations/{organizationId}/models-caches:check:
    post:
      tags:
      - OnboardingAPI
      summary: Check if models cache is registered and functional
      description: Check if models cache is registered and functional for the given organization, provider and location.
      operationId: OnboardingAPI_CheckModelsCache
      parameters:
      - name: organizationId
        in: path
        description: The ID of the Organization.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckModelsCacheRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckModelsCacheResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /ai-optimizer/v1beta/organizations/{organizationId}/onboarding-command:
    get:
      tags:
      - OnboardingAPI
      summary: Get the onboarding command
      description: Get onboarding command that can be executed in the terminal to onboard the cluster.
      operationId: OnboardingAPI_GetOnboardingCommand
      parameters:
      - name: organizationId
        in: path
        description: The ID of the Organization.
        required: true
        schema:
          type: string
      - name: provider
        in: query
        description: The cloud provider.
        schema:
          enum:
          - PROVIDER_UNSPECIFIED
          - EKS
          - GKE
          - AKS
          - OPENSHIFT
          - KOPS
          type: string
          format: enum
      - name: installUmbrella
        in: query
        description: Whether to install components via the castai umbrella Helm chart instead of individual charts.
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingCommand'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /ai-optimizer/v1beta/organizations/{organizationId}/onboarding-script:
    get:
      tags:
      - OnboardingAPI
      summary: Get the onboarding script
      description: 'Get the onboarding script that can be used to onboard the cluster.


        The returned script can be run in the terminal to onboard the cluster to Phase 2.

        The installation contains the core Phase 2 components as well as the AI Optimizer Proxy component.

        The script is idempotent and can be run multiple times to update the existing components.

        The script will automatically discover all the cluster properties required for onboarding.'
      operationId: OnboardingAPI_GetOnboardingScript
      parameters:
      - name: organizationId
        in: path
        description: The ID of the Organization.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*': {}
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /ai-optimizer/v1beta/organizations/{organizationId}/onboarding-status:
    get:
      tags:
      - OnboardingAPI
      summary: Get onboarding status for the organization
      description: GetOnboardingStatus returns whether the organization has ever sent chat completions.
      operationId: OnboardingAPI_GetOnboardingStatus
      parameters:
      - name: organizationId
        in: path
        description: The ID of the Organization.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingStatus'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /ai-optimizer/v1beta/setup-scripts/{id}:
    get:
      tags:
      - OnboardingAPI
      summary: Get the setup script for a specific integration
      description: 'Get the setup script for a specific integration.


        Returns a shell script that can be run in the terminal to configure the specified

        integration to use AI Enabler as a proxy.

        Supported scripts:

        - claude-code

        - upgrade-ai-optimizer-proxy'
      operationId: OnboardingAPI_GetSetupScript
      parameters:
      - name: id
        in: path
        description: The setup script identifier (e.g., "claude-code").
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*': {}
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
components:
  schemas:
    Status:
      type: object
      properties:
        code:
          type: integer
          description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
          format: int32
        message:
          type: string
          description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/GoogleProtobufAny'
          description: A list of messages that carry the error details.  There is a common set of message types for APIs to use.
      description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
    RegisterModelsCacheRequest:
      required:
      - organizationId
      - provider
      type: object
      properties:
        organizationId:
          type: string
          description: The ID of the Organization.
        provider:
          enum:
          - MODELS_CACHE_PROVIDER_UNSPECIFIED
          - GCS
          - S3
          type: string
          description: The storage provider type.
          format: enum
        credentials:
          type: string
          description: The JSON encoded credentials for accessing the storage
        gcs:
          allOf:
          - $ref: '#/components/schemas/ModelsCacheGcsConfig'
          description: Google Cloud Storage configuration
        s3:
          allOf:
          - $ref: '#/components/schemas/ModelsCacheS3Config'
          description: AWS S3 configuration
      description: Request for registering models cache.
    CheckModelsCacheRequest:
      required:
      - organizationId
      - provider
      - location
      type: object
      properties:
        organizationId:
          type: string
          description: The ID of the Organization.
        provider:
          enum:
          - MODELS_CACHE_PROVIDER_UNSPECIFIED
          - GCS
          - S3
          type: string
          description: The storage provider type.
          format: enum
        location:
          type: string
          description: The storage location.
      description: Request for checking models cache status.
    OnboardingStatus:
      required:
      - onboarded
      type: object
      properties:
        onboarded:
          type: boolean
          description: True if the organization has ever sent any chat completions.
      description: Onboarding status of the organization.
    ModelsCacheGcsConfig:
      required:
      - bucket
      - location
      type: object
      properties:
        bucket:
          type: string
          description: GCS bucket name (required)
        location:
          type: string
          description: The location of the storage bucket
      description: Configuration for Google Cloud Storage provider
    OnboardingCommand:
      required:
      - command
      type: object
      properties:
        command:
          type: string
          description: The onboarding command.
      description: The onboarding command.
    CheckModelsCacheResponse:
      type: object
      properties:
        available:
          type: boolean
          description: Whether the models cache is available and functional (registered with valid credentials and accessible bucket).
        errorMessage:
          type: string
          description: Optional error message if the cache is not available.
      description: Response for checking models cache status.
    ModelsCacheS3Config:
      required:
      - bucket
      - region
      type: object
      properties:
        bucket:
          type: string
          description: S3 bucket name (required)
        region:
          type: string
          description: The AWS region of the S3 bucket
      description: Configuration for AWS S3 provider
    GoogleProtobufAny:
      type: object
      properties:
        '@type':
          type: string
          description: The type of the serialized message.
      additionalProperties: true
      description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
x-provenance:
  method: searched
  source: https://docs.cast.ai/reference
  harvested: '2026-10-20'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.cast.ai/reference/analyticsapi_generateanalytics.md
  - https://docs.cast.ai/reference/analyticsapi_generatebillingmodelusagereport.md
  - https://docs.cast.ai/reference/analyticsapi_generatebreakdown.md
  - https://docs.cast.ai/reference/analyticsapi_generatelatestchatcompletionsummary.md
  - https://docs.cast.ai/reference/analyticsapi_generatelatestevaluationsummary.md
  - https://docs.cast.ai/reference/analyticsapi_generatelatestinferencesummaries.md
  - https://docs.cast.ai/reference/analyticsapi_generaterouterreport.md
  - https://docs.cast.ai/reference/analyticsapi_queryanalytics.md
  - https://docs.cast.ai/reference/apikeysapi_createapikey.md
  - https://docs.cast.ai/reference/apikeysapi_deleteapikeybudget.md
  - https://docs.cast.ai/reference/apikeysapi_deleteorganizationbudget.md
  - https://docs.cast.ai/reference/apikeysapi_deleteteambudget.md
  - https://docs.cast.ai/reference/apikeysapi_deleteuserbudget.md
  - https://docs.cast.ai/reference/apikeysapi_getapikeybudget.md
  - https://docs.cast.ai/reference/apikeysapi_getbudgetoverview.md
  - https://docs.cast.ai/reference/apikeysapi_getorganizationbudget.md
  - https://docs.cast.ai/reference/apikeysapi_getteambudget.md
  - https://docs.cast.ai/reference/apikeysapi_getuserbudget.md
  - https://docs.cast.ai/reference/apikeysapi_getuserbudgetstatus.md
  - https://docs.cast.ai/reference/apikeysapi_listapikeybudgets.md
  - https://docs.cast.ai/reference/apikeysapi_listorganizationbudgets.md
  - https://docs.cast.ai/reference/apikeysapi_listteambudgets.md
  - https://docs.cast.ai/reference/apikeysapi_listuserbudgets.md
  - https://docs.cast.ai/reference/apikeysapi_updateapikeybudget.md
  - https://docs.cast.ai/reference/apikeysapi_updateorganizationbudget.md
  - https://docs.cast.ai/reference/apikeysapi_updateteambudget.md
  - https://docs.cast.ai/reference/apikeysapi_updateuserbudget.md
  - https://docs.cast.ai/reference/apikeysapi_verifyapikey.md
  - https://docs.cast.ai/reference/apikeysapi_verifyinference.md
  - https://docs.cast.ai/reference/authorizeapi_authorizeaction.md
  - https://docs.cast.ai/reference/batchapi_cancelbatch.md
  - https://docs.cast.ai/reference/batchapi_createbatch.md
  - https://docs.cast.ai/reference/batchapi_getbatch.md
  - https://docs.cast.ai/reference/batchapi_listbatches.md
  - https://docs.cast.ai/reference/batchapi_reportbatcherror.md
  - https://docs.cast.ai/reference/batchapi_updatebatch.md
  - https://docs.cast.ai/reference/componentsapi_listcomponents.md
  - https://docs.cast.ai/reference/couponsapi_listredeemedcoupons.md
  - https://docs.cast.ai/reference/couponsapi_redeemcoupon.md
  - https://docs.cast.ai/reference/couponsapi_validatecoupon.md
  - https://docs.cast.ai/reference/embeddingsapi_createclusterembedding.md
  - https://docs.cast.ai/reference/embeddingsapi_createembedding.md
  - https://docs.cast.ai/reference/evaluationsapi_createclusterevaluation.md
  - https://docs.cast.ai/reference/evaluationsapi_createevaluation.md
  - https://docs.cast.ai/reference/hostedmodeleventsapi_listhostedmodelevents.md
  - https://docs.cast.ai/reference/hostedmodelsapi_createhostedmodel.md
  - https://docs.cast.ai/reference/hostedmodelsapi_deletehostedmodel.md
  - https://docs.cast.ai/reference/hostedmodelsapi_gethostedmodelpods.md
  - https://docs.cast.ai/reference/hostedmodelsapi_listhostedmodels.md
  - https://docs.cast.ai/reference/hostedmodelsapi_scalehostedmodel.md
  - https://docs.cast.ai/reference/hostedmodelsapi_updatehostedmodel.md
  - https://docs.cast.ai/reference/llmrequestsapi_listllmrequests.md
  - https://docs.cast.ai/reference/marketingapi_handlehubspotwebhook.md
  - https://docs.cast.ai/reference/mcpgatewayadminapi_createmcpconnection.md
  - https://docs.cast.ai/reference/mcpgatewayadminapi_deletemcpconnection.md
  - https://docs.cast.ai/reference/mcpgatewayadminapi_getmcpconnection.md
  - https://docs.cast.ai/reference/mcpgatewayadminapi_listmcpconnections.md
  - https://docs.cast.ai/reference/mcpgatewayadminapi_updatemcpconnection.md
  - https://docs.cast.ai/reference/modelaccessapi_getmodelaccesscatalog.md
  - https://docs.cast.ai/reference/modelaccessapi_getorganizationmodelaccess.md
  - https://docs.cast.ai/reference/modelaccessapi_getteammodelaccess.md
  - https://docs.cast.ai/reference/modelaccessapi_listteammodelaccess.md
  - https://docs.cast.ai/reference/modelaccessapi_updateorganizationmodelaccess.md
  - https://docs.cast.ai/reference/modelaccessapi_updateteammodelaccess.md
  - https://docs.cast.ai/reference/modelregistriesapi_createmodelregistry.md
  - https://docs.cast.ai/reference/modelregistriesapi_deletemodelregistry.md
  - https://docs.cast.ai/reference/modelregistriesapi_getmodelregistry.md
  - https://docs.cast.ai/reference/modelregistriesapi_getonboardingcommand.md
  - https://docs.cast.ai/reference/modelregistriesapi_getonboardingscript.md
  - https://docs.cast.ai/reference/modelregistriesapi_listmodelregistries.md
  - https://docs.cast.ai/reference/modelregistriesapi_listmodelregistrydirectories.md
  - https://docs.cast.ai/reference/modelspecsapi_createmodelspecs.md
  - https://docs.cast.ai/reference/modelspecsapi_deletemodelspecs.md
  - https://docs.cast.ai/reference/modelspecsapi_getmodelspecs.md
  - https://docs.cast.ai/reference/modelspecsapi_listmodelspecs.md
  - https://docs.cast.ai/reference/oauthappsapi_completeoauthlogin.md
  - https://docs.cast.ai/reference/oauthappsapi_createoauthapp.md
  - https://docs.cast.ai/reference/oauthappsapi_deleteoauthapp.md
  - https://docs.cast.ai/reference/oauthappsapi_disconnectoauthapp.md
  - https://docs.cast.ai/reference/oauthappsapi_getoauthapp.md
  - https://docs.cast.ai/reference/oauthappsapi_listoauthapps.md
  - https://docs.cast.ai/reference/oauthappsapi_registerdiscoveredoauthapp.md
  - https://docs.cast.ai/reference/oauthappsapi_startoauthlogin.md
  - https://docs.cast.ai/reference/oauthappsapi_updateoauthapp.md
  - https://docs.cast.ai/reference/onboardingapi_checkmodelscache.md
  - https://docs.cast.ai/reference/onboardingapi_getmodelscachescript.md
  - https://docs.cast.ai/reference/onboardingapi_getonboardingcommand.md
  - https://docs.cast.ai/reference/onboardingapi_getonboardingscript.md
  - https://docs.cast.ai/reference/onboardingapi_getonboardingstatus.md
  - https://docs.cast.ai/reference/onboardingapi_getsetupscript.md
  - https://docs.cast.ai/reference/onboardingapi_registermodelscache.md
  - https://docs.cast.ai/reference/otelapi_generateproductivitymetricstimeseries.md
  - https://docs.cast.ai/reference/otelapi_getproductivitymetrics.md
  - https://docs.cast.ai/reference/otelapi_ingestlogs.md
  - https://docs.cast.ai/reference/otelapi_ingestmetrics.md
  - https://docs.cast.ai/reference/playgroundchatcompletionsapi_streamplaygroundchatcompletion.md
  - https://docs.cast.ai/reference/policiesapi_createpolicy.md
  - https://docs.cast.ai/reference/policiesapi_deletepolicy.md
  - https://docs.cast.ai/reference/policiesapi_getpolicy.md
  - https://docs.cast.ai/reference/policiesapi_listpolicies.md
  - https://docs.cast.ai/reference/policiesapi_listpolicyversions.md
  - https://docs.cast.ai/reference/policiesapi_rollbackpolicy.md
  - https://docs.cast.ai/reference/policiesapi_syncpolicies.md
  - https://docs.cast.ai/reference/policiesapi_updatepolicy.md
  - https://docs.cast.ai/reference/prcostsapi_queryprcosts.md
  - https://docs.cast.ai/reference/prcostsapi_reportprcosts.md
  - https://docs.cast.ai/reference/quotaapi_deleteuserquotapolicy.md
  - https://docs.cast.ai/reference/quotaapi_getorgquotapolicy.md
  - https://docs.cast.ai/reference/quotaapi_getquotadefaults.md
  - https://docs.cast.ai/reference/quotaapi_getquotalimits.md
  - https://docs.cast.ai/reference/quotaapi_getquotausage.md
  - https://docs.cast.ai/reference/quotaapi_getuserquotapolicy.md
  - https://docs.cast.ai/reference/quotaapi_updateorgquotapolicy.md
  - https://docs.cast.ai/reference/quotaapi_updateuserquotapolicy.md
  - https://docs.cast.ai/reference/rerankingsapi_createclusterreranking.md
  - https://docs.cast.ai/reference/rerankingsapi_createreranking.md
  - https://docs.cast.ai/reference/secretsapi_createsecret.md
  - https://docs.cast.ai/reference/secretsapi_deletesecret.md
  - https://docs.cast.ai/reference/secretsapi_getsecret.md
  - https://docs.cast.ai/reference/secretsapi_listsecrets.md
  - https://docs.cast.ai/reference/secretsapi_setsecretmappings.md
  - https://docs.cast.ai/reference/secretsapi_updatesecret.md
  - https://docs.cast.ai/reference/sessionsapi_deletesession.md
  - https://docs.cast.ai/reference/sessionsapi_getsession.md
  - https://docs.cast.ai/reference/sessionsapi_listsessions.md
  - https://docs.cast.ai/reference/sessionsapi_resumesession.md
  - https://docs.cast.ai/reference/sessionsapi_suspendsession.md
  - https://docs.cast.ai/reference/sessionsapi_upsertsession.md
  - https://docs.cast.ai/reference/settingsapi_deleteapikeysettings.md
  - https://docs.cast.ai/reference/settingsapi_deleteteamsettings.md
  - https://docs.cast.ai/reference/settingsapi_getapikeysettings.md
  - https://docs.cast.ai/reference/settingsapi_getsettings.md
  - https://docs.cast.ai/reference/settingsapi_getteamsettings.md
  - https://docs.cast.ai/reference/settingsapi_listapikeysettings.md
  - https://docs.cast.ai/reference/settingsapi_listteamsettings.md
  - https://docs.cast.ai/reference/settingsapi_resolvesettings.md
  - https://docs.cast.ai/reference/settingsapi_updatesettings.md
  - https://docs.cast.ai/reference/settingsapi_updateteamsettings.md
  - https://docs.cast.ai/reference/settingsapi_upsertapikeysettings.md
  - https://docs.cast.ai/reference/subscriptionsapi_checkoutsubscription.md
  - https://docs.cast.ai/reference/subscriptionsapi_getplanpricepreview.md
  - https://docs.cast.ai/reference/subscriptionsapi_getsubscription.md
  - https://docs.cast.ai/reference/subscriptionsapi_handlewebhook.md
  - https://docs.cast.ai/reference/subscriptionsapi_managesubscription.md
  - https://docs.cast.ai/reference/surveysapi_getsurveystatus.md
  - https://docs.cast.ai/reference/surveysapi_updatesurveystatus.md
  - https://docs.cast.ai/reference/tagsapi_searchkeys.md
  - https://docs.cast.ai/reference/tagsapi_searchtags.md
  - https://docs.cast.ai/reference/tagsapi_searchvalues.md
  - https://docs.cast.ai/reference/teamsapi_addteammembers.md
  - https://docs.cast.ai/reference/teamsapi_createteam.md
  - https://docs.cast.ai/reference/teamsapi_deleteteam.md
  - https://docs.cast.ai/reference/teamsapi_getteam.md
  - https://docs.cast.ai/reference/teamsapi_listteammembers.md
  - https://docs.cast.ai/reference/teamsapi_listteams.md
  - https://docs.cast.ai/reference/teamsapi_removeteammember.md
  - https://docs.cast.ai/reference/teamsapi_updateteam.md
  - https://docs.cast.ai/reference/topupapi_listtopuppurchases.md
  - https://docs.cast.ai/reference/topupapi_purchasetopup.md
  - https://docs.cast.ai/reference/workspacesapi_createworkspace.md
  - https://docs.cast.ai/reference/workspacesapi_deleteworkspace.md
  - https://docs.cast.ai/reference/workspacesapi_getsecretmappings.md
  - https://docs.cast.ai/reference/workspacesapi_getworkspace.md
  - https://docs.cast.ai/reference/workspacesapi_getworkspacecost.md
  - https://docs.cast.ai/reference/workspacesapi_getworkspacecostprices.md
  - https://docs.cast.ai/reference/workspacesapi_getworkspacecostreport.md
  - https://docs.cast.ai/reference/workspacesapi_listworkspaces.md
  - https://docs.cast.ai/reference/workspacesapi_resumeworkspace.md
  - https://docs.cast.ai/reference/workspacesapi_suspendworkspace.md
  - https://docs.cast.ai/reference/workspacesapi_upsertworkspace.md
  - https://docs.cast.ai/reference/workspacesessionsapi_listworkspacesessions.md
  - https://docs.cast.ai/reference/workspacetemplatesapi_createworkspacetemplate.md
  - https://docs.cast.ai/reference/workspacetemplatesapi_deleteworkspacetemplate.md
  - https://docs.cast.ai/reference/workspacetemplatesapi_getworkspacetemplate.md
  - https://docs.cast.ai/reference/workspacetemplatesapi_listworkspacetemplates.md
  - https://docs.cast.ai/reference/workspacetemplatesapi_updateworkspacetemplate.md
  - https://docs.cast.ai/reference/workspacetokensapi_exchangeworkspacetoken.md
  - https://docs.cast.ai/reference/workspacetokensapi_keyverify.md
  merge:
    pages: 178
    deduped: 1003
    conflicts_kept_first: 0