{% extends "docs/base_docs.html" %} {% block docs_content %}

API: {{ group.title }}

Every HTML route returns JSON with Accept: application/json. Authentication: session cookie, X-API-KEY, Authorization: Bearer or Basic.

{% for item in endpoints %}

{{ item.method }}{{ item.path }}{{ item.min_role }}

{{ item.title }} {% if item.description %}

{% endif %} {% if item.fields %} {% for f in item.fields %}{% endfor %}

Field	Type	Location	Required
`{{ f.name }}`{% if f.enum %} Allowed: {{ f.enum \| join(', ') }} {% endif %}	{{ f.type }}	{{ f.location }}	{{ 'yes' if f.required else 'no' }}

{% endif %}

{% if item.interactive %}{% endif %}

{{ item.curl }}

const response = await fetch("{{ item.path }}", { method: "{{ item.method }}", headers: { "Accept": "application/json" } });
console.log(await response.json());

import httpx
print(httpx.request("{{ item.method }}", BASE + "{{ item.path }}", headers={"Accept": "application/json", "X-API-KEY": API_KEY}).json())

{{ item.sample | tojson(indent=2) if item.sample is not none else 'No example' }}

{% if item.interactive %}

{% for f in item.fields %}

{{ f.name }} ({{ f.location }}) {% if f.enum %} {% else %}{% endif %}

{% endfor %}

Not sent yet.

{% endif %}

{% endfor %} {% if services %}

Live services

{% for service in services %}

{{ service.title }} {{ service.name }}

Fields: {% for f in service.fields %}{{ f.key }} ({{ f.type }}){% if not loop.last %}, {% endif %}{% endfor %}

{% endfor %} {% endif %} {% endblock %} {% block extra_js %}{% endblock %}