API Reference

Detectors

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create a new detector

detectors.create(DetectorCreateParams**kwargs) -> DetectorCreateResponse

POST/api/detectors

Create a new detector

ParametersExpand Collapse

name: str

ReturnsExpand Collapse

class DetectorCreateResponse: …

errors: List[Error]

code: int

minimum1000

message: str

messages: List[Message]

code: int

minimum1000

message: str

result: Result

id: str

success: bool

Create a new detector

Python

HTTP

Python

import os
from rake import Rake

client = Rake(
    api_key=os.environ.get("RAKE_API_KEY"),  # This is the default and can be omitted
)
detector = client.detectors.create(
    name="name",
)
print(detector.errors)

200 example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "id": "id"
  },
  "success": true
}

Returns Examples

200 example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": {
    "id": "id"
  },
  "success": true
}