List intel reports

GET/v1/research/reports

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Query Parameters

status?string

Value in

"pending" | "planning" | "gathering" | "researching" | "reflecting" | "synthesizing" | "rendering" | "completed" | "failed" | "cancelled"

limit?integer

Default30

Range1 <= value <= 100

offset?integer

Default0

Range0 <= value <= 9007199254740991

Response Body

`application/json`

cURL

curl -X GET "https://example.com/research/reports"

{
  "success": true,
  "reports": [
    {
      "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"
    }
  ],
  "pagination": {
    "limit": -9007199254740991,
    "offset": -9007199254740991
  }
}

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

{
  "error": "unauthorized"
}

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`