---
title: "Console REST API."
description: "The Console REST API exposes authenticated tool discovery, quotes, accepted runs and result retrieval at the published Console server."
canonical: "https://altss.com/console/docs/api"
last-updated: "2026-11-17"
---

# Console REST API.

The Console REST API exposes authenticated tool discovery, quotes, accepted runs and result retrieval at the published Console server.

Last modified: 2026-11-17

## Discover the current contract

These public documents need no credential and trigger no paid execution.

```bash
curl --fail-with-body --silent --show-error 'https://console.altss.com/tools.json'
curl --fail-with-body --silent --show-error 'https://altss.com/integrations/console/openapi.json'
```

## Operations

| Method and path | Operation ID | Purpose |
| --- | --- | --- |
| GET /v1/console/tools | listConsoleTools | List the credential’s organization catalog |
| POST /v1/console/quote | quoteConsoleResearch | Quote one tool and exact input; no paid execution |
| POST /v1/console/runs | runConsoleResearch | Execute an accepted quote using one purchase idempotency key |
| GET /v1/console/runs/{runId} | getConsoleRun | Retrieve the organization’s existing run, result and receipt |
Production origin: https://console.altss.com. Use a credential with the approved API channel and company.read scope.

## List authorized tools

Load ALTSS_API_KEY through your local secret-management mechanism. The shell variable stands for an authorized Console key; never publish its value.

```bash
curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer $ALTSS_API_KEY" \
  'https://console.altss.com/v1/console/tools'
```

## Quote request schema example

POST https://console.altss.com/v1/console/quote with Content-Type: application/json. Only use a tool currently marked AVAILABLE.

```json
{
  "toolId": "company.financial_research",
  "input": {
    "cik": "0000789019"
  }
}
```

## Quote response and acceptance

The quote includes quoteId, toolId, priceMinor, maxReserveMinor, currency, expiresAt, plan and useTerms. Amounts are minor currency units. Preserve the whole response unchanged, including fields your client does not interpret. Show the purchaser the price, maximum charge, plan and complete terms before accepting. Use the returned expiresAt value to determine when a quote must be renewed.

## Create-run input

| Field | Requirement |
| --- | --- |
| toolId and input | Match the quoted operation and input exactly |
| quote | The complete unchanged quote returned by the server |
| accept | true, only after the purchaser authorized this exact quote |
| idempotencyKey | One stable key per purchase, in the body or Idempotency-Key header; both must match if supplied together |


## Read the settled response

A successful run response includes runId, receiptId, tool, result, usage and receipt. Evidence, source and freshness context accompany the research result. Retrieve the same run to reopen a settled result without a new purchase. The run record distinguishes OPEN, RESERVED, SETTLED, RELEASED and ABANDONED states; an unpaid or undisclosable result stays private.

## Treat timeouts and refusals explicitly

Read both the HTTP status and error.code when present. A timeout is not proof that no charge occurred. Keep the same purchase idempotency key, inspect the existing run and follow the documented recovery instructions. Stop on permission failures instead of trying a different identity or broader scope.

[Console error reference](https://console.altss.com/connect#errors)

[Full request and response schemas](https://altss.com/integrations/console/openapi.json)

## Build your integration

- [Capability catalog](https://altss.com/console/capabilities)
- [REST API](https://altss.com/console/docs/api)
- [MCP](https://altss.com/console/docs/mcp)
- [A2A and agent discovery](https://altss.com/console/docs/a2a)
- [SDKs and examples](https://altss.com/console/docs/sdks-and-examples)
- [Usage and billing](https://altss.com/console/usage-and-billing)
- [Security and permissions](https://altss.com/console/security-and-permissions)

[Open the full schema](https://altss.com/integrations/console/openapi.json)

[Explore capabilities](https://altss.com/console/capabilities)

## Connect with the contract in view.

Start with the capability, its evidence requirements and the decision your team needs to make. Confirm the available tool and permitted use before execution.

[Read the connection guide](https://console.altss.com/connect)

[Discuss a requirement](https://altss.com/contact)

Canonical URL: https://altss.com/console/docs/api

