Quickstart

Make your first authenticated request in under 60 seconds.

This guide walks you through creating a project API key and making your first authenticated request. By the end, you will have confirmed that your key works and be ready to explore the full API.

Step 1: Create an API key

Open the Sellm dashboard, navigate to Project Settings, and select the API Keys tab. Click Create API Key, give it a name, and copy the key that is generated.

Your key will look like this:

sellm_...

Step 2: Make your first request

Use your key to fetch your project details. This is the simplest endpoint and a reliable way to confirm that authentication is working.

Step 3: Confirm success

A successful response returns your project details:

{
  "data": {
    "id": "9f4c8b02-7c6d-4d3f-8b12-5f3a6d9e2c41",
    "name": "Acme CRM",
    "url": "https://acmecrm.com",
    "competitors": [
      {
        "id": "4c8e2d17-6a3f-4b90-9d21-7f5c1a2e8b44",
        "name": "HubSpot",
        "url": "https://hubspot.com"
      },
      {
        "id": "a6d5b410-8f32-45c7-9a14-2b76e1d94f03",
        "name": "Salesforce",
        "url": "https://salesforce.com"
      }
    ]
  }
}

If you see your project name and ID, authentication is working and you are ready to build.

If you get a 401 error, double-check that your key is correct and that the Authorization header uses the Bearer prefix.

Step 4: Explore common workflows

With authentication confirmed, here are the most common next steps:

List your prompts — See all the search queries your project is tracking.

GET /prompts

Trigger an analysis run — Start an on-demand analysis across all active prompts and providers.

POST /analysis/trigger

Check run status — Monitor the progress of a running analysis.

GET /analysis/runs/{runId}

Fetch results — Retrieve the structured analysis output once a run completes.

GET /analysis/runs/{runId}/results

For full endpoint details, head to the API Reference.

One-off brand analysis

If you want to analyze brands without creating Sellm projects, create an organization API key from Organization API Integrations instead. Organization keys can call POST /async-analysis with a brandName in the body and use prepaid API credits.

{
  "brandName": "Acme CRM",
  "prompt": "best CRM for startups",
  "providers": ["chatgpt"],
  "locations": ["US"],
  "replicates": 1
}

Credit usage is calculated as prompts × providers × locations × replicates.