Archestra AI

Archestra AI Onboarding API

The Onboarding API from Archestra AI — 4 operation(s) for onboarding.

GitHub OpenAPI

Operations 5

GET /api/onboarding/seen-nav-items Get onboarding seen nav items #
POST /api/onboarding/seen-nav-items Mark onboarding nav items seen #
GET /api/onboarding/survey-eligibility Get onboarding survey eligibility #
POST /api/onboarding/survey Submit onboarding survey #
GET /api/onboarding/feedback-popup-activation Get feedback popup activation #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/archestra/openapi/archestra-onboarding-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-gemini-generate-content-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-gemini-generate-content-request-input-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-minimax-chat-completion-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-minimax-chat-completion-request-input-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-openrouter-chat-completion-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/archestra/json-schema/archestra-perplexity-chat-completion-request-schema.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/archestra:archestra-onboarding-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

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

OpenAPI Specification

archestra-onboarding-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Archestra Onboarding API
  version: 1.4.0-rc.47
tags:
- name: Onboarding
paths:
  /api/onboarding/seen-nav-items:
    get:
      operationId: getOnboardingSeenNavItems
      tags:
      - Onboarding
      description: 'Get the onboarding nav items (red-dot nudges) the current user has already visited


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        None (no additional RBAC permission required)'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: string
                required:
                - items
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: none
        note: None (no additional RBAC permission required)
        permissions: []
      summary: Get onboarding seen nav items
      x-summary-source: derived
    post:
      operationId: markOnboardingNavItemsSeen
      tags:
      - Onboarding
      description: 'Mark onboarding nav items (red-dot nudges) as visited for the current user; idempotent


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        None (no additional RBAC permission required)'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                items:
                  minItems: 1
                  maxItems: 50
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 128
              required:
              - items
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: string
                required:
                - items
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: none
        note: None (no additional RBAC permission required)
        permissions: []
      summary: Mark onboarding nav items seen
      x-summary-source: derived
  /api/onboarding/survey-eligibility:
    get:
      operationId: getOnboardingSurveyEligibility
      tags:
      - Onboarding
      description: 'Whether the first-login onboarding survey should be shown: unlicensed instance, no LLM/MCP activity yet, not already submitted for the organization


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:update`: Change organization settings, messaging channels, and site notifications'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  eligible:
                    type: boolean
                required:
                - eligible
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:update
      summary: Get onboarding survey eligibility
      x-summary-source: derived
  /api/onboarding/survey:
    post:
      operationId: submitOnboardingSurvey
      tags:
      - Onboarding
      description: 'Submit the first-login onboarding survey; forwarded to the website and recorded once per organization


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:update`: Change organization settings, messaging channels, and site notifications'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                role:
                  type: string
                  minLength: 1
                  maxLength: 200
                workEnvironment:
                  type: string
                  minLength: 1
                  maxLength: 200
                referralSource:
                  type: string
                  minLength: 1
                  maxLength: 200
                workEmail:
                  type: string
                  maxLength: 320
                  format: email
                  pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
              required:
              - role
              - workEnvironment
              - referralSource
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                    - true
                required:
                - ok
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:update
      summary: Submit onboarding survey
      x-summary-source: derived
  /api/onboarding/feedback-popup-activation:
    get:
      operationId: getFeedbackPopupActivation
      tags:
      - Onboarding
      description: 'When the instance got activated for the feedback pop-up: an MCP server connected AND a successful tool call routed. Null until both happened, and always null on enterprise-licensed instances.


        Authentication:


        Required. Use an authenticated browser session or send your Archestra API key in the `Authorization` header.


        Authorization:


        `organizationSettings:update`: Change organization settings, messaging channels, and site notifications'
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  activatedAt:
                    type:
                    - string
                    - 'null'
                    format: date-time
                    pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                required:
                - activatedAt
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_validation_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authentication_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_authorization_error
                      internal_code:
                        type: string
                      details:
                        type: object
                        additionalProperties: {}
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_not_found_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_conflict_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      type:
                        type: string
                        enum:
                        - api_internal_server_error
                      internal_code:
                        type: string
                    required:
                    - message
                    - type
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
      x-required-permissions:
        kind: static
        permissions:
        - organizationSettings:update
      summary: Get feedback popup activation
      x-summary-source: derived