Your first enrichment

Start a local workspace, create a key, then submit and retrieve your first item.

1. Run the local API#

You need Node.js 22.13 or later. This REST quickstart assumes you already have the local enrichment-api workspace, provided separately during the developer alpha. Run these commands from that workspace.

npm ci
npm run dev

The server listens at http://127.0.0.1:4343. Open the private console URL printed in your terminal. Its fragment token unlocks local key administration. Keep that URL private.

2. Create a developer key#

In the console, create a named key with enrichments:write, enrichments:read, and usage:read. Copy the secret when it appears; it is shown only once. Set it in your shell without writing it into your source code.

export ENRICHMENT_API_KEY="YOUR_LOCAL_DEVELOPER_KEY"

3. Submit an item#

Each intentional enrichment needs a unique Idempotency-Key. If you retry this exact request, reuse the same key and body.

curl -i http://127.0.0.1:4343/v1/enrichments \
  -H "Authorization: Bearer $ENRICHMENT_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: workshop-note-001' \
  -d '{"input":{"kind":"text","text":"The workshop takes place on 18 October. Bring a notebook."},"max_credits":1}'

A new request responds with 202 Accepted, a job ID, and a Location header. One sandbox unit is reserved while work runs.

4. Retrieve the result#

Replace JOB_ID with the returned ID. Poll the job while its status is queued or processing, using the response’s Retry-After guidance where supplied.

curl http://127.0.0.1:4343/v1/enrichments/JOB_ID \
  -H "Authorization: Bearer $ENRICHMENT_API_KEY"

A completed or partial job contains a result. Inspect sources, capabilities, and warnings before using it. A failed job contains an error and releases its reserved unit.

Keys & authentication

Your developer key grants access to one local workspace. Give each integration only the scopes it needs.

Create and manage a key#

Start the API and open the private console URL printed at startup. In API keys, choose a name and scopes, then create the key. Save its one-time secret in your local environment or secret manager.

The console uses a separate HttpOnly session. A developer API key cannot create other keys or administer an account. Reloading the console clears the displayed secret.

Authenticate a request#

curl http://127.0.0.1:4343/v1/balance \
  -H "Authorization: Bearer $ENRICHMENT_API_KEY"

Send the key in the Authorization header. Never put it in a URL, browser bundle, repository, or MCP tool argument. This documentation site does not receive or store your key.

Choose scopes#

Rotate or revoke#

Create a replacement key, update the integration, verify a request, then revoke the old key in the console. Revoked keys stop authorizing requests. Key hashes are stored in the local SQLite database; the original secret cannot be recovered.

Configure enrichment

Choose the capabilities your local service should run. Every result reports what was actually available.

Choose an engine mode#

Enable semantic enrichment#

Copy the provided environment template, edit it with your own dedicated provider key, and start the API with that file. Provider calls may incur charges with your chosen model provider.

cp .env.example .env
# Edit .env with your dedicated configuration.
node --env-file=.env src/server.mjs

ENRICHMENT_ENGINE=shared
ENRICHMENT_OPENAI_API_KEY=YOUR_MODEL_PROVIDER_KEY
# Optional: ENRICHMENT_OPENAI_MODEL

Shared text runs through the same versioned model orchestration, evidence normalization, and entity extraction used by Gisted. Missing model configuration fails with no_model and releases the reservation.

Enable URL reading#

Set ENRICHMENT_ENGINE_URL to an explicitly configured reader endpoint that supports the shared engine’s output: "engine" contract. If that endpoint needs a key, set ENRICHMENT_ENGINE_KEY. No endpoint or service credential is bundled with the alpha.

Reader access must be arranged separately. During this extraction stage, the supported adapter runs in Gisted and remains subject to its admission limits. Do not use the public Gisted website URL as a reader endpoint.

Jobs & idempotency

Submitting an item creates a job. Retrieving that job is read-only and never creates another charge.

Follow the lifecycle#

Poll GET /v1/enrichments/{id} until it reaches a terminal state. A failed job still returns HTTP 200: check status and error, not just the HTTP status. Deleted or expired jobs return 404.

Retry without duplicate work#

