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

# Get one idea in full

> The creative brief, capture evidence (angle, proven-idea stats,
reference posts, origin), AI readiness with open clarifying
questions, attached source material, and the linked post.
Requires the `ideas:read` scope.




## OpenAPI

````yaml /openapi/v1.yaml get /ideas/{ideaId}
openapi: 3.1.0
info:
  title: Scripe Public API
  version: '2026-08-10'
  summary: >-
    Read and write Scripe workspace data — posts, notes, ideas, sources,
    knowledge, media, analytics, usage, async jobs, and webhooks.
  description: |
    The Scripe public API gives integrators stable, versioned access to a
    workspace's content surface: reads across every resource, synchronous
    writes (notes, posts, ideas, text sources, media assets), async jobs
    (post generation, file/URL/YouTube ingest, image and carousel
    generation), usage meters, and outbound webhooks.

    All endpoints (except `/v1/health`) require a Bearer token — either a
    workspace API key (`scripe_sk_*`) or an OAuth 2.1 access token
    (`scripe_oat_*`). Pin the API version with the `Scripe-Api-Version`
    request header to opt out of breaking changes.
  contact:
    name: Scripe Support
    url: https://scripe.io/support
    email: support@scripe.io
  license:
    name: Proprietary
servers:
  - url: https://api.scripe.io/v1
    description: Production
security:
  - BearerApiKey: []
tags:
  - name: Health
    description: Liveness and authenticated key smoke tests.
  - name: Workspace
    description: The workspace + principal resolved from your API key.
  - name: Projects
    description: Personal-brand, company-page, and amplifier projects.
  - name: Notes
    description: Project notes with paired calendar slot.
  - name: Posts
    description: Drafts, scheduled, and published LinkedIn posts.
  - name: Analytics
    description: Your own LinkedIn analytics and viral-post inspiration search.
  - name: Sources
    description: Transcriptions (audio/video sources) with truncated body.
  - name: Uploads
    description: >-
      Pre-signed S3 PUT URLs the customer uploads bytes to before referencing
      via Sources or Knowledge.
  - name: Knowledge
    description: >-
      Knowledge-base documents indexed for RAG. Async ingest via text, file,
      URL, or YouTube.
  - name: Jobs
    description: >-
      Async-job lifecycle — submitted via post-generation, knowledge ingest,
      file source.
  - name: Calendar
    description: >-
      The content calendar — scheduled/planned posts, note slots, idea
      placements, and the posting-time template.
  - name: Ideas
    description: >-
      The idea board — creative briefs with derived workflow statuses and
      date-level calendar placement.
  - name: Media
    description: >-
      Media-library search, own-image imports, AI image generation, and
      full-state media writes onto posts.
  - name: Settings
    description: >-
      Curated project settings, engagement policy, and company pages (read-only
      over REST).
  - name: Webhooks
    description: |
      Outbound HTTP callbacks. Subscribe an endpoint to one or more
      event names; we POST a signed JSON payload every time a matching
      event fires in the workspace. The signing secret is shown once
      on create and once on rotate — verify the
      `Webhook-Signature: t=<ts>,v1=<hmac>` header on every delivery.
