Tandoor Recipes Keyword API

The Keyword API from Tandoor Recipes — 7 operation(s) for keyword.

GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/keyword/ List keyword categories · Api keyword list #
Ask an LLM
“What keyword categories are available in the taxonomy?”
“Can I search the keyword tree for a term?”
Tell an agent
List all keyword categories.
Find keyword categories matching {query}.
POST /api/keyword/ Create a keyword category · Api keyword create #
Ask an LLM
“How do I add a new keyword category under a parent?”
“Can I set the number of child categories when creating one?”
Tell an agent
Create keyword {name} with label {label} under parent {parent}, child count {numchild}, created {created_at}, updated {updated_at}.
Add keyword {name} ({label}) under {parent} with {numchild} children.
GET /api/keyword/{id}/ Get a keyword category · Api keyword retrieve #
Ask an LLM
“What label and parent does a keyword category have?”
“Can I look up one keyword category by ID?”
Tell an agent
Show keyword category {id}.
Get the label and parent of keyword {id}.
PUT /api/keyword/{id}/ Replace a keyword category · Api keyword update #
Ask an LLM
“How do I overwrite a keyword category's label and parent?”
“Does a full update of a keyword category need every field?”
Tell an agent
Replace keyword {id} with name {name}, label {label}, parent {parent}, child count {numchild}, created {created_at}, updated {updated_at}.
Overwrite keyword category {id} with full details {name}, {label}, {parent}, {numchild}, {created_at}, {updated_at}.
PATCH /api/keyword/{id}/ Update a keyword category's fields · Api keyword partial update #
Ask an LLM
“Can I change just a keyword category's label or description?”
“How do I rename a keyword category without resending everything?”
Tell an agent
Set the label of keyword {id} to {label}.
Rename keyword {id} to {name}.
DELETE /api/keyword/{id}/ Delete a keyword category · Api keyword destroy #
Ask an LLM
“How do I delete a keyword category?”
“Can I remove a keyword category by ID?”
Tell an agent destructive · confirm first
Delete keyword category {id}.
Remove keyword {id} from the taxonomy.
GET /api/keyword/{id}/cascading/ List items deleted when a keyword is removed · Api keyword cascading list #
Ask an LLM
“What will be deleted if I remove a keyword category?”
“Can I preview the cascade of a keyword deletion?”
Tell an agent
List items that cascade when keyword {id} is deleted.
Show the cascade of keyword {id} with cache {cache}.
PUT /api/keyword/{id}/merge/{target}/ Merge a keyword into another · Api keyword merge update #
Ask an LLM
“How do I merge a keyword into a target keyword?”
“Can I combine two keyword categories into one?”
Tell an agent
Merge keyword {id} into {target}.
Combine keyword {id} into target {target} with name {name}, label {label}, parent {parent}, child count {numchild}, created {created_at}, updated {updated_at}.
PUT /api/keyword/{id}/move/{parent}/ Move a keyword under a new parent · Api keyword move update #
Ask an LLM
“How do I move a keyword category under a different parent?”
“Can I re-parent a keyword category?”
Tell an agent
Move keyword {id} under parent {parent}.
Re-parent keyword {id} to {parent} with name {name}, label {label}, child count {numchild}, created {created_at}, updated {updated_at}.
GET /api/keyword/{id}/nulling/ List items that lose a keyword when it's removed · Api keyword nulling list #
Ask an LLM
“Which items would lose their keyword reference if I delete one?”
“Can I see what depends on a keyword category?”
Tell an agent
List items that nullify when keyword {id} is deleted.
Show nulling references of keyword {id} with cache {cache}.
GET /api/keyword/{id}/protecting/ List items protecting a keyword from deletion · Api keyword protecting list #
Ask an LLM
“What protects a keyword category from being deleted?”
“Can I see which items guard a keyword?”
Tell an agent
List items protecting keyword {id}.
Show protecting references of keyword {id} with cache {cache}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/tandoor:tandoor-keyword-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

tandoor-keyword-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Tandoor Keyword API
  version: 0.0.0 (2.6.13)
  x-logo:
    url: /static/assets/brand_logo.svg
    backgroundColor: '#FFFFFF'
    altText: Tandoor logo
    href: /
  description: Tandoor API Docs