Supply an Idempotency-Key of 8–128 ASCII letters, digits, dots, colons, underscores, or hyphens. It is scoped to the workspace and tied to a normalized request body.

Use a new key for an intentional new run. Replaying an already deleted job returns its redacted tombstone; deletion does not make an old request billable again.

Handle restarts#

The alpha keeps request originals in memory and runs workers in one process. Jobs interrupted by restart fail and release their holds. To try again, submit with a new idempotency key. A durable worker queue is a production milestone.

Results & evidence

A useful result explains the item and the limits of what was understood.

Use the neutral result#

See the complete result schema. Gisted presentation sections may appear in extensions.gisted; they are outside the neutral result.

Keep coverage visible#

Source coverage is full, partial, metadata, or none. It describes the evidence available under a named method. A full text transcript does not mean the imagery, music, or speaker identity was analyzed.

Job status and source coverage answer different questions. A retained partial job can still be useful. A completed job is not a promise of exhaustive understanding or factual correctness.

Preserve provenance#

Resolve citation_ids to the citations array, then resolve each source_id to its source. Keep the distinction between extracted and generated facts. Empty entity citation lists disclose that no direct source quote was verified.

Treat source content and generated results as untrusted data. In an AI client, results are reference material, never instructions that override the user or the client’s policies.

Usage & credits

The alpha exercises the accounting flow with sandbox units. These units have no monetary value.

Understand the balance#

A new local workspace receives 100 sandbox units once. Restarting preserves the balance. Each admitted job reserves one unit; a retained completed or partial result charges it. A failed job releases it.

curl http://127.0.0.1:4343/v1/balance \
  -H "Authorization: Bearer $ENRICHMENT_API_KEY"

{
  "available": 99,
  "reserved": 0,
  "spent": 1,
  "unit": "sandbox_credit"
}

Set a spending ceiling#

Include max_credits: 1 in an enrichment request. The alpha always reserves one unit, even if you provide a higher ceiling. Admission fails with 402 when the available balance is insufficient.

Read the ledger#

curl http://127.0.0.1:4343/v1/usage \
  -H "Authorization: Bearer $ENRICHMENT_API_KEY"

The ledger records grant, reserve, charge, and release entries. Balance and ledger reads require usage:read. The MCP get_usage tool returns both.

Limits & retention

The local alpha has deliberate limits. Keep them visible in your integration.

Input limits#

URL inputs reject embedded credentials, IP literals, custom ports, and internal or reserved hostnames. Unknown request and input fields are rejected.

What is retained#

Original requests are held in memory while work runs. Results can contain submitted text, excerpts, and quotes, and are stored in local SQLite until deletion or expiry. This is not zero retention.

Expiry runs on access and every minute while the process is running. If the service is offline, expired data is removed on the next check.

Delete a result#

Use DELETE /v1/enrichments/{id} to remove access to a result. Deletion releases an unsettled hold; completed work is not refunded. Redacted ledger and idempotency tombstones remain for accounting.

Use sample or non-sensitive content while evaluating the alpha. Production tenant accounts, distributed limits, and durable worker leasing are outside this release.

Errors & troubleshooting

Check both the HTTP response and the job’s lifecycle status.

Request errors#

Job failures#

A successful retrieval can contain status: "failed". Inspect its error. Missing model configuration returns no_model; missing reader configuration in shared URL mode returns engine_unavailable. These failures release the reserved unit.

Cannot connect?#

The API must be running on the same machine as your request or stdio MCP process. developer.gisted.co is the documentation host, not the API base URL. Start npm run dev, check its printed port, and use http://127.0.0.1:4343 unless you changed it.

If the console session has expired, reopen the current private startup URL from your terminal. Do not paste that URL into a bug report.

Connect your AI client

Give a compatible AI client three tools: enrich an item, retrieve a result, and inspect usage.

1. Prepare the API#

Complete the quickstart in your separately provided API workspace: start the API in a separate terminal and create a key with all three scopes. Keep the API process running. The connector download does not include an API server or a hosted account.

2. Install and configure the connector#

Download the MCP connector ↓

Extract the archive. In the extracted connector directory, run npm ci to install its pinned dependencies.

