Search - Ceramic

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

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

POST

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

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

Authorizations

Authorization

string

header

required

API key authentication. Include your API key as a Bearer token in the Authorization header.

Body

application/json

query

string

required

The search query in keyword format. Must contain between 1 and 50 words (words are separated by spaces; extra whitespace is ignored).

maxDescriptionLength

integer

default:3000

Maximum character length for each result's description.

Required range: 1000 <= x <= 8000

Response

200 - application/json

Successful search response

requestId

string

required

Server-generated request identifier (often a UUID).

result

object

required

Show child attributes

Error Codes

⌘I