tags:
- name: Keyword
paths:
  /api/keyword/:
    get:
      operationId: apiKeywordList
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: query
        name: limit
        schema:
          type: string
        description: limit number of entries to return
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: query
        schema:
          type: string
        description: lookup if query string is contained within the name, case insensitive
      - in: query
        name: random
        schema:
          type: string
        description: randomly orders entries (only works together with limit)
      - in: query
        name: root
        schema:
          type: integer
        description: Return first level children of {obj} with ID [int].  Integer 0 will return root {obj}s.
      - in: query
        name: root_tree
        schema:
          type: integer
        description: Return all items belonging to the tree of the given {obj} id
      - in: query
        name: tree
        schema:
          type: integer
        description: Return all self and children of {obj} with ID [int].
      - in: query
        name: updated_at
        schema:
          type: string
        description: if model has an updated_at timestamp, filter only models updated at or after datetime
      tags:
      - Keyword
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedKeywordList'
          description: ''
      summary: Api keyword list
      x-summary-source: derived
    post:
      operationId: apiKeywordCreate
      description: logs request counts to redis cache total/per user/
      tags:
      - Keyword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Keyword'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Keyword'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Keyword'
        required: true
      security:
      - ApiKeyAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Keyword'
          description: ''
      summary: Api keyword create
      x-summary-source: derived
  /api/keyword/{id}/:
    get:
      operationId: apiKeywordRetrieve
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this keyword.
        required: true
      tags:
      - Keyword
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Keyword'
          description: ''
      summary: Api keyword retrieve
      x-summary-source: derived
    put:
      operationId: apiKeywordUpdate
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this keyword.
        required: true
      tags:
      - Keyword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Keyword'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Keyword'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Keyword'
        required: true
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Keyword'
          description: ''
      summary: Api keyword update
      x-summary-source: derived
    patch:
      operationId: apiKeywordPartialUpdate
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this keyword.
        required: true
      tags:
      - Keyword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedKeyword'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedKeyword'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedKeyword'
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Keyword'
          description: ''
      summary: Api keyword partial update
      x-summary-source: derived
    delete:
      operationId: apiKeywordDestroy
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this keyword.
        required: true
      tags:
      - Keyword
      security:
      - ApiKeyAuth: []
      responses:
        '204':
          description: No response body
      summary: Api keyword destroy
      x-summary-source: derived
  /api/keyword/{id}/cascading/:
    get:
      operationId: apiKeywordCascadingList
      description: get a paginated list of objects that will be cascaded (deleted) when deleting the selected object
      parameters:
      - in: query
        name: cache
        schema:
          type: boolean
          default: true
        description: If results can be cached or not
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this keyword.
        required: true
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Keyword
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGenericModelReferenceList'
          description: ''
      summary: Api keyword cascading list
      x-summary-source: derived
  /api/keyword/{id}/merge/{target}/:
    put:
      operationId: apiKeywordMergeUpdate
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this keyword.
        required: true
      - in: path
        name: target
        schema:
          type: integer
        description: The ID of the {obj} you want to merge with.
        required: true
      tags:
      - Keyword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Keyword'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Keyword'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Keyword'
        required: true
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Keyword'
          description: ''
      summary: Api keyword merge update
      x-summary-source: derived
  /api/keyword/{id}/move/{parent}/:
    put:
      operationId: apiKeywordMoveUpdate
      description: logs request counts to redis cache total/per user/
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this keyword.
        required: true
      - in: path
        name: parent
        schema:
          type: integer
        description: The ID of the desired parent of the {obj}.
        required: true
      tags:
      - Keyword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Keyword'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Keyword'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Keyword'
        required: true
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Keyword'
          description: ''
      summary: Api keyword move update
      x-summary-source: derived
  /api/keyword/{id}/nulling/:
    get:
      operationId: apiKeywordNullingList
      description: get a paginated list of objects where the selected object will be removed whe its deleted
      parameters:
      - in: query
        name: cache
        schema:
          type: boolean
          default: true
        description: If results can be cached or not
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this keyword.
        required: true
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Keyword
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGenericModelReferenceList'
          description: ''
      summary: Api keyword nulling list
      x-summary-source: derived
  /api/keyword/{id}/protecting/:
    get:
      operationId: apiKeywordProtectingList
      description: get a paginated list of objects that are protecting the selected object form being deleted
      parameters:
      - in: query
        name: cache
        schema:
          type: boolean
          default: true
        description: If results can be cached or not
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this keyword.
        required: true
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Keyword
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGenericModelReferenceList'
          description: ''
      summary: Api keyword protecting list
      x-summary-source: derived