In a client that supports local stdio MCP servers, add the equivalent of this configuration. Replace both absolute paths and the placeholder key. Client configuration formats vary.

{
  "mcpServers": {
    "gisted": {
      "command": "/absolute/path/to/node",
      "args": [
        "/absolute/path/gisted-mcp-alpha/mcp/server.mjs"
      ],
      "env": {
        "ENRICHMENT_API_URL": "http://127.0.0.1:4343",
        "ENRICHMENT_API_KEY": "YOUR_LOCAL_DEVELOPER_KEY"
      }
    }
  }
}

The Node executable must be version 22.13 or later. Use an absolute executable path if your client does not inherit your shell’s PATH. ENRICHMENT_API_URL defaults to http://127.0.0.1:4343; ENRICHMENT_API_KEY is required. The API URL must be an origin (scheme and host, with an optional port), without a path, query, or fragment. HTTPS is required except for loopback addresses.

Store configuration containing the key privately. Do not put keys in prompts, tool arguments, or repositories.

3. Try the tools#

Restart or reconnect the client after saving its configuration. It should discover enrich_item, get_enrichment, and get_usage.

Enrich this note: “The workshop takes place on 18 October. Bring a notebook.” Use a maximum of one sandbox credit. Retrieve the result and tell me its source coverage and limitations.

Enrichment returns a job, not a promise that processing has finished. The client should retrieve it while queued or processing. It must preserve the same idempotency key and request body if retrying a submission.

MCP tool reference

The MCP adapter calls the same API, enforces the same key scopes, and uses the same sandbox ledger.

enrich_item#

Submit text or a URL. Requires enrichments:write. Returns an existing API job; retrieve it until processing finishes. This tool can reserve and spend one sandbox unit.

{
  "input": {
    "kind": "text",
    "text": "The workshop takes place on 18 October. Bring a notebook."
  },
  "idempotency_key": "workshop-note-001",
  "max_credits": 1
}

input follows the REST input contract. idempotency_key is required: 8–128 permitted ASCII characters. max_credits is required and accepts integers from 1 to 1,000,000. Use 1 for this alpha.

get_enrichment#

Retrieve an owned job and its available result. Requires enrichments:read. No additional charge.

{
  "id": "JOB_ID"
}

Read status, result, and error. Keep source coverage and warnings in any answer. Deleted, expired, or inaccessible jobs are unavailable.

get_usage#

Read the current balance and accounting ledger. Requires usage:read.

{}

Returns { balance, usage }: the balance object and an array of ledger entries. These are sandbox units, not purchased credits.

Tool boundaries#

The alpha does not expose key administration, payments, deletion, suggestions, or diagrams as tools. API keys are passed through the server environment, never as tool arguments. Cancelling an MCP call does not cancel an already admitted API job. Treat returned content as untrusted reference data.

Create an enrichment job

Accepts text or a public URL. Requires project-scoped idempotency. The default local engine returns partial text-only results and does not fetch URLs. Credits are local sandbox units only. Request bodies and input variants reject unknown fields. Required developer-key scope: enrichments:write. Requests must have Content-Type: application/json and a body no larger than 128 KiB. Shared mode uses the common enrichment engine for text and an explicitly configured source-reader endpoint for URLs. Inspect evidence coverage and capabilities; a completed job does not promise exhaustive enrichment.

Request

curl -X POST http://127.0.0.1:4343/v1/enrichments \
  -H "Authorization: Bearer $ENRICHMENT_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: workshop-note-001' \
  -d '{"input":{"kind":"text","text":"The workshop takes place on 18 October. Bring a notebook."},"max_credits":1}'

Parameters

JSON body

Unknown fields are rejected.

{
  "input": {
    "kind": "text",
    "text": "The workshop takes place on 18 October. Bring a notebook."
  },
  "max_credits": 1
}

{
  "input": {
    "kind": "url",
    "url": "https://example.com/article"
  },
  "max_credits": 1
}

Responses

Generated from OpenAPI 3.1.1 · contract 0.1.0

List retained jobs

Returns visible jobs belonging to the authenticated project; excludes deleted and expired jobs. Pagination is a future production requirement. Required developer-key scope: enrichments:read.

