Skip to content

API overview

Call the Radioso API to create workspaces, upload documents, and talk to a configured agent over HTTP. Workspace automation and agent chat have different credentials because one carries a workspace role while the other is confined to one agent.

Get an agent credential and ask a question

Sign in to the dashboard, open the agent’s Channels → API card, and create a REST credential with a label and expiry. Save the one-time secret, then:

bash
curl -sS -X POST https://api.radioso.ai/api/v1/agents/<agent-id>/chat \
  -H "Authorization: Bearer $RADIOSO_AGENT_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"message":"What can this workspace answer?","stream":false}'

Swap in https://api-us.radioso.ai for the US-hosted instance, or your own origin when self-hosting. The credential works only for the agent in the URL and only against the instance that issued it. If the workspace has no documents yet, the agent still answers, just without grounding; Documents and search covers giving it something to answer from.

Find your workflow

Four credentials, four jobs

Which credential you send determines which routes will accept the request:

  • Session cookie — set by login, invitation acceptance, or password reset. Manages accounts, users, invitations, and workspaces.
  • Personal token or service-account credential — sent as Authorization: Bearer <token>. Runs the routes explicitly available to its live member or admin role.
  • Agent credential — bound to exactly one agent and either the rest or mcp audience. It carries no workspace role. A REST credential calls /api/v1/agents/{agentId}/chat; an MCP credential reaches ask_agent through the standalone MCP server.
  • Public token — a per-surface token embedded in a public chat link or website widget, not tied to your account. Handles anonymous chat and the Enterprise embed flow.

Exact schemas, status codes, and payload contracts live in the API Reference, generated from the OpenAPI document at backend/openapi.json — the canonical source for both that reference and this scenario-first section.

System endpoint

text
GET /health

Use it for service monitoring and basic deployment checks; it needs no credential.