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

# Get workspace details

> Returns details of a specific workspace.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/workspaces/{id}
openapi: 3.0.3
info:
  description: >
    The Semji API lets you integrate Semji's AI-powered Content Marketing
    platform into your own tools and workflows. Scale your organic and AI
    visibility programmatically.


    ## Authentication


    All endpoints require a Bearer API key. Generate one from **Settings > API
    Keys** in the Semji app. Each key is scoped to a single user and
    organization.


    ```

    Authorization: Bearer sk_your_api_key_here

    ```


    ## Rate Limiting


    Requests are rate-limited per API key: **1,000 requests per hour**. Rate
    limit headers are included in every response:


    - `X-RateLimit-Limit` — Maximum requests per window

    - `X-RateLimit-Remaining` — Requests remaining

    - `X-RateLimit-Reset` — Seconds until the window resets


    ## Response Format


    All responses return JSON. Collections use a standard envelope:


    ```json

    {
      "data": [...],
      "pagination": { "total": 42, "page": 1, "limit": 25, "hasMore": true }
    }

    ```


    Errors follow a consistent format:


    ```json

    {
      "error": { "code": "not_found", "message": "The requested resource was not found." }
    }

    ```


    ## Core Concepts


    - **Workspace** — A single website you track. Contains pages, contents,
    keywords, and all related analysis data.

    - **Page** — A URL on your website that Semji monitors. Pages are the anchor
    for keywords and content drafts.

    - **Content** — An SEO-optimized article linked to a page. Drafts evolve
    through workflow statuses toward publication.

    - **Content Score** — A 0–100 score measuring how well your content follows
    Semji's SEO recommendations. Aim for 75+ before publishing.

    - **Keyword** — A search term tracked for a page. Analyzing a keyword
    produces SERP-based recommendations (topics, questions, search intents,
    links).

    - **Prompt** — A question users ask AI engines (ChatGPT, Google AI
    Overviews). Analyzing a prompt reveals how to optimize your content for AI
    citations.

    - **Atomic Content** — AI-powered content generation that produces a
    complete SEO-optimized article in one step.
  title: Semji API
  version: 1.0.0
servers: []
security:
  - apiKey: []
tags:
  - description: >-
      Retrieve the authenticated user and their organization, including
      remaining credit balances.
    name: Me
  - description: >-
      List members of the organization linked to the API key, with their roles
      (Admin or Member).
    name: Users
  - description: >-
      A workspace represents a single website you track in Semji. Each workspace
      has its own pages, contents, keywords, folders, and workflow statuses. Use
      these endpoints to list workspaces, view members, and access
      workspace-level configuration.
    name: Workspaces
  - description: >-
      Organize your content into a hierarchical folder structure within a
      workspace. Folders are returned as a flat list — reconstruct the tree
      client-side using `parentFolderId`.
    name: Folders
  - description: >-
      Pages are URLs on your website that Semji tracks for SEO performance.
      Import a URL to start monitoring it, trigger a crawl to fetch its
      metadata, and associate keywords for analysis. Each page can have content
      drafts attached.
    name: Pages
  - description: >-
      Contents are SEO-optimized articles managed through Semji. Create drafts,
      update them with the built-in editor or via the API, track their Content
      Score (0–100), and publish them to your CMS. Use Atomic Content to
      generate a complete optimized article with AI. The `version` field enables
      optimistic locking for concurrent editing.
    name: Contents
  - description: >-
      Track the progress of Atomic Content AI generations. After launching a
      generation via `POST /v1/contents/:id/atomic`, poll the status here. When
      status reaches `review`, confirm to apply the generated content to your
      draft, or cancel to discard it.
    name: Content Generations
  - description: >-
      View the credit consumption history for your organization. Credits are
      consumed by keyword analyses, AI content generation, and content idea
      searches. Each entry details what was consumed, by whom, and in which
      workspace.
    name: Credit Usages
  - description: >-
      Keywords are search terms associated with your pages. Analyzing a keyword
      triggers a SERP analysis that produces actionable SEO recommendations:
      topics to cover, questions to answer, search intents to address, and links
      to add. Use the report endpoint to score any content against these
      recommendations.
    name: Keywords
  - description: >-
      Prompts represent questions that users ask AI engines (ChatGPT, Google AI
      Overviews). Analyzing a prompt reveals which sources and brands are cited
      in AI responses, and produces GEO recommendations to improve your
      content's visibility in AI-generated answers.
    name: Prompts
  - description: >-
      Brand Voices encode your editorial identity for AI-generated content. When
      configured, Atomic Content and AI features automatically adopt your
      writing style, tone, and brand guidelines. Select a brand voice ID in the
      `settings` of `POST /v1/contents/:id/atomic`.
    name: Brand Voices
  - description: >-
      Knowledge Documents are reference materials (text, URLs, or files) that
      enrich AI content generation with your expertise. When knowledge sources
      are enabled in Atomic Content settings, the AI draws from these documents
      to produce more accurate, brand-aligned content.
    name: Knowledge Documents
paths:
  /v1/workspaces/{id}:
    get:
      tags:
        - Workspaces
      summary: Get workspace details
      description: Returns details of a specific workspace.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
          description: Workspace ID.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  countryCode:
                    type: string
                    description: Country code (ISO 3166-1 alpha-2).
                  countryName:
                    type: string
                    description: Human-readable country name.
                  createdAt:
                    type: string
                    description: ISO 8601 creation date.
                  id:
                    type: string
                    description: Unique identifier of the workspace.
                  languageCode:
                    type: string
                    description: Language code (ISO 639-1).
                  name:
                    type: string
                    description: Name of the workspace.
                  websiteUrl:
                    type: string
                    description: Root URL of the website tracked by this workspace.
                required:
                  - countryCode
                  - countryName
                  - createdAt
                  - id
                  - languageCode
                  - name
                  - websiteUrl
                additionalProperties: false
components:
  securitySchemes:
    apiKey:
      bearerFormat: API Key
      description: API key starting with `sk_`. Generate one in **Settings > API Keys**.
      scheme: bearer
      type: http

````