# Spavik documentation

> REST API, Python and TypeScript SDKs, and MCP.

Full documentation: https://docs.spavik.co/llms-full.txt
OpenAPI contract: https://docs.spavik.co/api-reference/openapi.json

## Guides

### Get started

- [Introduction](https://docs.spavik.co/index.md): Predict business outcomes and forecast time series with the REST API, Python, JavaScript or an AI agent.
- [Quickstart](https://docs.spavik.co/start.md): Evaluate a dataset, train a model and make a prediction with Python, JavaScript or REST.
- [Core concepts](https://docs.spavik.co/concepts.md): Engines, your models, their versions and the prediction lifecycle.
- [Authentication](https://docs.spavik.co/authentication.md): Connect your application or agent with a Spavik API key.
- [Costs and credits](https://docs.spavik.co/costs.md): Understand prediction costs and read the available balance.

### Work with your data

- [Prepare your data](https://docs.spavik.co/guides/data.md): Structure your dataset, choose the target and check data quality before training or forecasting.
- [Understand evaluations](https://docs.spavik.co/guides/evaluation.md): Read evaluation results, compare baselines and understand the limits of each assessment.
- [Model feedback loop](https://docs.spavik.co/guides/feedback-loop.md): Report observed outcomes, measure performance and update your model.

### Integrate

- [Webhooks](https://docs.spavik.co/guides/webhooks.md): Rather than polling the API, get notified.
- [Plans and limits](https://docs.spavik.co/guides/plans.md): Read the current plan, model quota and prediction allowance from the API.
- [API conventions](https://docs.spavik.co/guides/conventions.md): Errors, retries, idempotency and pagination for API integrations.

## Python SDK

### Python

- [Python SDK](https://docs.spavik.co/libraries/python.md): Evaluate, train, predict and forecast with the synchronous and asynchronous Python SDK.

## TypeScript SDK

### TypeScript

- [TypeScript SDK](https://docs.spavik.co/libraries/javascript.md): Use the TypeScript SDK in JavaScript or TypeScript for evaluation, models, forecasting and outcomes.

## MCP

### For agents

- [MCP server](https://docs.spavik.co/mcp.md): Connect an agent to twelve Spavik tools for preparation, evaluation, prediction and forecasting.

## API reference

### Models

- [List engines](https://docs.spavik.co/api-reference/models/get-v1-engines.md): GET /v1/engines
- [Evaluate a dataset](https://docs.spavik.co/api-reference/models/post-v1-datasets-evaluate.md): POST /v1/datasets/evaluate
- [Train a model](https://docs.spavik.co/api-reference/models/post-v1-models.md): POST /v1/models
- [List models](https://docs.spavik.co/api-reference/models/get-v1-models.md): GET /v1/models
- [Get a model](https://docs.spavik.co/api-reference/models/get-v1-models-id.md): GET /v1/models/{id}
- [Rename a model](https://docs.spavik.co/api-reference/models/patch-v1-models-id.md): PATCH /v1/models/{id}
- [List model versions](https://docs.spavik.co/api-reference/models/get-v1-models-id-versions.md): GET /v1/models/{id}/versions
- [Submit outcomes](https://docs.spavik.co/api-reference/models/post-v1-models-id-outcomes.md): POST /v1/models/{id}/outcomes
- [Get model performance](https://docs.spavik.co/api-reference/models/get-v1-models-id-performance.md): GET /v1/models/{id}/performance
- [Refresh a model](https://docs.spavik.co/api-reference/models/post-v1-models-id-refresh.md): POST /v1/models/{id}/refresh
- [Archive a model](https://docs.spavik.co/api-reference/models/post-v1-models-id-archive.md): POST /v1/models/{id}/archive
- [Restore a model](https://docs.spavik.co/api-reference/models/post-v1-models-id-restore.md): POST /v1/models/{id}/restore
- [Delete a model](https://docs.spavik.co/api-reference/models/delete-v1-models-id.md): DELETE /v1/models/{id}
- [Engine families and configured default](https://docs.spavik.co/api-reference/models/get-v1-engine-families.md): GET /v1/engine-families

### Prediction

- [Make predictions](https://docs.spavik.co/api-reference/prediction/post-v1-models-id-predict.md): POST /v1/models/{id}/predict
- [Backtest a forecast](https://docs.spavik.co/api-reference/prediction/post-v1-forecast-backtest.md): POST /v1/forecast/backtest
- [Forecast time series](https://docs.spavik.co/api-reference/prediction/post-v1-forecast.md): POST /v1/forecast

### Usage and plans

- [Get account usage](https://docs.spavik.co/api-reference/usage-and-billing/get-v1-usage.md): GET /v1/usage
- [List API requests](https://docs.spavik.co/api-reference/usage-and-billing/get-v1-requests.md): GET /v1/requests
- [List plans](https://docs.spavik.co/api-reference/usage-and-billing/get-v1-plans.md): GET /v1/plans

### Errors

- [Error codes](https://docs.spavik.co/reference/errors.md): Machine-readable API errors and retry guidance from the OpenAPI contract.

### Event payloads

- [Webhook event](https://docs.spavik.co/api-reference/events/event.md): Structure of the events delivered to your webhook endpoint.