Superposition Guides Set up your workspace, create a role, and run your first search. API

openapi: 3.1.0
info:
  title: Superposition Guides Set up your workspace, create a role, and run your first search. API
  version: '2026-10-29'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-29: 5 operation(s) read from 1 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/guides/integrations/ats
  x-docs-section: guides
servers:
- url: https://app.superposition.ai
paths:
  /api/v1/ats/connections/{connectionid}/runs:
    get:
      operationId: get_api_v1_ats_connections_connectionid_runs
      tags:
      - Api
      summary: GET /api/v1/ats/connections/{connectionId}/runs
      x-source: https://docs.superposition.ai/docs/guides/integrations/ats
      parameters:
      - name: connectionid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://app.superposition.ai/api/v1/ats/connections/CONNECTION_ID/runs  -H \"Authorization: Bearer $SUPERPOSITION_API_KEY\
          \ \" \n Copy Text # Preview, then map an ATS job to a Superposition job "
  /api/v1/ats/connections/{connectionid}/sync:
    post:
      operationId: post_api_v1_ats_connections_connectionid_sync
      tags:
      - Api
      summary: POST /api/v1/ats/connections/{connectionId}/sync
      x-source: https://docs.superposition.ai/docs/guides/integrations/ats
      parameters:
      - name: connectionid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://app.superposition.ai/api/v1/ats/connections/CONNECTION_ID/sync  -H "Authorization: Bearer $SUPERPOSITION_API_KEY
          " '
  /api/v1/ats/job-links/{linkid}:
    patch:
      operationId: patch_api_v1_ats_job_links_linkid
      tags:
      - Api
      summary: PATCH /api/v1/ats/job-links/{linkId}
      x-source: https://docs.superposition.ai/docs/guides/integrations/ats
      parameters:
      - name: linkid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiV1AtsJobLinksLinkidRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X PATCH https://app.superposition.ai/api/v1/ats/job-links/LINK_ID  -H \"Authorization: Bearer $SUPERPOSITION_API_KEY \"\
          \ -H \"Content-Type: application/json\"  -d '{\"jobId\":\"JOB_ID\",\"pushTrigger\":\"client_approved\"}' \n Copy Text # Push a candidate;\
          \ a repeat returns the current presence instead of a second create "
  /api/v1/ats/job-links/{linkid}/preview:
    post:
      operationId: post_api_v1_ats_job_links_linkid_preview
      tags:
      - Api
      summary: POST /api/v1/ats/job-links/{linkId}/preview
      x-source: https://docs.superposition.ai/docs/guides/integrations/ats
      parameters:
      - name: linkid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://app.superposition.ai/api/v1/ats/job-links/LINK_ID/preview  -H "Authorization: Bearer $SUPERPOSITION_API_KEY
          " '
  /api/v1/candidates/{candidateid}/ats-push:
    post:
      operationId: post_api_v1_candidates_candidateid_ats_push
      tags:
      - Api
      summary: POST /api/v1/candidates/{candidateId}/ats-push
      x-source: https://docs.superposition.ai/docs/guides/integrations/ats
      parameters:
      - name: candidateid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1CandidatesCandidateidAtsPushRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://app.superposition.ai/api/v1/candidates/CANDIDATE_ID/ats-push  -H \"Authorization: Bearer $SUPERPOSITION_API_KEY\
          \ \" -H \"Content-Type: application/json\"  -d '{\"stageId\":\"STAGE_ID\"}' \n Portal Copy Anchor Link \n Teams without a supported\
          \ ATS can keep using the submission portal: turn it on under the same\npage and paste your portal's submission URL. The URL must be\
          \ a public HTTPS add"
security:
- bearer: []
components:
  schemas:
    PatchApiV1AtsJobLinksLinkidRequest:
      type: object
      properties:
        jobId:
          type: string
        pushTrigger:
          type: string
    PostApiV1CandidatesCandidateidAtsPushRequest:
      type: object
      properties:
        stageId:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
tags:
- name: Api