Create an intel report

POST/v1/research/reports

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

useCase*string

Value in

"niche_viability" | "offer_validation" | "competitor_deep_dive" | "market_landscape" | "niche_scorecard" | "offer_stack" | "audience_report"

target*string

Length1 <= length <= 500

tier*string

Value in"quick" | "standard" | "deep" | "max"

question?string

Lengthlength <= 2000

profile?

title?string

Lengthlength <= 300

sourceResearchJobId?string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

model?string

Lengthlength <= 200

Response Body

`application/json`

cURL

curl -X POST "https://example.com/research/reports" \  -H "Content-Type: application/json" \  -d '{    "useCase": "niche_viability",    "target": "string",    "tier": "quick"  }'

{
  "success": true,
  "report": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "title": "string",
    "useCase": "string",
    "target": "string",
    "question": "string",
    "tier": "string",
    "status": "pending",
    "viabilityScore": -9007199254740991,
    "headlineConfidence": "string",
    "creditsCharged": -9007199254740991,
    "sourceResearchJobId": "8b15f1ab-5d95-4e05-84bc-3bcf18d85cb8",
    "version": -9007199254740991,
    "error": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "unauthorized"
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "success": false,
  "error": "API key lacks write permission"
}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

402application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`