API endpoints
Every operation the API exposes, generated from the same OpenAPI document
that powers the interactive reference. The base URL is
https://api.api-stock.com, and every call is authenticated with a bearer
API key — see Authentication.
Account Management
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/stats | Usage and spend statistics for the current user |
GET | /api/v1/user/me | Request to get current user |
Agent
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/agent/artifacts | — |
GET | /api/v1/agent/artifacts/{id} | — |
GET | /api/v1/agent/artifacts/{id}/content | — |
DELETE | /api/v1/agent/attachments/{id} | — |
GET | /api/v1/agent/attachments/{id} | — |
POST | /api/v1/agent/attachments/{id}/complete | — |
GET | /api/v1/agent/attachments/{id}/content | — |
GET | /api/v1/agent/conversations | — |
POST | /api/v1/agent/conversations | — |
GET | /api/v1/agent/conversations/{id} | — |
PATCH | /api/v1/agent/conversations/{id} | — |
DELETE | /api/v1/agent/conversations/{id} | — |
POST | /api/v1/agent/conversations/{id}/attachments | — |
GET | /api/v1/agent/conversations/{id}/context-references | — |
PUT | /api/v1/agent/conversations/{id}/context-references | — |
GET | /api/v1/agent/conversations/{id}/event-history | — |
GET | /api/v1/agent/conversations/{id}/events | — |
GET | /api/v1/agent/conversations/{id}/messages | — |
POST | /api/v1/agent/conversations/{id}/messages | Start a billed run within an explicit micro-USD budget |
POST | /api/v1/agent/conversations/{id}/read | — |
GET | /api/v1/agent/models | — |
GET | /api/v1/agent/profiles | — |
GET | /api/v1/agent/projects | — |
POST | /api/v1/agent/projects | — |
GET | /api/v1/agent/projects/{id} | — |
PATCH | /api/v1/agent/projects/{id} | — |
DELETE | /api/v1/agent/projects/{id} | — |
POST | /api/v1/agent/projects/{id}/assets | — |
POST | /api/v1/agent/projects/{id}/assets/import | — |
GET | /api/v1/agent/runs/{id} | — |
PATCH | /api/v1/agent/runs/{id}/budget | — |
GET | /api/v1/agent/runs/{id}/context/{referenceId} | — |
GET | /api/v1/agent/runs/{id}/costs | — |
POST | /api/v1/agent/runs/{id}/decisions | — |
GET | /api/v1/agent/runs/{id}/result | — |
POST | /api/v1/agent/runs/{id}/resume | — |
POST | /api/v1/agent/runs/{id}/stop | — |
GET | /api/v1/agent/settings | — |
PUT | /api/v1/agent/settings | — |
GET | /api/v1/agent/storage | — |
POST | /api/v1/agent/storage/cancel-renewal | — |
POST | /api/v1/agent/storage/enable-renewal | — |
GET | /api/v1/agent/storage/files | — |
DELETE | /api/v1/agent/storage/files/{id} | — |
GET | /api/v1/agent/storage/operations/{id} | — |
GET | /api/v1/agent/storage/plans | — |
POST | /api/v1/agent/storage/quote | — |
POST | /api/v1/agent/storage/retain | — |
POST | /api/v1/agent/storage/subscribe | — |
GET | /api/v1/agent/visibility | — |
GET | /api/v1/agent/webhooks | — |
POST | /api/v1/agent/webhooks | — |
DELETE | /api/v1/agent/webhooks/{id} | — |
GET | /api/v1/agent/webhooks/{id}/deliveries | — |
GET | /api/v1/agent/workflows | — |
GET | /api/v1/agent/workflows/{id} | — |
Catalog
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/catalog | Get the public model catalog |
GET | /api/v1/catalog/{id} | Get one catalog entry by model id |
Costs
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/cost | Get all prices by model |
GET | /api/v1/cost/{model} | Get prices for specific model |
Generations
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/generation/{id} | Request to get generation by ID |
POST | /api/v1/generation/create | Create generation request based on model. Returns immediately with a taskId |
POST | /api/v1/generation/estimate | Estimate the exact balance charge for a generation request |
LLM
| Method | Path | What it does |
|---|---|---|
POST | /api/v1/chat/completions | OpenAI-compatible chat completion. Set stream: true for server-sent events. |
POST | /api/v1/messages | Anthropic Messages API-compatible endpoint (Claude models). Set stream: true for server-sent events. |
GET | /api/v1/models | List available chat models with token pricing (USD per 1M tokens) |
Task Management
| Method | Path | What it does |
|---|---|---|
GET | /api/v1/task/status/{taskId} | Get task status |
The full document is served at /openapi.json if you
would rather generate a client from it.