> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ceramic.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with Ceramic Search in whatever way you choose, such as via the playground, API, or one of the many integrations.

## Get your API key

Generate your API key on the [Platform](https://platform.ceramic.ai/keys).

> [card] Free tier
>
> 1,000 free credits when you sign up.

## 1. Try It in the Playground

> [card] [Open the Playground](https://platform.ceramic.ai/playground/search)
>
> No setup required. Send queries to Ceramic Search directly in your browser.

## 2. Call the API Directly

Make a request directly from your terminal.

```bash theme={null}
curl https://api.ceramic.ai/search \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "California rental laws"}'
```

## 3. Use the SDK

Install the SDK for your language.

```bash python theme={null}
pip install ceramic_ai
```

```bash typescript theme={null}
npm install ceramic-ai
```

Make your first request.

```python python theme={null}
from ceramic_ai import Ceramic

client = Ceramic(api_key="YOUR_API_KEY")

response = client.search(query="California rental laws")

print(response)
```

```typescript typescript theme={null}
import { Ceramic } from "ceramic-ai";

const client = new Ceramic({ apiKey: "YOUR_API_KEY" });

const response = await client.search({ query: "California rental laws"});

console.log(response);
```

### Response

```json theme={null}
{
  "requestId": "ae2ebd93-194f-4460-9996-15e3f86b05d8",
  "result": {
    "results": [
      {
        "title": "California Tenant Rights Guide",
        "url": "https://example.com/tenant-rights",
        "description": "Comprehensive guide to California rental laws..."
      }
    ],
    "searchMetadata": {
      "executionTime": 0.097
    },
    "totalResults": 10
  }
}
```

## 4. Use the Agent Skill

Give your coding agent Ceramic web search with the `ceramic-search` skill. Pick one install method per agent.

> [tab] Claude Code
>
> Run these two commands in your terminal, then start a new Claude Code session and sign in when prompted:
>
> ```bash theme={null}
> claude plugin marketplace add CeramicTeam/agent-skills
> claude plugin install ceramic-search@ceramic-ai
> ```

> [tab] Codex
>
> Run this command in your terminal:
>
> ```bash theme={null}
> codex plugin marketplace add CeramicTeam/agent-skills
> ```
>
> Then, in a Codex session, run `/plugins`, find `ceramic-search` under **Ceramic AI Plugins**, and install it. Codex opens a browser window to sign in.

> [tab] Other agents
>
> Set your API key, then install the skill from your terminal:
>
> ```bash theme={null}
> export CERAMIC_API_KEY=YOUR_API_KEY
> npx skills add CeramicTeam/agent-skills
> ```
>
> Choose your agent when prompted, then start a new agent session.

See [Agent Skill](https://docs.ceramic.ai/api/search/agent-skill.md) for more details.

## 5. Connect to the MCP Server

> [card] [Search MCP](https://docs.ceramic.ai/mcp/ceramic-mcp.md)
>
> Connect Ceramic Search to your AI coding assistants and agents.

## Integrations

Use Ceramic Search alongside the tools you already use.

> [accordion] View all integrations
>
> * [Anthropic Tool Use](https://docs.ceramic.ai/integrations/anthropic.md)
> * [CrewAI](https://docs.ceramic.ai/integrations/crewai.md)
> * [LangChain](https://docs.ceramic.ai/integrations/langchain.md)
> * [LlamaIndex](https://docs.ceramic.ai/integrations/llamaindex.md)
> * [OpenAI Tool Use](https://docs.ceramic.ai/integrations/openai.md)
> * [OpenClaw](https://docs.ceramic.ai/integrations/openclaw.md)
> * [Vercel AI SDK](https://docs.ceramic.ai/integrations/vercel.md)

## Next steps

> [card] [API Reference](https://docs.ceramic.ai/api-reference/search.md)
>
> Explore all available parameters

> [card] [Best Practices](https://docs.ceramic.ai/api/search/best-practices.md)
>
> Get the most out of Ceramic Search


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.