Meet the new Scripe, live on October 7.Register

OpenAPI reference · Knowledge

Index a knowledge-base document asynchronously

POST/knowledge

Kick off an async ingest into the workspace's knowledge base. Four input shapes are accepted (type: text|file|url|youtube). Returns a Job envelope; poll GET /v1/jobs/{jobId} until the status transitions to DONE and result.documentId becomes available.

When projectId is omitted, the document is workspace-scoped (visible to every project). When set, the document is project-scoped.

Cost: counts against the daily AI-spend cap (1–3¢ depending on type, reconciled with provider actuals after the job runs).

Required scope: knowledge: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.

Responses

  • 200

    Job enqueued.

  • 400

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

  • 401

    Missing, malformed, expired, or revoked API key.

  • 402

    Daily AI-spend cap reached for this workspace. Resets at 00:00 UTC.

  • 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.

  • 413

    Request body exceeds the size cap.

  • 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/knowledge' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "text",
  "projectId": "string",
  "name": "string",
  "text": "string"
}'

Example response (200)

json
{
  "data": {
    "id": "job_a1b2c3d4e5f6g7h8",
    "type": "POST_GENERATION",
    "status": "QUEUED",
    "projectId": "string",
    "startedAt": "2026-08-10T09:00:00Z",
    "completedAt": "2026-08-10T09:00:00Z",
    "progress": {
      "progress": 0,
      "message": "string",
      "updatedAt": "2026-08-10T09:00:00Z"
    },
    "result": {},
    "errorCode": "string",
    "errorMessage": "string",
    "attemptCount": 0,
    "estimatedCompletionMs": 0,
    "createdAt": "2026-08-10T09:00:00Z",
    "updatedAt": "2026-08-10T09:00:00Z"
  }
}