Getting started
What the Cosmos Agent API is, who it is for and how to start your first run.
- Can I start runs from my phone?Not with an app, but any tool that can send HTTPS requests with headers works, such as the docs' Try it button in a mobile browser.FAQ
- Can I try the Agent API without writing any code?Use the Try it button on the API reference pages, or the Agent tab in the Console Playground, to send real requests from your browser.How-to
- Can I use the Agent API from no-code tools like automation platforms?Yes, if the tool can send HTTP requests with custom headers. Start a run, then poll the run until it's finished.FAQ
- Can I use the Agent API on the Free plan?Yes. The Agent API is available on every plan, Free included. Runs are paid from credits, and new accounts get $5 of free credit.FAQ
- Does Cosmos run anything on my own computer?No. Agent API runs execute on Clatter Labs infrastructure, on your account's cloud computer, never on your machine.FAQ
- How do I check my key, limits and balance in one call?Call GET /agent-config with your key and Account ID to see the API version, the agent's limits, your key's permissions and your balance.How-to
- How do I start my first Agent API run?Create a key, copy your Account ID and send your first run to the Cosmos Agent API in about five minutes.How-to
- How is the Agent API versioned, and how will I know about changes?The Agent API version is a date returned by /agent-config. Breaking changes get a new version and a changelog entry.FAQ
- I'm learning to code. Is the Agent API a good way to learn?How students and new coders can use the Agent API safely and cheaply to learn, plus simpler alternatives.FAQ
- I've never used an API. What is it?An API is a way for one program to ask another for something over the internet. Here's how that applies to the Cosmos Agent API.FAQ
- Is the Agent API in beta or generally available?The Cosmos Agent API is generally available on every plan, Free included, and paid from credits.FAQ
- Is there an official SDK for the Agent API?The Agent API is plain HTTPS and JSON, so any HTTP client works. The docs show cURL, Python and JavaScript examples.FAQ
- What are server-sent events (SSE)?SSE is a simple web standard for a server to send a stream of updates over one open connection. The Agent API uses it for run events.FAQ
- What can Cosmos actually do during a run?The tools Cosmos uses in an Agent API run: terminal, files, browser, web search, Cloud Repos, hosting, storage, sub-agents and more.FAQ
- What do I need before I can call the Agent API?A Clatter Labs account, its Account ID, an API key with the right permissions, and credits. Here's how to get each.FAQ
- What do the Agent API terms mean?A short glossary: run, step, tier, output, files, cloud computer, sub-agent, credits, scope, Account ID and event stream.Reference
- What do the run statuses queued, running, completed, failed and cancelled mean?The five statuses a Cosmos Agent run can have, how a run moves between them and which ones are final.Reference
- What is a run?A run is one task you give Cosmos through the Agent API, from your instructions to its final answer and files.Explainer
- What is the base URL of the Agent API?The Agent API lives at https://api.agent.clatterlabs.xyz. All requests use HTTPS and JSON, except the event stream.Reference
- What is the Cosmos Agent API?The Cosmos Agent API lets your apps hand coding tasks to Cosmos, an AI agent that works on its own cloud computer and reports back.Explainer
- What's the difference between the Agent API and the Model API?The Model API returns model replies to your prompts; the Agent API runs a full agent with tools on a cloud computer until a task is done.FAQ
- Where can I see the runs I've started?List runs with GET /v1/runs, open one with GET /v1/runs/{id}, or see recent API runs under Logs in the Console.FAQ
- Which AI model does Cosmos use?Cosmos Agent thinks with SuperCosmos by Clatter Labs, version 1.1, in three tiers: Flash, Max and Heavy.FAQ
- Which programming languages and tools can Cosmos work with?Cosmos works in a Linux terminal where it can install packages, so it can use common languages and toolchains you ask for.FAQ
- Who is the Cosmos Agent API for?Developers, teams and companies that want an AI coding agent inside their own tools, scripts, CI jobs or products.FAQ
- Why does creating a run return so quickly if the work takes longer?POST /v1/runs answers 201 right away and the work happens in the background. Follow it with events or polling.FAQ
Still need help?
Tried the steps above and still stuck? Email us. We usually reply within the first hour, and always within 24 hours. A full support team is with you.
Infrastructure questions, or permanent deletion of your data
infrastructure@clatterlabs.xyzFor deleting your whole account or the data of one service.