> ## Documentation Index
> Fetch the complete documentation index at: https://docs.photon.codes/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code.
> Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer.
> For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them.
> The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes.

# Check project slug availability

> Check project slug availability: checkProjectSlugAvailability in the TypeScript, Python and Rust clients.

`GET /v1/organizations/{organizationId}/projects/slug-availability`

Reports whether createProject would accept `slug` right now. Advisory: only the create itself allocates, so a caller must still handle SLUG\_TAKEN. A malformed slug is rejected on shape; a reserved slug, a slug held by an active project, and a slug retired with a deleted project each answer `available: false` with a reason.

<Tabs>
  <Tab title="TypeScript">
    ```typescript TypeScript theme={null}
    photon.organizations.projects.checkProjectSlugAvailability(input: CheckProjectSlugAvailabilityInput, options?: RequestOptions): Promise<CheckProjectSlugAvailabilityOutput>
    ```
  </Tab>

  <Tab title="Python">
    ```python Python theme={null}
    photon.organizations.projects.check_project_slug_availability(input: CheckProjectSlugAvailabilityInput) -> models.CheckProjectSlugAvailabilityResponse
    ```
  </Tab>

  <Tab title="Rust">
    ```rust Rust theme={null}
    client.check_project_slug_availability(organization_id: String, slug: String).await -> Result<ResponseValue<types::CheckProjectSlugAvailabilityResponse>, Error<CheckProjectSlugAvailabilityError>>
    ```
  </Tab>
</Tabs>

<RequestExample>
  ```typescript TypeScript theme={null}
  import { Photon } from "@photon-ai/api";

  const photon = new Photon({
    headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
  });
  const result = await photon.organizations.projects.checkProjectSlugAvailability({
    path: {
      organizationId: "organizationId",
    },
    query: {
      slug: "slug",
    },
  });
  ```

  ```python Python theme={null}
  import os

  from photon_api import Photon
  from photon_api.rpc_generated import CheckProjectSlugAvailabilityInput

  photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
  result = photon.organizations.projects.check_project_slug_availability(
      CheckProjectSlugAvailabilityInput.model_validate({
          "path": {
              "organizationId": "organizationId",
          },
          "query": {
              "slug": "slug",
          },
      })
  )
  ```

  ```rust Rust theme={null}
  use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

  let token = std::env::var("PHOTON_API_TOKEN")?;
  let client = PhotonClientBuilder::new()
      .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
      .build()?;
  let result = client
      .check_project_slug_availability("organizationId".to_owned(), "slug".to_owned())
      .await
      .map_err(|error| format!("{error:?}"))?
      .into_inner();
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "available": true,
    "slug": "string"
  }
  ```
</ResponseExample>

## Parameters

<ParamField path="organizationId" type={"string"} required />

<ParamField query="slug" type={"string"} required />

## Returns

**`200`** Whether the slug can be allocated, and why not. CheckProjectSlugAvailabilityResponse

**One of: AvailableProjectSlug**

<ResponseField name="available" type={"true"} required />

<ResponseField name="slug" type={"string"} required />

**One of: UnavailableProjectSlug**

<ResponseField name="available" type={"false"} required />

<ResponseField name="reason" type={"UnavailableProjectSlugReason"} required />

<ResponseField name="slug" type={"string"} required />

<ResponseField name="suggestion" type={"string"} />


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.