> ## Documentation index
> Fetch the complete documentation index at: https://docs.rxresu.me/llms.txt
> Ask it with GET https://docs.rxresu.me/ask?q=<keywords or question>. Short keywords rank best.
> Use these to discover all available pages before exploring further.

# Check a resume address

> Checks whether a slug can be a resume's public address: lowercase letters and numbers in groups joined by single dashes, and not used by another of the user's resumes. When it can't, suggests one that works. Requires authentication.

`GET /resumes/{resumeId}/slug-availability`

## OpenAPI

````yaml spec.json get /resumes/{resumeId}/slug-availability
openapi: 3.1.1
info:
  title: Reactive Resume
  version: 6.0.7
  description: "Reactive Resume API. Mutations do not support Idempotency-Key. Do
    not automatically retry POST, PUT, PATCH or DELETE requests after a timeout:
    first read the resource to determine whether the operation succeeded.
    Existing enum values and response shapes are retained for compatibility."
  license:
    name: MIT
    url: https://github.com/reactive-resume/reactive-resume/blob/main/LICENSE
  contact:
    name: Amruth Pillai
    email: amruth@rxresu.me
    url: https://amruthpillai.com
servers:
  - url: https://rxresu.me/api/openapi
security:
  - apiKey: []
  - bearerAuth: []
  - cookieAuth: []
paths:
  /resumes/{resumeId}/slug-availability:
    get:
      operationId: getResumeSlugAvailability
      summary: Check a resume address
      description: "Checks whether a slug can be a resume's public address: lowercase
        letters and numbers in groups joined by single dashes, and not used by
        another of the user's resumes. When it can't, suggests one that works.
        Requires authentication."
      tags:
        - Resume Sharing
      parameters:
        - name: resumeId
          in: path
          required: true
          schema:
            type: string
            description: The ID of the resume the slug is for.
        - name: slug
          in: query
          required: true
          schema:
            type: string
            description: The slug to check.
          allowEmptyValue: true
          allowReserved: true
      responses:
        "200":
          description: Whether the slug is available, and a suggestion when it isn't.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    enum:
                      - available
                      - current
                      - invalid
                      - taken
                    type: string
                    description: "available: free to use. current: this resume's slug already.
                      invalid: not lowercase letters, numbers and single dashes.
                      taken: another of the user's resumes uses it."
                  takenBy:
                    type: string
                    description: The name of the resume that uses the slug, when taken.
                  suggestion:
                    type: string
                    description: A slug that would work instead.
                required:
                  - status
        default:
          description: Structured API error. See status and code; do not branch on message
            text.
          content:
            application/json:
              schema:
                type: object
                required:
                  - defined
                  - code
                  - status
                  - message
                properties:
                  defined:
                    type: boolean
                  code:
                    type: string
                  status:
                    type: integer
                  message:
                    type: string
                  data: {}
      security:
        - apiKey: []
        - bearerAuth: []
        - cookieAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: 'curl
            "https://rxresu.me/api/openapi/resumes/<resumeId>/slug-availability?slug=<slug>"
            --header "x-api-key: <api-key>"'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: An OAuth access token issued by this instance for its API/MCP resource.
    cookieAuth:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: Browser session (secure deployments use the __Secure- prefix).
        Cookie requests must originate from this instance.
    apiKey:
      type: apiKey
      name: x-api-key
      in: header
      description: The API key to authenticate requests.
````