Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add .well-known/serviceinfo endpoint #5489

Open
db0 opened this issue Nov 4, 2024 · 0 comments
Open

Add .well-known/serviceinfo endpoint #5489

db0 opened this issue Nov 4, 2024 · 0 comments
Labels
Feature A new feature to add to ComfyUI.

Comments

@db0
Copy link

db0 commented Nov 4, 2024

Feature Idea

The developers of the AI Horde, koboldcpp and aphrodite just agreed for a standard which would allow inference integrators to our APIs to quickly retrieve the information about the API they are working with.

We arranged that the information should live in a .well-known URI and we chose serviceinfo as the endpoint to signify it's use in a service api.

We came up with the following standard (you can see a live example here)

{
  "api": {
    "aihorde": {
      "rel_url": "/api/v2",
      "documentation": "https://aihorde.net/api",
      "name": "AI Horde API",
      "version": "2.5"
    }
  },
  "software": {
    "homepage": "https://aihorde.net",
    "logo": "https://aihorde.net/assets/img/logo.png",
    "name": "AI Horde",
    "repository": "https://github.com/Haidra-Org/AI-Horde",
    "version": "4.44.0"
  },
  "version": "0.2"
}

The fields should be self-explanatory, but basically api holds info about each api is served (for example aphrodite serves both Open AI and KoboldAI APIs) whereas the software holds information about the software itself. The version on the root is the version of the .well-known/serviceinfo itself.

We think it would benefit everyone if ComfyUI onboard the same endpoint and we would welcome improvement and extensions on the serviceinfo standard we came up with.

Relevant PRs

Aphrodite: PygmalionAI/aphrodite-engine#807
AI Horde: Haidra-Org/AI-Horde#466

Existing Solutions

Most inference APIs do not provide this information consistently. This is an attempt to standardize this for all of us.

Other

No response

@db0 db0 added the Feature A new feature to add to ComfyUI. label Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature A new feature to add to ComfyUI.
Projects
None yet
Development

No branches or pull requests

1 participant