Quotes

The Quotes API allows you to manage quotes in Firebot


GET/quotes

List all quotes

Retrieves a list of all quotes

Request

GET
/quotes
curl http://localhost:7472/api/v1/quotes

Response

[
  {
    "id": 1,
    "text": "This is a sample quote.",
    "originator": "John Doe",
    "creator": "Jane Smith",
    "game": "Game Name",
    "createdAt": "2024-12-14T00:00:00Z"
  },
  {
    "id": 2,
    "text": "Another quote here.",
    "originator": "Alice",
    "creator": "Bob",
    "game": "Another Game",
    "createdAt": "2024-12-13T00:00:00Z"
  }
]

GET/quotes/:quoteId

Retrieve a quote

Fetches a specific quote by its quoteId.

URL Parameters

  • Name
    quoteId
    Type
    string
    Description

    The unique identifier of the quote

Request

GET
/quotes/1
curl http://localhost:7472/api/v1/quotes/1

Response

{
  "id": 1,
  "text": "This is a sample quote.",
  "originator": "John Doe",
  "creator": "Jane Smith",
  "game": "Game Name",
  "createdAt": "2024-12-14T00:00:00Z"
}

POST/quotes

Create a quote

Creates a new quote.

Request Body

  • Name
    text
    Type
    string
    Description

    The text content of the quote

  • Name
    originator
    Type
    string
    Description

    The person who originated the quote

  • Name
    creator
    Type
    string
    Description

    The creator of the quote

  • Name
    game
    Type
    string
    Description

    The game context

Request

POST
/quotes
{
  "text": "This is a new quote.",
  "originator": "Alice",
  "creator": "Bob",
  "game": "Sample Game"
}

Response

{
  "id": 3,
  "text": "This is a new quote.",
  "originator": "Alice",
  "creator": "Bob",
  "game": "Sample Game",
  "createdAt": "2024-12-14T00:00:00Z"
}

PUT/quotes/:quoteId

Update a quote

Creates or updates a specific quote. If a quote with the provided quoteId does not exist, it will be created; otherwise, it will be updated.

Request Parameters

  • Name
    quoteId
    Type
    string
    Description

    The unique identifier of the quote to be updated or created

Request Body

  • Name
    text
    Type
    string
    Description

    The text content of the quote

  • Name
    originator
    Type
    string
    Description

    The person who originated the quote

  • Name
    creator
    Type
    string
    Description

    The creator of the quote

  • Name
    game
    Type
    string
    Description

    The game context

  • Name
    createdAt
    Type
    string
    Description

    The creation date

Request

PUT
/quotes/1
{
  "text": "Updated quote content",
  "originator": "Alice",
  "creator": "Bob",
  "game": "Sample Game",
  "createdAt": "2024-12-14T00:00:00Z"
}

Response

{
  "id": 1,
  "text": "Updated quote content",
  "originator": "Alice",
  "creator": "Bob",
  "game": "Sample Game",
  "createdAt": "2024-12-14T00:00:00Z"
}

PATCH/quotes/:quoteId

Partially update a quote

Partially updates an existing quote. You can update specific fields such as text, originator, creator, game, or createdAt.

Request Parameters

  • Name
    quoteId
    Type
    string
    Description

    The unique identifier of the quote to be updated

Request Body

  • Name
    text
    Type
    string
    Description

    The text content of the quote

  • Name
    originator
    Type
    string
    Description

    The person who originated the quote

  • Name
    creator
    Type
    string
    Description

    The creator of the quote

  • Name
    game
    Type
    string
    Description

    The game context

  • Name
    createdAt
    Type
    string
    Description

    The creation date

Request

PATCH
/quotes/1
{
  "text": "Partially updated quote content",
  "originator": "Alice"
}

Response

{
  "id": 1,
  "text": "Partially updated quote content",
  "originator": "Alice",
  "creator": "Bob",
  "game": "Sample Game",
  "createdAt": "2024-12-14T00:00:00Z"
}

DELETE/quotes/:quoteId

Delete a quote

Deletes a specific quote by its quoteId.

Request Parameters

  • Name
    quoteId
    Type
    string
    Description

    The unique identifier of the quote to be deleted

Request

DELETE
/quotes/1
curl -X DELETE http://localhost:7472/api/v1/quotes/1

Response

HTTP Status 204 No Content