paths:
  /ideas/{ideaId}:
    get:
      tags:
        - Ideas
      summary: Get one idea in full
      description: |
        The creative brief, capture evidence (angle, proven-idea stats,
        reference posts, origin), AI readiness with open clarifying
        questions, attached source material, and the linked post.
        Requires the `ideas:read` scope.
      operationId: getIdea
      parameters:
        - $ref: '#/components/parameters/ScripeApiVersion'
        - name: ideaId
          in: path
          required: true
          schema:
            type: string
            example: idea_a1b2c3d4e5f6g7h8
        - name: projectId
          in: query
          required: true
          schema:
            type: string
            example: proj_a1b2c3d4e5f6g7h8
      responses:
        '200':
          description: The idea.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdeaDetailResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    ScripeApiVersion:
      name: Scripe-Api-Version
      in: header
      required: false
      description: |
        Pin the API version. Format `YYYY-MM-DD`. Omit to receive the
        currently rolling default. Unknown versions return `400
        version_unsupported`.
      schema:
        type: string
        example: '2026-08-10'
  schemas:
    IdeaDetailResponse:
      type: object
      required:
        - data
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/IdeaShared'
            - type: object
              required:
                - content
              properties:
                content:
                  type: string
                  description: >-
                    The idea's body as plain text, clipped to 1500 characters
                    with an ellipsis appended when it was longer — the longest
                    form any read serves, and not necessarily the whole stored
                    body. This read never carries the list row's `excerpt`.
                topic:
                  type: string
                  nullable: true
                media:
                  type: object
                  nullable: true
                  description: |
                    The idea's media decision (its editable board template
                    ref). `mode: asset` — concrete images (cover first; a
                    generated carousel's cover renders here too); `mode:
                    reference` — a visual style direction only, the media is
                    created per post later. `assetId`s are public
                    media-library ids (`img_…`); a stored image without a
                    library row carries `assetId: null`. The URL fields
                    (`imageUrl`, `styleImageUrl`) are display links to the
                    image bytes and require the `media:read` scope on top of
                    `ideas:read` — without it they are `null` while the ids,
                    mode, style name and image count stay intact. A
                    `reference` pick can also carry no picture at all
                    (`styleImageUrl: null` with the scope held): the Scripe
                    app draws those previews live from the customer's own
                    brand, and the style name is what describes them here.
                  properties:
                    mode:
                      type: string
                      enum:
                        - asset
                        - reference
                    styleName:
                      type: string
                      nullable: true
                    referencePrompt:
                      type: string
                      nullable: true
                    styleImageUrl:
                      type: string
                      nullable: true
                    images:
                      type: array
                      items:
                        type: object
                        properties:
                          assetId:
                            type: string
                            nullable: true
                            example: img_a1b2c3d4e5f6g7h8
                          imageUrl:
                            type: string
                            nullable: true
                    generationPending:
                      type: boolean
                readiness:
                  type: object
                  nullable: true
                  properties:
                    verdict:
                      type: string
                    summary:
                      type: string
                      nullable: true
                    openQuestions:
                      type: array
                      items:
                        type: string
                evidence:
                  type: object
                  nullable: true
                  properties:
                    angle:
                      type: string
                      nullable: true
                    provenIdeaSummary:
                      type: string
                      nullable: true
                    referencePosts:
                      type: array
                      items:
                        type: object
                        properties:
                          author:
                            type: string
                            nullable: true
                          excerpt:
                            type: string
                    originExcerpt:
                      type: string
                      nullable: true
                attachedSources:
                  type: array
                  items:
                    type: object
                    properties:
                      kind:
                        type: string
                      title:
                        type: string
                        nullable: true
                      url:
                        type: string
                        nullable: true
                      description:
                        type: string
    IdeaShared:
      type: object
      description: |
        The board fields both idea reads carry. Among these shared fields
        the two reads differ in the body field only: a list row carries a
        short `excerpt` (500 characters), the single read carries a longer
        `content` (1500 characters). Both are plain text clipped from the
        stored body, with an ellipsis appended when the body was longer;
        neither read serves both fields, which is why this schema declares
        neither. A body may be written up to 65535 bytes, so a longer one
        is readable back only in clipped form — no field on either read
        reports whether the clip happened.

        Beyond these shared fields the single read carries further detail
        fields the list row has no counterpart for (`topic`, `media`,
        `readiness` and others) — see `IdeaDetailResponse` for its full
        shape.
      required:
        - id
        - title
        - status
        - awaitingInput
        - createdAt
      properties:
        id:
          type: string
          example: idea_a1b2c3d4e5f6g7h8
        title:
          type: string
        status:
          type: string
          enum:
            - inbox
            - in_production
            - review
            - done
          description: >-
            DERIVED board status — the legacy raw "ready" never reaches the
            wire.
        pillar:
          type: string
          nullable: true
        postType:
          type: string
          nullable: true
        funnelStage:
          type: string
          nullable: true
          enum:
            - REACH
            - TRUST
            - CONVERT
            - null
          description: >-
            The funnel lane the idea aims at — Reach (top of funnel), Trust
            (middle) or Convert (bottom) — or null when unrated. DERIVED from
            `postType` (the pillar as fallback) and read-only: no request
            carries it. Set the format and the lane follows.
        assetFormat:
          type: string
          nullable: true
        hook:
          type: string
          nullable: true
        scheduledFor:
          type: string
          nullable: true
          description: Day-level calendar placement (YYYY-MM-DD).
        source:
          type: string
        awaitingInput:
          type: boolean
          description: >-
            True when ≥1 input request is open — the idea is blocked on
            someone's answers.
        linkedPost:
          type: object
          nullable: true
          properties:
            id:
              type: string
              example: post_a1b2c3d4e5f6g7h8
            title:
              type: string
              nullable: true
            statusCategory:
              type: string
              nullable: true
        createdAt:
          type: string
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
            - docs_url
          properties:
            code:
              type: string
              description: Stable, machine-readable error identifier.
              example: not_found
            message:
              type: string
            request_id:
              type: string
              example: req_a1b2c3d4e5f6
            docs_url:
              type: string
              format: uri
            details:
              description: Optional structured payload — shape varies per code.
  responses:
    BadRequest:
      description: Malformed request (bad cursor, bad limit, etc.).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing, malformed, expired, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Plan not eligible, scope missing, or workspace mismatch.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found in this workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Sliding-window rate limit exceeded.
      headers:
        Retry-After:
          schema:
            type: integer
        X-RateLimit-Limit:
          schema:
            type: integer
        X-RateLimit-Remaining:
          schema:
            type: integer
        X-RateLimit-Reset:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerApiKey:
      type: http
      scheme: bearer
      bearerFormat: scripe_sk_live_*
      description: |
        Pass `Authorization: Bearer scripe_sk_live_<...>` (or
        `scripe_sk_test_<...>` for test keys) on every request. Keys
        are scoped to a single workspace and can be revoked from the
        Scripe dashboard.

        The same header also accepts an OAuth 2.1 access token
        (`scripe_oat_*`); both credentials share one scope vocabulary
        and every operation below documents the scope it requires.
        An API key can hold every scope named on this surface except
        `webhooks:manage`, which is grantable to OAuth tokens only
        today — the webhook-endpoint operations answer
        `403 scope_missing` to every API key. Operations that name no
        scope accept any valid token of the workspace.

````