Skip to main content
POST
/
knowledge
Index a knowledge-base document asynchronously
curl --request POST \
  --url https://api.scripe.io/v1/knowledge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "text": "<string>",
  "projectId": "<string>"
}
'
{
  "data": {
    "id": "job_a1b2c3d4e5f6g7h8",
    "type": "POST_GENERATION",
    "status": "QUEUED",
    "projectId": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "progress": {
      "progress": 0.5,
      "updatedAt": "2023-11-07T05:31:56Z",
      "message": "<string>"
    },
    "result": {},
    "errorCode": "<string>",
    "errorMessage": "<string>",
    "attemptCount": 1,
    "estimatedCompletionMs": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

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.

Authorizations

​
Authorization
string
header
required

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.

Headers

​
Scripe-Api-Version
string

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

Example:

"2026-08-01"

​
Idempotency-Key
string

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.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Body

application/json
​
type
enum<string>
required
Available options:
text
​
name
string
required
Maximum string length: 500
​
text
string
required
Maximum string length: 1000000
​
projectId
string | null

When omitted, the document is workspace-scoped.

Response

Job enqueued.

​
data
object
required