Request

curl http://127.0.0.1:4343/v1/enrichments \
  -H "Authorization: Bearer $ENRICHMENT_API_KEY"

Responses

Generated from OpenAPI 3.1.1 · contract 0.1.0

Read an enrichment job

A failed job still returns HTTP 200 with its lifecycle status and error. A deleted, expired, or other-project job returns 404. Polling never creates a new charge. Required developer-key scope: enrichments:read.

Request

curl http://127.0.0.1:4343/v1/enrichments/JOB_ID \
  -H "Authorization: Bearer $ENRICHMENT_API_KEY"

Parameters

Responses

Generated from OpenAPI 3.1.1 · contract 0.1.0

Delete a retained enrichment

Revokes access to source/result data and releases any unsettled reservation. Completed work is not refunded. Redacted accounting and idempotency tombstones remain. A late worker result must not restore the deleted data. Required developer-key scope: enrichments:write.

Request

curl -X DELETE http://127.0.0.1:4343/v1/enrichments/JOB_ID \
  -H "Authorization: Bearer $ENRICHMENT_API_KEY"

Parameters

Responses

Generated from OpenAPI 3.1.1 · contract 0.1.0

Read sandbox credit balance

Sandbox units have no monetary value. Key creation and credit administration are not part of this public API. Required developer-key scope: usage:read.

Request

curl http://127.0.0.1:4343/v1/balance \
  -H "Authorization: Bearer $ENRICHMENT_API_KEY"

Responses

Generated from OpenAPI 3.1.1 · contract 0.1.0

Read the sandbox accounting ledger

Positive or negative deltas describe each balance change. Accounting entries remain after result deletion. No source text or credential secrets appear in ledger entries. Required developer-key scope: usage:read.

Request

curl http://127.0.0.1:4343/v1/usage \
  -H "Authorization: Bearer $ENRICHMENT_API_KEY"

Responses

Generated from OpenAPI 3.1.1 · contract 0.1.0

Data schemas

Explore the contract behind every request and result.

TextInput

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "kind": {
      "const": "text",
      "type": "string"
    },
    "text": {
      "type": "string",
      "minLength": 1,
      "description": "Text to enrich. It must contain a non-whitespace character and be at most 20,000 characters before trimming. Leading and trailing whitespace is normalized before hashing. The local sandbox returns only extracted supplied text; semantic enrichment is unavailable.",
      "maxLength": 20000,
      "pattern": "\\S"
    }
  },
  "required": [
    "kind",
    "text"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

UrlInput

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "kind": {
      "const": "url",
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Public HTTP(S) URL, at most 2,048 characters, with no embedded credentials, IP literals, custom ports, or internal/reserved hostname suffixes. The default sandbox does not fetch it; the admitted job fails without charge. Explicit bridge mode may read it with upstream reader protections.",
      "maxLength": 2048,
      "pattern": "^https?://"
    }
  },
  "required": [
    "kind",
    "url"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

CreateEnrichment

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "input": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TextInput"
        },
        {
          "$ref": "#/components/schemas/UrlInput"
        }
      ],
      "discriminator": {
        "propertyName": "kind",
        "mapping": {
          "text": "#/components/schemas/TextInput",
          "url": "#/components/schemas/UrlInput"
        }
      }
    },
    "max_credits": {
      "type": "integer",
      "minimum": 1,
      "default": 1,
      "description": "Spend ceiling in sandbox units. The local milestone always reserves at most 1 unit, even when a larger ceiling is supplied.",
      "maximum": 1000000
    }
  },
  "required": [
    "input"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

ErrorDetail

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

ApiError

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "error": {
      "$ref": "#/components/schemas/ErrorDetail"
    },
    "request_id": {
      "type": "string",
      "description": "Request trace identifier; safe to share when troubleshooting."
    }
  },
  "required": [
    "error",
    "request_id"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

JobInput

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "text",
        "url"
      ]
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "kind"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

JobUsage

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "reserved_credits": {
      "type": "integer",
      "minimum": 0
    },
    "charged_credits": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "reserved_credits",
    "charged_credits"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