components:
  schemas:
    PaginatedGenericModelReferenceList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/GenericModelReference'
        timestamp:
          type: string
          format: date-time
    Keyword:
      type: object
      description: "Moves `UniqueValidator`'s from the validation stage to the save stage.\nIt solves the problem with nested validation for unique fields on update.\n\nIf you want more details, you can read related issues and articles:\nhttps://github.com/beda-software/drf-writable-nested/issues/1\nhttp://www.django-rest-framework.org/api-guide/validators/#updating-nested-serializers\n\nExample of usage:\n```\n    class Child(models.Model):\n    field = models.CharField(unique=True)\n\n\nclass Parent(models.Model):\n    child = models.ForeignKey('Child')\n\n\nclass ChildSerializer(UniqueFieldsMixin, serializers.ModelSerializer):\n    class Meta:\n        model = Child\n\n\nclass ParentSerializer(NestedUpdateMixin, serializers.ModelSerializer):\n    child = ChildSerializer()\n\n    class Meta:\n        model = Parent\n```\n\nNote: `UniqueFieldsMixin` must be applied only on the serializer\nwhich has unique fields.\n\nNote: When you are using both mixins\n(`UniqueFieldsMixin` and `NestedCreateMixin` or `NestedUpdateMixin`)\nyou should put `UniqueFieldsMixin` ahead."
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 64
        label:
          type: string
          readOnly: true
        description:
          type: string
        parent:
          type: integer
          readOnly: true
        numchild:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        full_name:
          type: string
          description: 'Returns a string representation of a tree node and it''s ancestors,

            e.g. ''Cuisine > Asian > Chinese > Catonese''.'
          readOnly: true
      required:
      - created_at
      - full_name
      - label
      - name
      - numchild
      - parent
      - updated_at
    PatchedKeyword:
      type: object
      description: "Moves `UniqueValidator`'s from the validation stage to the save stage.\nIt solves the problem with nested validation for unique fields on update.\n\nIf you want more details, you can read related issues and articles:\nhttps://github.com/beda-software/drf-writable-nested/issues/1\nhttp://www.django-rest-framework.org/api-guide/validators/#updating-nested-serializers\n\nExample of usage:\n```\n    class Child(models.Model):\n    field = models.CharField(unique=True)\n\n\nclass Parent(models.Model):\n    child = models.ForeignKey('Child')\n\n\nclass ChildSerializer(UniqueFieldsMixin, serializers.ModelSerializer):\n    class Meta:\n        model = Child\n\n\nclass ParentSerializer(NestedUpdateMixin, serializers.ModelSerializer):\n    child = ChildSerializer()\n\n    class Meta:\n        model = Parent\n```\n\nNote: `UniqueFieldsMixin` must be applied only on the serializer\nwhich has unique fields.\n\nNote: When you are using both mixins\n(`UniqueFieldsMixin` and `NestedCreateMixin` or `NestedUpdateMixin`)\nyou should put `UniqueFieldsMixin` ahead."
      properties:
        id:
          type: integer
          readOnly: false
        name:
          type: string
          maxLength: 64
        label:
          type: string
          readOnly: true
        description:
          type: string
        parent:
          type: integer
          readOnly: true
        numchild:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        full_name:
          type: string
          description: 'Returns a string representation of a tree node and it''s ancestors,

            e.g. ''Cuisine > Asian > Chinese > Catonese''.'
          readOnly: true
    PaginatedKeywordList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Keyword'
        timestamp:
          type: string
          format: date-time
    GenericModelReference:
      type: object
      properties:
        id:
          type: integer
          readOnly: false
        model:
          type: string
        name:
          type: string
      required:
      - model
      - name
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization