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

# Introduction

> Build websites from your own AI with ShareSame's job-based API.

ShareSame lets your AI describe the website it wants, wait for a job to finish, then deploy the returned files anywhere you want.

<Note>
  API access is currently turned on manually. We give your team a base URL and API key when access is enabled.
</Note>

<Card title="Quickstart" icon="rocket" href="/quickstart" horizontal>
  Start a website job, poll until it finishes, and deploy the returned files.
</Card>

## What the API does

The public API is intentionally small:

<CardGroup cols={2}>
  <Card title="Start a job" icon="wand-magic-sparkles" href="/api-reference/endpoint/generate">
    Send a plain-English prompt with optional files for remixing.
  </Card>

  <Card title="Poll for progress" icon="loader" href="/api-reference/endpoint/job-status">
    Check whether the job is still building, partially ready, fully ready, or failed.
  </Card>

  <Card title="Deploy anywhere" icon="cloud-arrow-up" href="/deployment-reporting">
    Use the returned files on Cloudflare, Vercel, Netlify, or your own infrastructure.
  </Card>

  <Card title="Report the final URL" icon="link" href="/api-reference/endpoint/job-deployed">
    Tell ShareSame where the final website lives after you ship it.
  </Card>
</CardGroup>

## Typical flow

<Steps>
  <Step title="Start with a prompt">
    Send `POST /generate` with a query like `build me a CRM like Salesforce but call it ForceSale`.
  </Step>

  <Step title="Wait for the job">
    Poll `GET /job/{id}` until the status changes to `ready`. If you want a faster preview, you can also use `partial`.
  </Step>

  <Step title="Deploy the files">
    Take the returned files and ship them however your stack already deploys websites.
  </Step>
</Steps>

## What you send

<CardGroup cols={2}>
  <Card title="Plain-English query" icon="message" href="/quickstart">
    The main input is just the website you want your AI to make.
  </Card>

  <Card title="Optional files" icon="folder-open" href="/api-reference/endpoint/generate">
    Pass existing files when you want ShareSame to remix or update a website you already have.
  </Card>

  <Card title="Optional tracking IDs" icon="fingerprint" href="/authentication">
    `user_id` and `project_id` help tie a sequence of edits together.
  </Card>

  <Card title="Bearer auth" icon="key" href="/authentication">
    Every request uses the same team API key in a standard Bearer header.
  </Card>
</CardGroup>

## API reference

<Card title="OpenAPI spec" icon="terminal" href="/api-reference/introduction">
  See the exact request and response shapes for the current ShareSame job API.
</Card>