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

**Canonical:** https://apis.io/apis/superposition/guides-api/  
**Provider:** Superposition — https://apis.io/providers/superposition/  
**Base URL:** https://app.superposition.ai  
**Documentation:** https://docs.superposition.ai/docs/guides

Superposition Guides Set up your workspace, create a role, and run your first search. API is one of 4 APIs that [Superposition](https://apis.io/providers/superposition/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 2 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 2 JSON Schemas.

Superposition Guides Set up your workspace, create a role, and run your first search. API as documented publicly: 5 operations. Contract generated from the documentation by API Evangelist (2026-10-29); not the provider's own document.

## Operations (5)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/ats/connections/{connectionid}/runs` | GET /api/v1/ats/connections/{connectionId}/runs |
| POST | `/api/v1/ats/connections/{connectionid}/sync` | POST /api/v1/ats/connections/{connectionId}/sync |
| PATCH | `/api/v1/ats/job-links/{linkid}` | PATCH /api/v1/ats/job-links/{linkId} |
| POST | `/api/v1/ats/job-links/{linkid}/preview` | POST /api/v1/ats/job-links/{linkId}/preview |
| POST | `/api/v1/candidates/{candidateid}/ats-push` | POST /api/v1/candidates/{candidateId}/ats-push |

## Machine-readable artifacts (3)

- **OpenAPI** — https://artifacts.apis.io/superposition/openapi/_ae-authored/superposition-guides-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/superposition/json-schema/superposition-patch-api-v1-ats-job-links-linkid-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/superposition/json-schema/superposition-post-api-v1-candidates-candidateid-ats-push-request-schema.json

## Other Superposition APIs (3)

- [Superposition API](https://apis.io/apis/superposition/superposition-api/)
- [Superposition API Reference Authenticate and integrate with the Superposition API. API](https://apis.io/apis/superposition/api-api/)
- [Superposition core API](https://apis.io/apis/superposition/core-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/superposition/guides-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/superposition/.