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/bamf-ai:bamf-ai-onboarding-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

openapi: 3.2.0
info:
  title: BAMF Developer Platform Onboarding API
  version: 0.1.0
servers:
- url: https://api.bamf.ai/v1
security:
- BearerAuth: []
tags:
- name: Onboarding
paths:
  /onboarding:
    get:
      summary: Get BAMF Bot onboarding status
      description: The same onboarding steps, order and progress as bamf.ai, with how an agent runs each step. Creates the caller's creator space on first use. Requires creator_spaces:read.
      parameters:
      - name: creator_id
        in: query
        required: false
        schema:
          type: string
        description: Defaults to the caller's own creator space.
      responses:
        '200':
          description: 'Onboarding status: ordered steps (same as bamf.ai), next step, time saved, verified rewards and web links.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericDataResponse'
      tags:
      - Onboarding
      operationId: getOnboarding
      x-operation-id-source: derived
  /onboarding/steps/{step}:
    post:
      summary: Finish or skip an onboarding step
      description: Saves the step outcome on the same record as the web onboarding, optionally with the person's answer and profile basics, then claims any server-verified activation rewards. Requires creator_spaces:read; profile edits need the creator's own account or creator_spaces:write.
      parameters:
      - name: step
        in: path
        required: true
        schema:
          type: string
        description: Step id from GET /onboarding (legacy aliases accepted).
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                creator_id:
                  type: string
                outcome:
                  type: string
                  enum:
                  - completed
                  - skipped
                  default: completed
                answer:
                  type: object
                  description: Small JSON object (8 KB max), saved under state.answers[step].
                profile:
                  type: object
                  properties:
                    name:
                      type: string
                    website_url:
                      type: string
                    linkedin_profile_url:
                      type: string
                    industry:
                      type: string
                    job_description:
                      type: string
                    bio:
                      type: string
                  additionalProperties: false
      responses:
        '200':
          description: 'Onboarding status: ordered steps (same as bamf.ai), next step, time saved, verified rewards and web links.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericDataResponse'
      tags:
      - Onboarding
      operationId: postOnboardingStepsByStep
      x-operation-id-source: derived
components:
  parameters:
    IdempotencyKey:
      name: IdempotencyKey
      in: query
      required: false
      schema:
        type: string
      description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
      x-ae-placeholder: true
  schemas:
    GenericDataResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JSONValue'
    JSONValue:
      description: Any JSON value returned by flexible workflow, analytics, context, or generation payloads.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer