Superposition API Reference Authenticate and integrate with the Superposition API. API

openapi: 3.1.0
info:
  title: Superposition API Reference Authenticate and integrate with the Superposition API. API
  version: '2026-10-29'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-29: 7 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Superposition has published no machine-readable contract that
    the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 26
    documentation: 17
    pages-with-code: 38
    pages-read: 39
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-29'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.superposition.ai/docs/api/createPublicBooking
  - https://docs.superposition.ai/docs/api/getPublicAvailability
  - https://docs.superposition.ai/docs/api/listPublicJobs
  - https://docs.superposition.ai/docs/api/rate-limits
  - https://docs.superposition.ai/docs/api/scopes
  - https://docs.superposition.ai/docs/api/updateAtsConnection
  x-docs-section: api
servers:
- url: https://app.superposition.ai
paths:
  /api/v1/agent/invoke:
    post:
      operationId: post_api_v1_agent_invoke
      tags:
      - Api
      summary: POST /api/v1/agent/invoke
      x-source: https://docs.superposition.ai/docs/api/rate-limits
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1AgentInvokeRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1AgentInvokeResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://app.superposition.ai/api/v1/agent/invoke  -H \"Authorization: Bearer $SUPERPOSITION_API_KEY \"  -H \"Idempotency-Key:\
          \ 8f31c0a4-...\"  -H \"Content-Type: application/json\"  -d '{\"prompt\": \"How many candidates are awaiting review?\"}' \n A repeat\
          \ of the same key returns the original result instead of running the agent again. Use a\nfresh key per logical request and reuse it\
          \ across retri"
  /api/v1/agent/sessions/{sessionid}:
    get:
      operationId: get_api_v1_agent_sessions_sessionid
      tags:
      - Api
      summary: Get a session transcript
      x-source: https://docs.superposition.ai/docs/api/rate-limits
      parameters:
      - name: sessionid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/scopes:
    get:
      operationId: get_api_v1_scopes
      tags:
      - Api
      summary: Fetch the catalogue of scopes as JSON.
      x-source: https://docs.superposition.ai/docs/api/scopes
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1ScopesResponse'
      x-evidence:
        kind: documentation
  /ats/connections/string:
    patch:
      operationId: patch_ats_connections_string
      tags:
      - Ats
      summary: PATCH /ats/connections/string
      x-source: https://docs.superposition.ai/docs/api/updateAtsConnection
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchAtsConnectionsStringResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl JavaScript Go Python Java C# Rust Copy Text curl -X PATCH "https://example.com/ats/connections/string" \ -H "Content-Type:
          application/json" \ -d ''{}'' 200 400 401 403 404 Copy Text { "connection": { "id": "string", "integrationSlug": "string", "integrationName":
          "string", "status": "pending", "protectionTailDays": 0, "outreachPausedUntil": "2019-08-24T14:15:22Z", "logInterviewsEnabled": true,'
  /scheduling/string/string/availability:
    get:
      operationId: get_scheduling_string_string_availability
      tags:
      - Scheduling
      summary: GET /scheduling/string/string/availability
      x-source: https://docs.superposition.ai/docs/api/getPublicAvailability
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSchedulingStringStringAvailabilityResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl JavaScript Go Python Java C# Rust Copy Text curl -X GET "https://example.com/scheduling/string/string/availability" 200
          404 429 Copy Text { "data": { "slots": [ { "start": "2019-08-24T14:15:22Z", "end": "2019-08-24T14:15:22Z" } ] } } Last updated on List
          jobs Previous Page Book an interview slot Next Page'
  /scheduling/string/string/bookings:
    post:
      operationId: post_scheduling_string_string_bookings
      tags:
      - Scheduling
      summary: POST /scheduling/string/string/bookings
      x-source: https://docs.superposition.ai/docs/api/createPublicBooking
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSchedulingStringStringBookingsRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostSchedulingStringStringBookingsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl JavaScript Go Python Java C# Rust Copy Text curl -X POST "https://example.com/scheduling/string/string/bookings" \ -H "Content-Type:
          application/json" \ -d ''{ "email": "user@example.com", "slotStart": "2019-08-24T14:15:22Z" }'' 200 400 404 409 429 Copy Text { "data":
          { "confirmed": true } } Last updated on Get interview availability Previous Page email * string The candidate''s email. The join '
  /v1/jobs:
    get:
      operationId: get_v1_jobs
      tags:
      - Jobs
      summary: GET /v1/jobs
      x-source: https://docs.superposition.ai/docs/api/listPublicJobs
      parameters:
      - name: companyId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1JobsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl JavaScript Go Python Java C# Rust Copy Text curl -X GET "https://example.com/v1/jobs?companyId=string" 200 400 500 Copy
          Text { "data": [ { "id": "string", "title": "string", "department": "string", "location": "string", "compensationRange": "string", "equityRange":
          "string", "url": "string", "postedAt": "2019-08-24T14:15:22Z" } ] } Last updated on Read the audit log Previous Page Get intervie'
security:
- bearer: []
components:
  schemas:
    PostApiV1AgentInvokeRequest:
      type: object
      properties:
        prompt:
          type: string
    PostApiV1AgentInvokeResponse:
      type: object
      properties:
        sessionId:
          type: string
        reply:
          type: string
        status:
          type: string
        idempotentReplay:
          type: boolean
    GetApiV1ScopesResponse:
      type: object
      properties:
        scopes:
          type: array
          description: List of available scopes in the catalogue
    PatchAtsConnectionsStringResponse:
      type: object
      properties:
        connection:
          type: object
          properties:
            id:
              type: string
            integrationSlug:
              type: string
            integrationName:
              type: string
            status:
              type: string
            protectionTailDays:
              type: integer
            outreachPausedUntil:
              type: string
              format: date-time
            logInterviewsEnabled:
              type: boolean
            logScorecardsEnabled:
              type: boolean
            syncStageMovesEnabled:
              type: boolean
            initialSyncCompletedAt:
              type: string
              format: date-time
    GetSchedulingStringStringAvailabilityResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            slots:
              type: array
              items:
                type: object
                properties:
                  start:
                    type: string
                    format: date-time
                  end:
                    type: string
                    format: date-time
    PostSchedulingStringStringBookingsRequest:
      type: object
      properties:
        email:
          type: string
        slotStart:
          type: string
          format: date-time
    PostSchedulingStringStringBookingsResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            confirmed:
              type: boolean
    GetV1JobsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              title:
                type: string
              department:
                type: string
              location:
                type: string
              compensationRange:
                type: string
              equityRange:
                type: string
              url:
                type: string
              postedAt:
                type: string
                format: date-time
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
tags:
- name: Api
- name: Ats
- name: Jobs
- name: Scheduling