siteAnalyses

The methods of pd.siteAnalyses. Inputs and outputs are described in Conventions; every method can also fail as described in Errors.

Methods

pd.siteAnalyses.start(input, init?)

Analyse the client's website to draft a project

POST /api/workspaces/{workspaceId}/site-analyses

Needs projects.create on the workspace. Records an analysis of the site and answers 202 with it, queued: the service reads the homepage, the sitemap and up to 10 chosen pages in the background and drafts a project, brand voice and article ideas from them. Poll GET /api/site-analyses/{analysisId} until status is ready (or failed), then send the reviewed draft to POST /api/site-analyses/{analysisId}/apply. The run costs no credits; a workspace may start 3 in any 24 hours, and the fourth answers 429 QUOTA_EXCEEDED (metric site_analyses). Every call starts a new analysis and counts toward that cap, even for a URL already analysed. An address that is not a public http or https URL answers 400 before anything is stored.

Input

Returns 202 Accepted

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.siteAnalyses.start({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  body: {
    url: "example",
  },
});
console.log(result);

pd.siteAnalyses.get(input, init?)

Read a website analysis

GET /api/site-analyses/{analysisId}

Needs projects.create on the workspace the analysis belongs to (reading it takes the same permission as creating the project). Returns the analysis with its progress; once status is ready the draft is in result. A run that has not moved for 5 minutes is marked failed with errorCode ANALYSIS_FAILED when it is read, so a run that is lost never stays queued, crawling or analysing forever. Other failures are SITE_UNREACHABLE (the homepage could not be read) and SITE_TOO_THIN (too little text to analyse). 404 for an unknown id.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.siteAnalyses.get({
  analysisId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.siteAnalyses.apply(input, init?)

Create the project a website analysis drafted, as reviewed

POST /api/site-analyses/{analysisId}/apply

Needs projects.create on the workspace the analysis belongs to. Creates, in one transaction, the project from draft.project and draft.defaults (with the analysed URL as its website and the site's icon, when one was read), a brand voice from draft.brandVoice as the project's default voice, and a content idea for each of draft.ideas; the workspace takes the site's icon too when it has none. The analysis becomes applied and its projectId is set. Answers 409 CONFLICT when the analysis is not ready: still running, failed, or already applied (so applying twice creates one project), and 429 QUOTA_EXCEEDED when the plan's projects quota is reached. Costs no credits. Records a projects.created audit entry with source site_analysis. It also starts a detection of the new project's image style from its website (no credits, outside the daily cap of image style runs), which is applied on its own when it succeeds and the project still has no style description.

Input

Returns 201 Created

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.siteAnalyses.apply({
  analysisId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  body: {
    draft: {
      project: {
        name: "example",
        description: "example",
        industry: "example",
        audience: "example",
        language: "example",
      },
      defaults: {
        tone: "professional",
        wordCount: 600,
      },
      brandVoice: {
        name: "example",
        description: "example",
        tone: "example",
        writingRules: ["example"],
        preferredWords: ["example"],
        avoidedWords: ["example"],
      },
      ideas: [
        {
          title: "example",
          primaryKeyword: "example",
          searchIntent: "informational",
          cluster: "example",
        },
      ],
    },
  },
});
console.log(result);