API docs by Redocly

Ruley API (1.0.0)

Download OpenAPI specification:

E-mail: [email protected]

AWS serverless API for Ruley - AI-powered E-Referee service.

This API provides chat endpoints for querying rule knowledge bases across multiple sports. Each sport endpoint connects to a specialized RAG (Retrieval Augmented Generation) service that provides contextually relevant answers based on official rules and regulations.

Pickleball

Chat with Pickleball rules expert

Query the Pickleball rules knowledge base using natural language

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
message
required
string

The user's question or message

Array of objects (ChatMessage)
Default: []

Previous messages in the conversation for context

Responses

Request samples

Content type
application/json
Example
{
  • "message": "What is a kitchen violation?",
  • "previousMessages": [ ]
}

Response samples

Content type
application/json
{
  • "answer": "A dink shot is a soft, controlled shot hit just over the net...",
  • "relevantDocuments": [
    ],
  • "sport": "pickleball",
  • "timestamp": "2025-01-20T12:00:00.000Z",
  • "requestId": "123e4567-e89b-12d3-a456-426614174000"
}

Padel

Chat with Padel rules expert

Query the Padel rules knowledge base using natural language

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
message
required
string

The user's question or message

Array of objects (ChatMessage)
Default: []

Previous messages in the conversation for context

Responses

Request samples

Content type
application/json
{
  • "message": "What is the scoring system in padel?",
  • "previousMessages": [ ]
}

Response samples

Content type
application/json
{
  • "answer": "A dink shot is a soft, controlled shot hit just over the net...",
  • "relevantDocuments": [
    ],
  • "sport": "pickleball",
  • "timestamp": "2025-01-20T12:00:00.000Z",
  • "requestId": "123e4567-e89b-12d3-a456-426614174000"
}

Tennis

Chat with Tennis rules expert

Query the Tennis rules knowledge base. Supports singles and doubles formats.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
message
required
string

The user's question or message

Array of objects (ChatMessage)
Default: []

Previous messages in the conversation for context

numberOfPlayers
string
Enum: "singles" "doubles"

Game format for context-specific rules

Responses

Request samples

Content type
application/json
Example
{
  • "message": "What is a foot fault in tennis?",
  • "numberOfPlayers": "singles",
  • "previousMessages": [ ]
}

Response samples

Content type
application/json
{
  • "answer": "A dink shot is a soft, controlled shot hit just over the net...",
  • "relevantDocuments": [
    ],
  • "sport": "pickleball",
  • "timestamp": "2025-01-20T12:00:00.000Z",
  • "requestId": "123e4567-e89b-12d3-a456-426614174000"
}

Intennse

Chat with Intennse rules expert

Query the Intennse rules knowledge base. Supports singles and doubles formats.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
message
required
string

The user's question or message

Array of objects (ChatMessage)
Default: []

Previous messages in the conversation for context

numberOfPlayers
string
Enum: "singles" "doubles"

Game format for context-specific rules

Responses

Request samples

Content type
application/json
{
  • "message": "What are the basic rules?",
  • "numberOfPlayers": "singles",
  • "previousMessages": [ ]
}

Response samples

Content type
application/json
{
  • "answer": "A dink shot is a soft, controlled shot hit just over the net...",
  • "relevantDocuments": [
    ],
  • "sport": "pickleball",
  • "timestamp": "2025-01-20T12:00:00.000Z",
  • "requestId": "123e4567-e89b-12d3-a456-426614174000"
}

Golf

Chat with Golf rules expert

Query the Golf rules knowledge base. Supports multiple rulesets (USGA, RANDA, FlingGolf).

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
message
required
string

The user's question or message

Array of objects (ChatMessage)
Default: []

Previous messages in the conversation for context

ruleset
required
string
Enum: "USGA" "RANDA" "FlingGolf"

Golf ruleset to use for the query

Responses

Request samples

Content type
application/json
Example
{
  • "message": "What is the penalty for hitting the wrong ball?",
  • "ruleset": "USGA",
  • "previousMessages": [ ]
}

Response samples

Content type
application/json
{
  • "answer": "A dink shot is a soft, controlled shot hit just over the net...",
  • "relevantDocuments": [
    ],
  • "sport": "pickleball",
  • "timestamp": "2025-01-20T12:00:00.000Z",
  • "requestId": "123e4567-e89b-12d3-a456-426614174000"
}

Kickball

Chat with Kickball rules expert

Query the Kickball rules knowledge base using natural language. This endpoint runs the RAG pipeline in-process (no Firebase hop). Backed by the kickball-v0-1-0 Pinecone index.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
message
required
string

The user's question or message

Array of objects (ChatMessage)
Default: []

Previous messages in the conversation for context

Responses

Request samples

Content type
application/json
Example
{
  • "message": "How many bases are there?",
  • "previousMessages": [ ]
}

Response samples

Content type
application/json
{
  • "answer": "A dink shot is a soft, controlled shot hit just over the net...",
  • "relevantDocuments": [
    ],
  • "sport": "pickleball",
  • "timestamp": "2025-01-20T12:00:00.000Z",
  • "requestId": "123e4567-e89b-12d3-a456-426614174000"
}