# Overview

Salfio's public API at api.salfio.com/v1 — base URL, versioning, and what you can do with it.

Salfio exposes a public REST-style API at **`https://api.salfio.com/v1`** for partners, internal services, and the Salfio MCP server. It is the same surface every programmatic integration with Salfio uses.

## Base URL

    https://api.salfio.com/v1

All endpoints are served over HTTPS with a valid certificate. HTTP is refused.

## Versioning

The version is part of the path. `/v1` is the current and only production version. Breaking changes land on `/v2`. Additive changes (new endpoints, new optional fields) happen within `/v1` without warning — treat responses with the `additionalProperties` convention in mind: ignore fields you don't recognize.

## Support

- API downtime or degraded performance: see the status page.

## Related pages

- [Administrator Tools](./administrator-tools.md)
- [Agent Tools](./mcp-external-servers.md)
- [Assign a Slack channel to a client over the API](./guides-assign-slack-channel.md)
- [Authenticated health check](./api-reference-gethealth.md)
- [Authentication](./api-authentication.md)
- [Cards](./cards.md)
- [Changelog](./changelog.md)
- [Changelog](../changelog.md)
- [Connect a workspace](./getting-started-connect-workspace.md)
- [Connect an integration](./getting-started-connect-integration.md)

# Agent Instructions

This portal answers questions programmatically. To receive a synthesized,
source-cited answer instead of crawling page by page, append the `?ask=`
query parameter to any page URL on this site:

    /guides/quickstart?ask=how+do+I+authenticate

Optional parameters:

- `&goal=<what-you-are-trying-to-do>` steers the answer toward your
  objective (e.g. `&goal=write+a+python+client`).
- `&version=<label>` scopes the answer to a mounted version when the
  portal publishes more than one.

The response is `text/markdown`: the answer followed by a `# Sources` list
of the portal pages it was grounded in. Status codes are the contract:

- `200` — the answer; `402` — the portal owner’s plan or answer credits are
  exhausted (surface this to your operator; do NOT retry); `429` — you are
  rate-limited; back off for the `Retry-After` seconds; `503` — the answer
  lane is temporarily unavailable; fall back to crawling the `.md` pages.

For the full corpus map read `llms.txt` at the site root; for the tool
surface (search + page fetch as MCP tools) see `/mcp`.