Meet the new Scripe, live on October 7.Register

OpenAPI reference · Ideas

Create an idea on the board

POST/ideas

Creates an idea at the top of its column — the board UI's create semantics; ordering is never a caller input. status accepts only the writable columns inbox (default) and in_production; review/done are derived from the linked post. Creating an idea places nothing on the calendar and never creates a post. Honours Idempotency-Key for 24h dedup — see /docs/api/v1/idempotency.

Required scope: ideas:write.

Authorization

  • Authorizationstringrequired

    Bearer token in the Authorization header.

    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.

Header parameters

  • Scripe-Api-Versionstring

    Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

  • Idempotency-Keystring

    Opaque string (1–64 chars, [A-Za-z0-9_-]) used to dedup retried writes. Within 24h of the first request, the same key

    • same body returns the original response (Idempotent-Replayed: true). Same key + different body returns 409 idempotency_key_conflict.

    Strongly recommended for every write — see /docs/api/v1/idempotency.

Request bodyapplication/json

  • projectIdstringrequired
  • titlestringrequired
  • contentstring
  • statusstring

    Writable workflow statuses only (default inbox) — not the board column, which a status never moves. review/done are DERIVED from the linked post and rejected on every write.

    Allowed values: inbox, in_production

  • pillarstring
  • postTypestring
  • assetFormatstring
  • hookstring
  • topicstring

Responses

  • 200

    Idea created (or replayed via Idempotency-Key).

  • 400

    Malformed request (bad cursor, bad limit, etc.).

  • 401

    Missing, malformed, expired, or revoked API key.

  • 403

    Plan not eligible, scope missing, or workspace mismatch.

  • 404

    Resource not found in this workspace.

  • 409

    Idempotency-Key reused with a different body within the 24h dedup window. Pick a fresh key or replay the original body verbatim.

  • 422

    Body shape was JSON but failed validation (unprocessable).

  • 429

    Sliding-window rate limit exceeded.

Example request

bash
curl --request POST \
  --url 'https://api.scripe.io/v1/ideas' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "projectId": "proj_a1b2c3d4e5f6g7h8",
  "title": "string",
  "content": "string",
  "status": "inbox",
  "pillar": "string",
  "postType": "string",
  "assetFormat": "string",
  "hook": "string",
  "topic": "string"
}'

Example response (200)

json
{
  "data": {
    "id": "idea_a1b2c3d4e5f6g7h8",
    "title": "string",
    "status": "inbox",
    "pillar": "string",
    "postType": "string",
    "assetFormat": "string",
    "hook": "string",
    "topic": "string",
    "scheduledFor": "string",
    "linkedPost": {
      "id": "post_a1b2c3d4e5f6g7h8",
      "statusCategory": "string"
    },
    "createdAt": "string"
  }
}