Job

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "queued",
        "processing",
        "completed",
        "partial",
        "failed",
        "deleted"
      ],
      "description": "Lifecycle status. Inspect sources and capabilities independently for evidence coverage."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "Retention boundary, 24 hours after creation in this local milestone."
    },
    "input": {
      "$ref": "#/components/schemas/JobInput"
    },
    "result": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/EnrichmentResult"
        },
        {
          "type": "null"
        }
      ]
    },
    "error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ErrorDetail"
        },
        {
          "type": "null"
        }
      ]
    },
    "usage": {
      "$ref": "#/components/schemas/JobUsage"
    }
  },
  "required": [
    "id",
    "status",
    "created_at",
    "updated_at",
    "expires_at",
    "input",
    "result",
    "error",
    "usage"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

ObjectDescription

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "kind",
    "title",
    "description"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

Content

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "text": {
      "type": "string"
    },
    "markdown": {
      "type": "string",
      "description": "Optional normalized rich text from the shared engine."
    }
  },
  "required": [
    "text"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

Fact

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "text": {
      "type": "string"
    },
    "origin": {
      "type": "string",
      "enum": [
        "extracted",
        "generated"
      ]
    },
    "citation_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "id",
    "text",
    "origin",
    "citation_ids"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

Source

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "kind": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "coverage": {
      "type": "string",
      "enum": [
        "full",
        "partial",
        "metadata",
        "none"
      ],
      "description": "Coverage of the source under the named methods, not a guarantee of correctness or universal understanding."
    },
    "methods": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "id",
    "kind",
    "coverage",
    "methods",
    "warnings"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

Citation

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "source_id": {
      "type": "string"
    },
    "quote": {
      "type": "string"
    },
    "locator": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "source_id"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

Capability

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "completed",
        "partial",
        "unavailable"
      ]
    },
    "method": {
      "type": "string"
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "name",
    "status",
    "method",
    "warnings"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

EnrichmentResult

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "schema_version": {
      "const": "1.0",
      "type": "string"
    },
    "object": {
      "$ref": "#/components/schemas/ObjectDescription"
    },
    "content": {
      "$ref": "#/components/schemas/Content"
    },
    "facts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Fact"
      }
    },
    "entities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Entity"
      },
      "description": "Normalized entities from shared-engine output. The default sandbox and legacy compatibility bridge return an empty array."
    },
    "sources": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Source"
      }
    },
    "citations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Citation"
      }
    },
    "capabilities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Capability"
      }
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "extensions": {
      "type": "object",
      "properties": {
        "gisted": {
          "type": "object",
          "additionalProperties": true,
          "description": "Optional Gisted compatibility output from the explicitly configured bridge; not the neutral result contract."
        }
      },
      "additionalProperties": true
    }
  },
  "required": [
    "schema_version",
    "object",
    "content",
    "facts",
    "entities",
    "sources",
    "citations",
    "capabilities",
    "warnings"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

JobList

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Job"
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

Balance

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "available": {
      "type": "integer",
      "minimum": 0
    },
    "reserved": {
      "type": "integer",
      "minimum": 0
    },
    "spent": {
      "type": "integer",
      "minimum": 0
    },
    "unit": {
      "type": "string",
      "const": "sandbox_credit"
    }
  },
  "required": [
    "available",
    "reserved",
    "spent",
    "unit"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

LedgerEntry

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "job_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "grant",
        "reserve",
        "charge",
        "release"
      ]
    },
    "available_delta": {
      "type": "integer"
    },
    "reserved_delta": {
      "type": "integer"
    },
    "spent_delta": {
      "type": "integer"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "job_id",
    "type",
    "available_delta",
    "reserved_delta",
    "spent_delta",
    "created_at"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

UsageList

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LedgerEntry"
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗

Entity

An entity identified by the shared engine. Citation IDs refer to result citations; an empty list means no direct source quote was verified.

Unknown fields are rejected.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "kind": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "citation_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "id",
    "name",
    "kind",
    "citation_ids"
  ],
  "additionalProperties": false,
  "description": "An entity identified by the shared engine. Citation IDs refer to result citations; an empty list means no direct source quote was verified."
}

Generated from the OpenAPI contract. Download OpenAPI JSON ↗